From f39461c4417089d66de15e6b7f27f615b4309246 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Mon, 25 Dec 2006 11:36:40 +0000 Subject: [PATCH] Autogenerated man pages for v1.4.4.3-gd4ada --- man1/git-add.1 | 74 ++++++++++++++++++++++++++++++++++- man1/git-rev-list.1 | 94 +++++++++++---------------------------------- 2 files changed, 95 insertions(+), 73 deletions(-) diff --git a/man1/git-add.1 b/man1/git-add.1 index 75c910210..5334fac9f 100644 --- a/man1/git-add.1 +++ b/man1/git-add.1 @@ -2,7 +2,7 @@ .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). .\" Instead of manually editing it, you probably should edit the DocBook XML .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. -.TH "GIT\-ADD" "1" "12/13/2006" "" "" +.TH "GIT\-ADD" "1" "12/25/2006" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -10,7 +10,7 @@ .SH "NAME" git\-add \- Add file contents to the changeset to be committed next .SH "SYNOPSIS" -\fIgit\-add\fR [\-n] [\-v] [\-\-] \&... +\fIgit\-add\fR [\-n] [\-v] [\-\-interactive] [\-\-] \&... .SH "DESCRIPTION" All the changed file contents to be committed together in a single set of changes must be "added" with the \fIadd\fR command before using the \fIcommit\fR command. This is not only for adding new files. Even modified files must be added to the set of changes about to be committed. @@ -32,6 +32,9 @@ Don't actually add the file(s), just show if they exist. \-v Be verbose. .TP +\-\-interactive +Add modified contents in the working tree interactively to the index. +.TP \-\- This option can be used to separate command\-line options from the list of files, (useful when filenames might be mistaken for command\-line options). .SH "EXAMPLES" @@ -43,6 +46,73 @@ Note that the asterisk * is quoted from the shell in this example; this lets the .TP git\-add git\-*.sh Considers adding content from all git\-*.sh scripts. Because this example lets shell expand the asterisk (i.e. you are listing the files explicitly), it does not consider subdir/git\-foo.sh. +.SH "INTERACTIVE MODE" +When the command enters the interactive mode, it shows the output of the \fIstatus\fR subcommand, and then goes into ints interactive command loop. + +The command loop shows the list of subcommands available, and gives a prompt "What now> ". In general, when the prompt ends with a single \fI>\fR, you can pick only one of the choices given and type return, like this: +.sp +.nf + *** Commands *** + 1: status 2: update 3: revert 4: add untracked + 5: patch 6: diff 7: quit 8: help + What now> 1 +.fi +You also could say "s" or "sta" or "status" above as long as the choice is unique. + +The main command loop has 6 subcommands (plus help and quit). +.TP +status +This shows the change between HEAD and index (i.e. what will be committed if you say "git commit"), and between index and working tree files (i.e. what you could stage further before "git commit" using "git\-add") for each path. A sample output looks like this: +.sp +.nf + staged unstaged path + 1: binary nothing foo.png + 2: +403/\-35 +1/\-1 git\-add\-\-interactive.perl +.fi +It shows that foo.png has differences from HEAD (but that is binary so line count cannot be shown) and there is no difference between indexed copy and the working tree version (if the working tree version were also different, \fIbinary\fR would have been shown in place of \fInothing\fR). The other file, git\-add\-\-interactive.perl, has 403 lines added and 35 lines deleted if you commit what is in the index, but working tree file has further modifications (one addition and one deletion). +.TP +update +This shows the status information and gives prompt "Update>>". When the prompt ends with double \fI>>\fR, you can make more than one selection, concatenated with whitespace or comma. Also you can say ranges. E.g. "2\-5 7,9" to choose 2,3,4,5,7,9 from the list. You can say \fI*\fR to choose everything. + +What you chose are then highlighted with \fI*\fR, like this: +.sp +.nf + staged unstaged path + 1: binary nothing foo.png +* 2: +403/\-35 +1/\-1 git\-add\-\-interactive.perl +.fi +To remove selection, prefix the input with \- like this: +.sp +.nf +Update>> \-2 +.fi +After making the selection, answer with an empty line to stage the contents of working tree files for selected paths in the index. +.TP +revert +This has a very similar UI to \fIupdate\fR, and the staged information for selected paths are reverted to that of the HEAD version. Reverting new paths makes them untracked. +.TP +add untracked +This has a very similar UI to \fIupdate\fR and \fIrevert\fR, and lets you add untracked paths to the index. +.TP +patch +This lets you choose one path out of \fIstatus\fR like selection. After choosing the path, it presents diff between the index and the working tree file and asks you if you want to stage the change of each hunk. You can say: +.sp +.nf +y \- add the change from that hunk to index +n \- do not add the change from that hunk to index +a \- add the change from that hunk and all the rest to index +d \- do not the change from that hunk nor any of the rest to index +j \- do not decide on this hunk now, and view the next + undecided hunk +J \- do not decide on this hunk now, and view the next hunk +k \- do not decide on this hunk now, and view the previous + undecided hunk +K \- do not decide on this hunk now, and view the previous hunk +.fi +After deciding the fate for all hunks, if there is any hunk that was chosen, the index is updated with the selected hunks. +.TP +diff +This lets you review what will be committed (i.e. between HEAD and index). .SH "SEE ALSO" \fBgit\-status\fR(1) \fBgit\-rm\fR(1) \fBgit\-mv\fR(1) \fBgit\-commit\fR(1) \fBgit\-update\-index\fR(1) .SH "AUTHOR" diff --git a/man1/git-rev-list.1 b/man1/git-rev-list.1 index a55a6dd3b..84cc9f6da 100644 --- a/man1/git-rev-list.1 +++ b/man1/git-rev-list.1 @@ -2,7 +2,7 @@ .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). .\" Instead of manually editing it, you probably should edit the DocBook XML .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. -.TH "GIT\-REV\-LIST" "1" "11/23/2006" "" "" +.TH "GIT\-REV\-LIST" "1" "12/25/2006" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -13,6 +13,7 @@ git\-rev\-list \- Lists commit objects in reverse chronological order .sp .nf \fIgit\-rev\-list\fR [ \-\-max\-count=number ] + [ \-\-skip=number ] [ \-\-max\-age=timestamp ] [ \-\-min\-age=timestamp ] [ \-\-sparse ] @@ -32,51 +33,33 @@ git\-rev\-list \- Lists commit objects in reverse chronological order .fi .SH "DESCRIPTION" Lists commit objects in reverse chronological order starting at the given commit(s), taking ancestry relationship into account. This is useful to produce human\-readable log output. -.sp + Commits which are stated with a preceding \fI^\fR cause listing to stop at that point. Their parents are implied. Thus the following command: .sp -.sp .nf $ git\-rev\-list foo bar ^baz .fi means "list all the commits which are included in \fIfoo\fR and \fIbar\fR, but not in \fIbaz\fR". -.sp + A special notation "\fI\fR..\fI\fR" can be used as a short\-hand for "^\fI\fR \fI\fR". For example, either of the following may be used interchangeably: .sp -.sp .nf $ git\-rev\-list origin..HEAD $ git\-rev\-list HEAD ^origin .fi Another special notation is "\fI\fR\&...\fI\fR" which is useful for merges. The resulting set of commits is the symmetric difference between the two operands. The following two commands are equivalent: .sp -.sp .nf $ git\-rev\-list A B \-\-not $(git\-merge\-base \-\-all A B) $ git\-rev\-list A...B .fi \fBgit\-rev\-list\fR(1) is a very essential git program, since it provides the ability to build and traverse commit ancestry graphs. For this reason, it has a lot of different options that enables it to be used by commands as different as \fBgit\-bisect\fR(1) and \fBgit\-repack\fR(1). -.sp .SH "OPTIONS" .SS "Commit Formatting" Using these options, \fBgit\-rev\-list\fR(1) will act similar to the more specialized family of commit log tools: \fBgit\-log\fR(1), \fBgit\-show\fR(1), and \fBgit\-whatchanged\fR(1) -.sp .TP \-\-pretty[=\fI\fR] -Pretty\-prints the details of a commit. -\-\-pretty -without an explicit -= -defaults to -\fImedium\fR. If the commit is a merge, and if the pretty\-format is not -\fIoneline\fR, -\fIemail\fR -or -\fIraw\fR, an additional line is inserted before the -\fIAuthor:\fR -line. This line begins with "Merge: " and the sha1s of ancestral commits are printed, separated by spaces. Note that the listed commits may not necessarily be the list of the -\fBdirect\fR -parent commits if you have limited your view of history: for example, if you are only interested in changes related to a certain directory or file. Here are some additional details for each format: +Pretty\-prints the details of a commit. \-\-pretty without an explicit = defaults to \fImedium\fR. If the commit is a merge, and if the pretty\-format is not \fIoneline\fR, \fIemail\fR or \fIraw\fR, an additional line is inserted before the \fIAuthor:\fR line. This line begins with "Merge: " and the sha1s of ancestral commits are printed, separated by spaces. Note that the listed commits may not necessarily be the list of the \fBdirect\fR parent commits if you have limited your view of history: for example, if you are only interested in changes related to a certain directory or file. Here are some additional details for each format: .RS .TP 3 \(bu @@ -168,12 +151,8 @@ full commit message> .TP \(bu \fIraw\fR -.sp -The -\fIraw\fR -format shows the entire commit exactly as stored in the commit object. Notably, the SHA1s are displayed in full, regardless of whether \-\-abbrev or \-\-no\-abbrev are used, and -\fIparents\fR -information show the true parent commits, without taking grafts nor history simplification into account. + +The \fIraw\fR format shows the entire commit exactly as stored in the commit object. Notably, the SHA1s are displayed in full, regardless of whether \-\-abbrev or \-\-no\-abbrev are used, and \fIparents\fR information show the true parent commits, without taking grafts nor history simplification into account. .RE .TP \-\-relative\-date @@ -186,29 +165,27 @@ Print the contents of the commit in raw\-format; each record is separated with a Print the parents of the commit. .SS "Diff Formatting" Below are listed options that control the formatting of diff output. Some of them are specific to \fBgit\-rev\-list\fR(1), however other diff options may be given. See \fBgit\-diff\-files\fR(1) for more options. -.sp .TP \-c This flag changes the way a merge commit is displayed. It shows the differences from each of the parents to the merge result simultaneously instead of showing pairwise diff between a parent and the result one at a time. Furthermore, it lists only files which were modified from all parents. .TP \-\-cc -This flag implies the -\fI\-c\fR -options and further compresses the patch output by omitting hunks that show differences from only one parent, or show the same change from all but one parent for an Octopus merge. +This flag implies the \fI\-c\fR options and further compresses the patch output by omitting hunks that show differences from only one parent, or show the same change from all but one parent for an Octopus merge. .TP \-r Show recursive diffs. .TP \-t -Show the tree objects in the diff output. This implies -\fI\-r\fR. +Show the tree objects in the diff output. This implies \fI\-r\fR. .SS "Commit Limiting" Besides specifying a range of commits that should be listed using the special notations explained in the description, additional commit limiting may be applied. -.sp .TP \-n \fInumber\fR, \-\-max\-count=\fInumber\fR Limit the number of commits output. .TP +\-\-skip=\fInumber\fR +Skip \fInumber\fR commits before starting to show the commit output. +.TP \-\-since=\fIdate\fR, \-\-after=\fIdate\fR Show commits more recent than a specific date. .TP @@ -231,21 +208,13 @@ Stop when a given path disappears from the tree. Do not print commits with more than one parent. .TP \-\-not -Reverses the meaning of the -\fI^\fR -prefix (or lack thereof) for all following revision specifiers, up to the next -\fI\-\-not\fR. +Reverses the meaning of the \fI^\fR prefix (or lack thereof) for all following revision specifiers, up to the next \fI\-\-not\fR. .TP \-\-all -Pretend as if all the refs in -$GIT_DIR/refs/ -are listed on the command line as -\fI\fR. +Pretend as if all the refs in $GIT_DIR/refs/ are listed on the command line as \fI\fR. .TP \-\-stdin -In addition to the -\fI\fR -listed on the command line, read them from the standard input. +In addition to the \fI\fR listed on the command line, read them from the standard input. .TP \-\-merge After a failed merge, show refs that touch files having a conflict and don't exist on all heads to merge. @@ -255,10 +224,8 @@ Output uninteresting commits at the boundary, which are usually not shown. .TP \-\-dense, \-\-sparse When optional paths are given, the default behaviour (\fI\-\-dense\fR) is to only output commits that changes at least one of them, and also ignore merges that do not touch the given paths. -.sp -Use the -\fI\-\-sparse\fR -flag to makes the command output all eligible commits (still subject to count and age limitation), but apply merge simplification nevertheless. + +Use the \fI\-\-sparse\fR flag to makes the command output all eligible commits (still subject to count and age limitation), but apply merge simplification nevertheless. .TP \-\-bisect Limit output to the one commit object which is roughly halfway between the included and excluded commits. Thus, if @@ -266,8 +233,7 @@ Limit output to the one commit object which is roughly halfway between the inclu .nf $ git\-rev\-list \-\-bisect foo ^bar ^baz .fi -outputs -\fImidpoint\fR, the output of the two commands +outputs \fImidpoint\fR, the output of the two commands .sp .nf $ git\-rev\-list foo ^midpoint @@ -276,41 +242,27 @@ outputs would be of roughly the same length. Finding the change which introduces a regression is thus reduced to a binary search: repeatedly generate and test new 'midpoint's until the commit chain is of length one. .SS "Commit Ordering" By default, the commits are shown in reverse chronological order. -.sp .TP \-\-topo\-order This option makes them appear in topological order (i.e. descendant commits are shown before their parents). .TP \-\-date\-order -This option is similar to -\fI\-\-topo\-order\fR -in the sense that no parent comes before all of its children, but otherwise things are still ordered in the commit timestamp order. +This option is similar to \fI\-\-topo\-order\fR in the sense that no parent comes before all of its children, but otherwise things are still ordered in the commit timestamp order. .SS "Object Traversal" These options are mostly targeted for packing of git repositories. -.sp .TP \-\-objects -Print the object IDs of any object referenced by the listed commits. -\fIgit\-rev\-list \-\-objects foo ^bar\fR -thus means "send me all object IDs which I need to download if I have the commit object -\fIbar\fR, but not -\fIfoo\fR". +Print the object IDs of any object referenced by the listed commits. \fIgit\-rev\-list \-\-objects foo ^bar\fR thus means "send me all object IDs which I need to download if I have the commit object \fIbar\fR, but not \fIfoo\fR". .TP \-\-objects\-edge -Similar to -\fI\-\-objects\fR, but also print the IDs of excluded commits prefixed with a "\-" character. This is used by -\fBgit\-pack\-objects\fR(1) -to build "thin" pack, which records objects in deltified form based on objects contained in these excluded commits to reduce network traffic. +Similar to \fI\-\-objects\fR, but also print the IDs of excluded commits prefixed with a "\-" character. This is used by \fBgit\-pack\-objects\fR(1) to build "thin" pack, which records objects in deltified form based on objects contained in these excluded commits to reduce network traffic. .TP \-\-unpacked -Only useful with -\fI\-\-objects\fR; print the object IDs that are not in packs. +Only useful with \fI\-\-objects\fR; print the object IDs that are not in packs. .SH "AUTHOR" Written by Linus Torvalds -.sp .SH "DOCUMENTATION" Documentation by David Greaves, Junio C Hamano, Jonas Fonseca and the git\-list . -.sp .SH "GIT" Part of the \fBgit\fR(7) suite -.sp + -- 2.26.2