From a2f4662f592080968a8ce848d3e5d84003a6c20d Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Wed, 3 Sep 2008 05:20:31 +0000 Subject: [PATCH] Autogenerated HTML docs for v1.6.0.1-196-g0191 --- diff-options.txt | 11 +++---- git-commit.html | 8 +++-- git-commit.txt | 6 ++-- git-diff-files.html | 13 ++++---- git-diff-index.html | 13 ++++---- git-diff-tree.html | 13 ++++---- git-diff.html | 13 ++++---- git-for-each-ref.html | 4 +-- git-for-each-ref.txt | 2 +- git-format-patch.html | 13 ++++---- git-help.html | 6 ++-- git-help.txt | 4 ++- git-log.html | 73 ++++++++++++++++++++++++++++++++++++++----- git-rev-list.html | 62 +++++++++++++++++++++++++++++++++++- git-stash.html | 18 +++++------ git-stash.txt | 16 +++++----- rev-list-options.txt | 42 +++++++++++++++++++++++++ 17 files changed, 240 insertions(+), 77 deletions(-) diff --git a/diff-options.txt b/diff-options.txt index 175938640..6e268326d 100644 --- a/diff-options.txt +++ b/diff-options.txt @@ -59,12 +59,11 @@ endif::git-format-patch[] lines. --dirstat[=limit]:: - Output only the sub-directories that are impacted by a diff, - and to what degree they are impacted. You can override the - default cut-off in percent (3) by "--dirstat=limit". If you - want to enable "cumulative" directory statistics, you can use - the "--cumulative" flag, which adds up percentages recursively - even when they have been already reported for a sub-directory. + Output the distribution of relative amount of changes (number of lines added or + removed) for each sub-directory. Directories with changes below + a cut-off percent (3% by default) are not shown. The cut-off percent + can be set with "--dirstat=limit". Changes in a child directory is not + counted for the parent directory, unless "--cumulative" is used. --summary:: Output a condensed summary of extended header information diff --git a/git-commit.html b/git-commit.html index 1b21a4c8b..581c5235f 100644 --- a/git-commit.html +++ b/git-commit.html @@ -434,8 +434,10 @@ that, you can recover from it with git-reset.

- Override the author name used in the commit. Use - A U Thor <author@example.com> format. + Override the author name used in the commit. You can use the + standard A U Thor <author@example.com> format. Otherwise, + an existing commit that matches the given string and its author + name is used.

@@ -861,7 +863,7 @@ Junio C Hamano <gitster@pobox.com>

diff --git a/git-commit.txt b/git-commit.txt index 0e25bb862..eb05b0f49 100644 --- a/git-commit.txt +++ b/git-commit.txt @@ -75,8 +75,10 @@ OPTIONS read the message from the standard input. --author=:: - Override the author name used in the commit. Use - `A U Thor ` format. + Override the author name used in the commit. You can use the + standard `A U Thor ` format. Otherwise, + an existing commit that matches the given string and its author + name is used. -m :: --message=:: diff --git a/git-diff-files.html b/git-diff-files.html index 1257abea7..8bc500a22 100644 --- a/git-diff-files.html +++ b/git-diff-files.html @@ -421,12 +421,11 @@ same as for git-diff-index and git-diff-tree.

- Output only the sub-directories that are impacted by a diff, - and to what degree they are impacted. You can override the - default cut-off in percent (3) by "--dirstat=limit". If you - want to enable "cumulative" directory statistics, you can use - the "--cumulative" flag, which adds up percentages recursively - even when they have been already reported for a sub-directory. + Output the distribution of relative amount of changes (number of lines added or + removed) for each sub-directory. Directories with changes below + a cut-off percent (3% by default) are not shown. The cut-off percent + can be set with "--dirstat=limit". Changes in a child directory is not + counted for the parent directory, unless "--cumulative" is used.

@@ -1339,7 +1338,7 @@ the pathname, but if that is NUL, the record will show two paths.

