[PATCH] Fix usage of carets in git-rev-parse(1)
From: Jonas Fonseca <hidden>
Date: 2016-06-15 22:42:08
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
Possibly related (same subject, not in this thread)
- 2016-06-15 · Re: [PATCH] Fix usage of carets in git-rev-parse(1) · Junio C Hamano <hidden>
... but using a {caret} attribute.
Signed-off-by: Jonas Fonseca <redacted>
---
Junio C Hamano [off-list ref] wrote Wed, Oct 05, 2005:Alan Chandler [off-list ref] writes:quoted
"A suffix ~<n> to a revision parameter means the commit object that is the <n>th generation grand-parent of the named commit object, following only the first parent. I.e. rev~3 is equivalent to rev^ which is equivalent to rev11^1." Why is rev~3 equivalent to rev^, surely it is equivalent to rev^^^ Why is rev~3 equivalent to rev11^1, should that not be rev^1^1^1Sorry, for not knowing how to do that properly in Asciidoc ;-).
I think something like the following will do ...
diff --git a/Documentation/asciidoc.conf b/Documentation/asciidoc.conf
--- a/Documentation/asciidoc.conf
+++ b/Documentation/asciidoc.conf@@ -7,6 +7,9 @@ # Show GIT link as: <command>(<section>); if section is defined, else just show # the command. +[attributes] +caret=^ + ifdef::backend-docbook[] [gitlink-inlinemacro] {0%{target}}
@@ -19,3 +22,5 @@ ifdef::backend-xhtml11[] [gitlink-inlinemacro] <a href="{target}.html">{target}{0?({0})}</a> endif::backend-xhtml11[] + +
diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt
--- a/Documentation/git-rev-parse.txt
+++ b/Documentation/git-rev-parse.txt@@ -54,13 +54,13 @@ OPTIONS `git-diff-\*`). --not:: - When showing object names, prefix them with '^' and - strip '^' prefix from the object names that already have + When showing object names, prefix them with '{caret}' and + strip '{caret}' prefix from the object names that already have one. --symbolic:: Usually the object names are output in SHA1 form (with - possible '^' prefix); this option makes them output in a + possible '{caret}' prefix); this option makes them output in a form as close to the original input as possible.
@@ -93,22 +93,23 @@ what is called an 'extended SHA1' syntax happen to have both heads/master and tags/master, you can explicitly say 'heads/master' to tell GIT which one you mean. -* A suffix '^' to a revision parameter means the first parent of - that commit object. '^<n>' means the <n>th parent (i.e. - 'rev^' - is equivalent to 'rev^1'). As a special rule, - 'rev^0' means the commit itself and is used when 'rev' is the +* A suffix '{caret}' to a revision parameter means the first parent of + that commit object. '{caret}<n>' means the <n>th parent (i.e. + 'rev{caret}' + is equivalent to 'rev{caret}1'). As a special rule, + 'rev{caret}0' means the commit itself and is used when 'rev' is the object name of a tag object that refers to a commit object. * A suffix '~<n>' to a revision parameter means the commit object that is the <n>th generation grand-parent of the named commit object, following only the first parent. I.e. rev~3 is - equivalent to rev^^^ which is equivalent to rev^1^1^1. + equivalent to rev{caret}{caret}{caret} which is equivalent to\ + rev{caret}1{caret}1{caret}1. -'git-rev-parse' also accepts a prefix '^' to revision parameter, +'git-rev-parse' also accepts a prefix '{caret}' to revision parameter, which is passed to 'git-rev-list'. Two revision parameters concatenated with '..' is a short-hand for writing a range -between them. I.e. 'r1..r2' is equivalent to saying '^r1 r2' +between them. I.e. 'r1..r2' is equivalent to saying '{caret}r1 r2' Author
--
Jonas Fonseca