diff mbox series

docs: fix minor glitch in illustration

Message ID pull.762.git.git.1587490505031.gitgitgadget@gmail.com (mailing list archive)
State New, archived
Headers show
Series docs: fix minor glitch in illustration | expand

Commit Message

Linus Arver via GitGitGadget April 21, 2020, 5:35 p.m. UTC 
From: =?UTF-8?q?Michael=20F=2E=20Sch=C3=B6nitzer?= <michael@schoenitzer.de>

In the example by Jon Loeliger the selector 'A^2' was duplicated. This
might confuse readers.

Signed-off-by: Michael F. Schönitzer <michael@schoenitzer.de>
---
    fix minor glitch in an illustration in the documentation
    
    In the example by Jon Loeliger the selector 'A^2' was duplicated. Since
    it is the only duplicate and doesn't fix in the structure I assume it is
    there by incident and since it can confuse readers this patch removes
    it.

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-762%2FNudin%2FNudin-patch-docs-1-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-762/Nudin/Nudin-patch-docs-1-v1
Pull-Request: https://github.com/git/git/pull/762

 Documentation/revisions.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)


base-commit: 9fadedd637b312089337d73c3ed8447e9f0aa775

Comments

Jeff King April 22, 2020, 4:57 a.m. UTC | #1 
On Tue, Apr 21, 2020 at 05:35:04PM +0000, Michael F. Schönitzer via GitGitGadget wrote:

> In the example by Jon Loeliger the selector 'A^2' was duplicated. This
> might confuse readers.
> 
> Signed-off-by: Michael F. Schönitzer <michael@schoenitzer.de>
> ---
>     fix minor glitch in an illustration in the documentation
>     
>     In the example by Jon Loeliger the selector 'A^2' was duplicated. Since
>     it is the only duplicate and doesn't fix in the structure I assume it is
>     there by incident and since it can confuse readers this patch removes
>     it.

This extra explanation could probably go into the commit message. :)

> diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt
> index 97f995e5a9a..1ad95065c1f 100644
> --- a/Documentation/revisions.txt
> +++ b/Documentation/revisions.txt
> @@ -233,7 +233,7 @@ G   H   I   J
>  
>      A =      = A^0
>      B = A^   = A^1     = A~1
> -    C = A^2  = A^2
> +    C =      = A^2
>      D = A^^  = A^1^1   = A~2

OK, so this is describing this diagram:

     D   E   F
      \  |  / \
       \ | /   |
        \|/    |
         B     C
          \   /
           \ /
            A

For "B" we can express A^ as a shorthand for A^1. But for C, a second
parent, there is no such shorthand. We _must_ say A^2. But there's not
much point in saying it twice.

We could just say "C = A^2", but it makes sense to keep A^2 aligned with
the A^1 from the "B" line to make the comparison obvious.

So this patch makes sense to me.

>      E = B^2  = A^^2

Curiously E goes right for B^2. It could be:

  E =    = B^2 = A^^2

or something if we really wanted to make a giant table where all the
possible names were grouped, but I don't think there's much point in
doing so.

-Peff
diff mbox series

Patch

diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt
index 97f995e5a9a..1ad95065c1f 100644
--- a/Documentation/revisions.txt
+++ b/Documentation/revisions.txt
@@ -233,7 +233,7 @@  G   H   I   J
 
     A =      = A^0
     B = A^   = A^1     = A~1
-    C = A^2  = A^2
+    C =      = A^2
     D = A^^  = A^1^1   = A~2
     E = B^2  = A^^2
     F = B^3  = A^^3