docs: fix minor glitch in illustration
PATCH 1/1 docs: fix minor glitch in illustration
From: =?UTF-8?q?Michael=20F=2E=20Sch=C3=B6nitzer?= <[email protected]>
In the example by Jon Loeliger the selector 'A^2' was duplicated. This might confuse readers.
---
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(-)
Documentation/revisions.txt +1 -1
@@ -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
base-commit: 9fadedd637b312089337d73c3ed8447e9f0aa775
Signature · 1 line
gitgitgadget
Quoted 11 lines · Michael F. Schönitzer via GitGitGadget
In the example by Jon Loeliger the selector 'A^2' was duplicated. This might confuse readers.
Signed-off-by Michael F. Schönitzer <[email protected]>---
fix minor glitch in an illustration in the documentationIn 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. :)
Documentation/revisions.txt G H I J · line 237
Quoted 11 lines
Documentation/revisions.txt +1
-1@@ -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
\ /
\ /
AFor "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.
Documentation/revisions.txt G H I J · line 238
Quoted 1 line
Documentation/revisions.txt +0
-0E = 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