Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1920)

Unified Diff: docs/man1/git-freeze.1

Issue 200903002: Add documentation for git-map-branches, git-map, git-nav-downstream, (Closed) Base URL: https://chromium.googlesource.com/chromium/tools/depot_tools.git@documentation
Patch Set: rebase Created 6 years, 9 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « docs/man1/depot_tools.1 ('k') | docs/man1/git-map.1 » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: docs/man1/git-freeze.1
diff --git a/man1/git-freeze.1 b/docs/man1/git-freeze.1
similarity index 59%
rename from man1/git-freeze.1
rename to docs/man1/git-freeze.1
index 22a33b737e44016fb8476410538440917f13d4fa..03de7cdabed19276c5f4a5c5f31b17f4dc250988 100644
--- a/man1/git-freeze.1
+++ b/docs/man1/git-freeze.1
@@ -2,12 +2,12 @@
.\" Title: git-freeze
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" Date: 03/13/2014
+.\" Date: 03/14/2014
.\" Manual: Chromium depot_tools Manual
-.\" Source: depot_tools f48b2c2
+.\" Source: depot_tools a57ed8f
.\" Language: English
.\"
-.TH "GIT\-FREEZE" "1" "03/13/2014" "depot_tools f48b2c2" "Chromium depot_tools Manual"
+.TH "GIT\-FREEZE" "1" "03/14/2014" "depot_tools a57ed8f" "Chromium depot_tools Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -28,7 +28,7 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
-git-freeze \- Freeze all changes on a branch (indexed and unindexed)
+git-freeze \- Freeze all changes on a branch (indexed and unindexed)\&.
.SH "SYNOPSIS"
.sp
.nf
@@ -40,12 +40,63 @@ git-freeze \- Freeze all changes on a branch (indexed and unindexed)
git freeze works a lot like git stash, in that it stores the current changes in your working copy and index \fIsomewhere\fR\&. Unlike git stash, git freeze stores those changes on your current branch\&. This effectively allows you to \fIpause\fR development of a branch, work on something else, and then come back to exactly the same working state later (by running git thaw)\&.
.sp
git freeze will make up to 2 commits on your branch\&. A commit with the message FREEZE\&.indexed will contain all changes which you\(cqve added to your index (like with \fIgit add\fR, \fIgit mv\fR, \fIgit rm\fR, etc\&.)\&. A commit with the message FREEZE\&.unindexed will contain all changes which were not in your index at the time you ran git freeze (freshly modified files, new files, etc\&.)\&.
+.SH "EXAMPLE"
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+\fB$ git status \-\-short\fR
+A added_file
+A\:M added_file_with_unstaged_changes
+D deleted_file
+ M modified_file
+ D unstaged_deleted_file
+?? unadded_file
+\fB$ git freeze\fR
+\fB$ git status \-\-short\fR
+\fB$ git log \-n 2 \-\-stat\fR
+commit 182eccae8e385acba21c9ff2713e98ff4b7e17cd
+Author: Robert Iannucci <iannucci@chromium\&.org>
+Date: Thu Mar 13 17:42:37 2014 \-0700
+
+ FREEZE\&.unindexed
+
+ added_file_with_unstaged_changes | 3 ++\:\-
+ modified_file | 4 +++\:\-
+ unadded_file | 3 +++
+ unstaged_deleted_file | 1 \-
+ 4 files changed, 8 insertions(+), 3 deletions(\-)
+
+commit ce07bdc49a61f54e6142b4bba5cc517cf6802bd4
+Author: Robert Iannucci <iannucci@chromium\&.org>
+Date: Thu Mar 13 17:42:37 2014 \-0700
+
+ FREEZE\&.indexed
+
+ added_file | 3 +++
+ added_file_with_unstaged_changes | 1 +
+ deleted_file | 1 \-
+ 3 files changed, 4 insertions(+), 1 deletion(\-)
+\fB$ git thaw\fR
+\fB$ git status \-\-short\fR
+A added_file
+A\:M added_file_with_unstaged_changes
+D deleted_file
+ M modified_file
+ D unstaged_deleted_file
+?? unadded_file
+.fi
+.if n \{\
+.RE
+.\}
+.sp
.SH "SEE ALSO"
.sp
\fBgit-thaw\fR(1)
.SH "CHROMIUM DEPOT_TOOLS"
.sp
-Part of the chromium depot_tools suite\&. These tools are meant to assist with the development of chromium and related projects\&. Download the tools from \m[blue]\fBhere\fR\m[]\&\s-2\u[1]\d\s+2\&.
+Part of the chromium \fBdepot_tools\fR(1) suite\&. These tools are meant to assist with the development of chromium and related projects\&. Download the tools from \m[blue]\fBhere\fR\m[]\&\s-2\u[1]\d\s+2\&.
.SH "NOTES"
.IP " 1." 4
here
« no previous file with comments | « docs/man1/depot_tools.1 ('k') | docs/man1/git-map.1 » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698