diff --git a/git-diff-index.html b/git-diff-index.html index d004fc8fb..fa3ddb453 100644 --- a/git-diff-index.html +++ b/git-diff-index.html @@ -422,12 +422,11 @@ entries in the index are compared.

- Output only the sub-directories that are impacted by a diff, - and to what degree they are impacted. You can override the - default cut-off in percent (3) by "--dirstat=limit". If you - want to enable "cumulative" directory statistics, you can use - the "--cumulative" flag, which adds up percentages recursively - even when they have been already reported for a sub-directory. + Output the distribution of relative amount of changes (number of lines added or + removed) for each sub-directory. Directories with changes below + a cut-off percent (3% by default) are not shown. The cut-off percent + can be set with "--dirstat=limit". Changes in a child directory is not + counted for the parent directory, unless "--cumulative" is used.

@@ -1426,7 +1425,7 @@ always have the special all-zero sha1. diff --git a/git-diff-tree.html b/git-diff-tree.html index c33b89c5d..5aeaa0218 100644 --- a/git-diff-tree.html +++ b/git-diff-tree.html @@ -424,12 +424,11 @@ git-diff-tree(1) Manual Page

- Output only the sub-directories that are impacted by a diff, - and to what degree they are impacted. You can override the - default cut-off in percent (3) by "--dirstat=limit". If you - want to enable "cumulative" directory statistics, you can use - the "--cumulative" flag, which adds up percentages recursively - even when they have been already reported for a sub-directory. + Output the distribution of relative amount of changes (number of lines added or + removed) for each sub-directory. Directories with changes below + a cut-off percent (3% by default) are not shown. The cut-off percent + can be set with "--dirstat=limit". Changes in a child directory is not + counted for the parent directory, unless "--cumulative" is used.

@@ -1862,7 +1861,7 @@ the pathname, but if that is NUL, the record will show two paths.

