[PATCH 2/2] Document "git log --simplify-by-decoration"

Nanako Shiraishi· Nov 10, 2008, 09:58 UTC · lore

Signed-off-by: Nanako Shiraishi <nanako3@lavabit.com>
---
 Documentation/rev-list-options.txt |    7 +++++++
 1 files changed, 7 insertions(+), 0 deletions(-)

Show changes to Documentation/rev-list-options.txt +7 −0

diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt
index 966276b..977290c 100644
--- a/Documentation/rev-list-options.txt
+++ b/Documentation/rev-list-options.txt
@@ -456,6 +456,13 @@ Note the major differences in `N` and `P` over '\--full-history':
   removed completely, because it had one parent and is TREESAME.
 --
 
+The '\--simplify-by-decoration' option can be used to treat commits that
+are not referenced by tags as TREESAME, and treat commits that are tagged
+as !TREESAME (even when they have exactly the same tree as their parents).
+This can be used when you are only interested in the big picture of the
+topology of the history.
+
+
 ifdef::git-rev-list[]
 Bisection Helpers
 ~~~~~~~~~~~~~~~~~

-- 
1.6.0.2

-- 
Nanako Shiraishi
http://ivory.ap.teacup.com/nanako3/

Santi Béjar· Nov 10, 2008, 10:47 UTC · re: Nanako Shiraishi · lore

Re: [PATCH 2/2] Document "git log --simplify-by-decoration"

On Mon, Nov 10, 2008 at 10:58 AM, Nanako Shiraishi <nanako3@lavabit.com> wrote:

Show 20 quoted lines

> Signed-off-by: Nanako Shiraishi <nanako3@lavabit.com>
> ---
>  Documentation/rev-list-options.txt |    7 +++++++
>  1 files changed, 7 insertions(+), 0 deletions(-)
>
> diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt
> index 966276b..977290c 100644
> --- a/Documentation/rev-list-options.txt
> +++ b/Documentation/rev-list-options.txt
> @@ -456,6 +456,13 @@ Note the major differences in `N` and `P` over '\--full-history':
>   removed completely, because it had one parent and is TREESAME.
>  --
>
> +The '\--simplify-by-decoration' option can be used to treat commits that
> +are not referenced by tags as TREESAME, and treat commits that are tagged
> +as !TREESAME (even when they have exactly the same tree as their parents).
> +This can be used when you are only interested in the big picture of the
> +topology of the history.
> +
> +

I prefer the other way around, first what it does, and then how it does it (but it is a general comment about the help in "History Simplification", at least when viewing the help for "git log"). And you should rewrite the line 416:

Finally, there is a fourth simplification mode available

as it is no longer "Finally".

Santi

patch, 2 partsDocument "git log --simplify-by-decoration"