diff --git a/git-diff.html b/git-diff.html index 7d6e69318..595bb56a4 100644 --- a/git-diff.html +++ b/git-diff.html @@ -500,12 +500,11 @@ and the range notations ("<commit>..<commit>" and

- Output only the sub-directories that are impacted by a diff, - and to what degree they are impacted. You can override the - default cut-off in percent (3) by "--dirstat=limit". If you - want to enable "cumulative" directory statistics, you can use - the "--cumulative" flag, which adds up percentages recursively - even when they have been already reported for a sub-directory. + Output the distribution of relative amount of changes (number of lines added or + removed) for each sub-directory. Directories with changes below + a cut-off percent (3% by default) are not shown. The cut-off percent + can be set with "--dirstat=limit". Changes in a child directory is not + counted for the parent directory, unless "--cumulative" is used.

@@ -1541,7 +1540,7 @@ Output diff in reverse. diff --git a/git-for-each-ref.html b/git-for-each-ref.html index a6b14002c..c6c5afe13 100644 --- a/git-for-each-ref.html +++ b/git-for-each-ref.html @@ -328,7 +328,7 @@ git-for-each-ref(1) Manual Page

Iterate over all refs that match <pattern> and show them according to the given <format>, after sorting them according -to the given set of <key>. If <max> is given, stop after +to the given set of <key>. If <count> is given, stop after showing that many refs. The interpolated values in <format> can optionally be quoted as string literals in the specified host language allowing their direct evaluation in that language.

@@ -553,7 +553,7 @@ eval "$eval"
diff --git a/git-for-each-ref.txt b/git-for-each-ref.txt index eae6c0e7b..ebd7c5fbb 100644 --- a/git-for-each-ref.txt +++ b/git-for-each-ref.txt @@ -16,7 +16,7 @@ DESCRIPTION Iterate over all refs that match `` and show them according to the given ``, after sorting them according -to the given set of ``. If `` is given, stop after +to the given set of ``. If `` is given, stop after showing that many refs. The interpolated values in `` can optionally be quoted as string literals in the specified host language allowing their direct evaluation in that language. diff --git a/git-format-patch.html b/git-format-patch.html index 9fabc3d30..c45738fd0 100644 --- a/git-format-patch.html +++ b/git-format-patch.html @@ -470,12 +470,11 @@ reference.

- Output only the sub-directories that are impacted by a diff, - and to what degree they are impacted. You can override the - default cut-off in percent (3) by "--dirstat=limit". If you - want to enable "cumulative" directory statistics, you can use - the "--cumulative" flag, which adds up percentages recursively - even when they have been already reported for a sub-directory. + Output the distribution of relative amount of changes (number of lines added or + removed) for each sub-directory. Directories with changes below + a cut-off percent (3% by default) are not shown. The cut-off percent + can be set with "--dirstat=limit". Changes in a child directory is not + counted for the parent directory, unless "--cumulative" is used.

@@ -1151,7 +1150,7 @@ as e-mailable patches: diff --git a/git-help.html b/git-help.html index 953e0a10d..7b4eb1c62 100644 --- a/git-help.html +++ b/git-help.html @@ -462,7 +462,9 @@ listed in the configuration file.

will try to use konqueror first. But this may fail (for example if DISPLAY is not set) and in that case emacs' woman mode will be tried.

-

If everything fails the man program will be tried anyway.

+

If everything fails, or if no viewer is configured, the viewer specified +in the GIT_MAN_VIEWER environment variable will be tried. If that +fails too, the man program will be tried anyway.

man.<tool>.path

You can explicitly provide a full path to your preferred man viewer by setting the configuration variable man.<tool>.path. For example, you @@ -521,7 +523,7 @@ little. Maintenance is done by the git-list <git@vger.kernel.org>.

diff --git a/git-help.txt b/git-help.txt index f414583fc..d9b9c34b3 100644 --- a/git-help.txt +++ b/git-help.txt @@ -112,7 +112,9 @@ For example, this configuration: will try to use konqueror first. But this may fail (for example if DISPLAY is not set) and in that case emacs' woman mode will be tried. -If everything fails the 'man' program will be tried anyway. +If everything fails, or if no viewer is configured, the viewer specified +in the GIT_MAN_VIEWER environment variable will be tried. If that +fails too, the 'man' program will be tried anyway. man..path ~~~~~~~~~~~~~~~ diff --git a/git-log.html b/git-log.html index cfd046a23..4987f2120 100644 --- a/git-log.html +++ b/git-log.html @@ -422,12 +422,11 @@ each commit introduces are shown.

- Output only the sub-directories that are impacted by a diff, - and to what degree they are impacted. You can override the - default cut-off in percent (3) by "--dirstat=limit". If you - want to enable "cumulative" directory statistics, you can use - the "--cumulative" flag, which adds up percentages recursively - even when they have been already reported for a sub-directory. + Output the distribution of relative amount of changes (number of lines added or + removed) for each sub-directory. Directories with changes below + a cut-off percent (3% by default) are not shown. The cut-off percent + can be set with "--dirstat=limit". Changes in a child directory is not + counted for the parent directory, unless "--cumulative" is used.

@@ -1425,6 +1424,66 @@ one of the parents is TREESAME, we follow only that one, so the other sides of the merge are never walked.

+

Finally, there is a fourth simplification mode available:

+
+
+--simplify-merges +
+
+

+ First, build a history graph in the same way that + --full-history with parent rewriting does (see above). +

+

Then simplify each commit C to its replacement C' in the final +history according to the following rules:

+
    +
  • +

    +Set C' to C.
    +

    +
    • +
  • +

    +Replace each parent P of C' with its simplification P'. In + the process, drop parents that are ancestors of other parents, and + remove duplicates.
    +

    +
    • +
  • +

    +If after this parent rewriting, C' is a root or merge commit (has + zero or >1 parents), a boundary commit, or !TREESAME, it remains. + Otherwise, it is replaced with its only parent. +

    +
    • +
+

The effect of this is best shown by way of comparing to +--full-history with parent rewriting. The example turns into:

+
+
+
          .-A---M---N---O
+         /     /       /
+        I     B       D
+         \   /       /
+          `---------'
+
+

Note the major differences in N and P over --full-history:

+
    +
  • +

    +N's parent list had I removed, because it is an ancestor of the + other parent M. Still, N remained because it is !TREESAME.
    +

    +
    • +
  • +

    +P's parent list similarly had I removed. P was then + removed completely, because it had one parent and is TREESAME. +

    +
    • +
+
+

Commit Ordering

By default, the commits are shown in reverse chronological order.

@@ -2166,7 +2225,7 @@ reversible operation.

diff --git a/git-rev-list.html b/git-rev-list.html index e9af4092f..2b8c52b78 100644 --- a/git-rev-list.html +++ b/git-rev-list.html @@ -951,6 +951,66 @@ one of the parents is TREESAME, we follow only that one, so the other sides of the merge are never walked.

+

Finally, there is a fourth simplification mode available:

+
+
+--simplify-merges +
+
+

+ First, build a history graph in the same way that + --full-history with parent rewriting does (see above). +

+

Then simplify each commit C to its replacement C' in the final +history according to the following rules:

+
    +
  • +

    +Set C' to C.
    +

    +
    • +
  • +

    +Replace each parent P of C' with its simplification P'. In + the process, drop parents that are ancestors of other parents, and + remove duplicates.
    +

    +
    • +
  • +

    +If after this parent rewriting, C' is a root or merge commit (has + zero or >1 parents), a boundary commit, or !TREESAME, it remains. + Otherwise, it is replaced with its only parent. +

    +
    • +
+

The effect of this is best shown by way of comparing to +--full-history with parent rewriting. The example turns into:

+
+
+
          .-A---M---N---O
+         /     /       /
+        I     B       D
+         \   /       /
+          `---------'
+
+

Note the major differences in N and P over --full-history:

+
    +
  • +

    +N's parent list had I removed, because it is an ancestor of the + other parent M. Still, N remained because it is !TREESAME.
    +

    +
    • +
  • +

    +P's parent list similarly had I removed. P was then + removed completely, because it had one parent and is TREESAME. +

    +
    • +
+
+

Bisection Helpers

@@ -1441,7 +1501,7 @@ and the git-list <git@vger.kernel.org>.

diff --git a/git-stash.html b/git-stash.html index 22a945fde..dabe8c286 100644 --- a/git-stash.html +++ b/git-stash.html @@ -504,7 +504,7 @@ perform a pull, and then unstash, like this:

$ git pull
-...
+ ...
 file foobar not up to date, cannot merge.
 $ git stash
 $ git pull
@@ -523,7 +523,7 @@ return to your original branch to make the emergency fix, like this:
 

 

 

-
... hack hack hack ...
+
# ... hack hack hack ...
 $ git checkout -b my_wip
 $ git commit -a -m "WIP"
 $ git checkout master
@@ -531,17 +531,17 @@ $ edit emergency fix
 $ git commit -a -m "Fix in a hurry"
 $ git checkout my_wip
 $ git reset --soft HEAD^
-... continue hacking ...

+# ... continue hacking ...

 

 
You can use git-stash to simplify the above, like this:

 

 

-
... hack hack hack ...
+
# ... hack hack hack ...
 $ git stash
 $ edit emergency fix
 $ git commit -a -m "Fix in a hurry"
 $ git stash apply
-... continue hacking ...

+# ... continue hacking ...

 

 
 

@@ -555,13 +555,13 @@ each change before committing:
 

 

 

-
... hack hack hack ...
+
# ... hack hack hack ...
 $ git add --patch foo            # add just first part to the index
 $ git stash save --keep-index    # save all other changes to the stash
 $ edit/build/test first part
-$ git commit foo -m 'First part' # commit fully tested change
+$ git commit -m 'First part'     # commit fully tested change
 $ git stash pop                  # prepare to work on all other changes
-... repeat above five steps until one commit remains ...
+# ... repeat above five steps until one commit remains ...
 $ edit/build/test remaining parts
 $ git commit foo -m 'Remaining parts'

 

@@ -585,7 +585,7 @@ $ git commit foo -m 'Remaining parts'
diff --git a/git-stash.txt b/git-stash.txt index 49e2296a2..051f94d26 100644 --- a/git-stash.txt +++ b/git-stash.txt @@ -159,7 +159,7 @@ perform a pull, and then unstash, like this: + ---------------------------------------------------------------- $ git pull -... + ... file foobar not up to date, cannot merge. $ git stash $ git pull @@ -174,7 +174,7 @@ make a commit to a temporary branch to store your changes away, and return to your original branch to make the emergency fix, like this: + ---------------------------------------------------------------- -... hack hack hack ... +# ... hack hack hack ... $ git checkout -b my_wip $ git commit -a -m "WIP" $ git checkout master @@ -182,18 +182,18 @@ $ edit emergency fix $ git commit -a -m "Fix in a hurry" $ git checkout my_wip $ git reset --soft HEAD^ -... continue hacking ... +# ... continue hacking ... ---------------------------------------------------------------- + You can use 'git-stash' to simplify the above, like this: + ---------------------------------------------------------------- -... hack hack hack ... +# ... hack hack hack ... $ git stash $ edit emergency fix $ git commit -a -m "Fix in a hurry" $ git stash apply -... continue hacking ... +# ... continue hacking ... ---------------------------------------------------------------- Testing partial commits:: @@ -203,13 +203,13 @@ more commits out of the changes in the work tree, and you want to test each change before committing: + ---------------------------------------------------------------- -... hack hack hack ... +# ... hack hack hack ... $ git add --patch foo # add just first part to the index $ git stash save --keep-index # save all other changes to the stash $ edit/build/test first part -$ git commit foo -m 'First part' # commit fully tested change +$ git commit -m 'First part' # commit fully tested change $ git stash pop # prepare to work on all other changes -... repeat above five steps until one commit remains ... +# ... repeat above five steps until one commit remains ... $ edit/build/test remaining parts $ git commit foo -m 'Remaining parts' ---------------------------------------------------------------- diff --git a/rev-list-options.txt b/rev-list-options.txt index 735cf07b2..0ce916a18 100644 --- a/rev-list-options.txt +++ b/rev-list-options.txt @@ -409,6 +409,48 @@ Note that without '\--full-history', this still simplifies merges: if one of the parents is TREESAME, we follow only that one, so the other sides of the merge are never walked. +Finally, there is a fourth simplification mode available: + +--simplify-merges:: + + First, build a history graph in the same way that + '\--full-history' with parent rewriting does (see above). ++ +Then simplify each commit `C` to its replacement `C'` in the final +history according to the following rules: ++ +-- +* Set `C'` to `C`. ++ +* Replace each parent `P` of `C'` with its simplification `P'`. In + the process, drop parents that are ancestors of other parents, and + remove duplicates. ++ +* If after this parent rewriting, `C'` is a root or merge commit (has + zero or >1 parents), a boundary commit, or !TREESAME, it remains. + Otherwise, it is replaced with its only parent. +-- ++ +The effect of this is best shown by way of comparing to +'\--full-history' with parent rewriting. The example turns into: ++ +----------------------------------------------------------------------- + .-A---M---N---O + / / / + I B D + \ / / + `---------' +----------------------------------------------------------------------- ++ +Note the major differences in `N` and `P` over '\--full-history': ++ +-- +* `N`'s parent list had `I` removed, because it is an ancestor of the + other parent `M`. Still, `N` remained because it is !TREESAME. ++ +* `P`'s parent list similarly had `I` removed. `P` was then + removed completely, because it had one parent and is TREESAME. +-- ifdef::git-rev-list[] Bisection Helpers -- 2.26.2