undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

revisions.txt: remove ambibuity between <rev>:<path> and :<path>

Browse Source 
The revision ':README' is mentioned as an example for '<rev>:<path>'
but the explanation forwards to the ':<n>:<path>' syntax. At the same
time ':<n>:<path>' did not mark the '<n>:' as optional.

Signed-off-by: Andreas Heiduk <asheiduk@gmail.com>
Signed-off-by: Denton Liu <liu.denton@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Andreas Heiduk 2019-05-05 12:07:10 -04:00 committed by Junio C Hamano
parent 6a12e99a52
commit 4ad1b2c7a6
1 changed files with 2 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Documentation/revisions.txt
View File

@ -195,19 +195,16 @@ existing tag object.
Depending on the given text, the shell's word splitting rules might Depending on the given text, the shell's word splitting rules might
require additional quoting. require additional quoting.
'<rev>:<path>', e.g. 'HEAD:README', ':README', 'master:./README':: '<rev>:<path>', e.g. 'HEAD:README', 'master:./README'::
A suffix ':' followed by a path names the blob or tree A suffix ':' followed by a path names the blob or tree
at the given path in the tree-ish object named by the part at the given path in the tree-ish object named by the part
before the colon. before the colon.
':path' (with an empty part before the colon)
is a special case of the syntax described next: content
recorded in the index at the given path.
A path starting with './' or '../' is relative to the current working directory. A path starting with './' or '../' is relative to the current working directory.
The given path will be converted to be relative to the working tree's root directory. The given path will be converted to be relative to the working tree's root directory.
This is most useful to address a blob or tree from a commit or tree that has This is most useful to address a blob or tree from a commit or tree that has
the same tree structure as the working tree. the same tree structure as the working tree.
':<n>:<path>', e.g. ':0:README', ':README':: ':[<n>:]<path>', e.g. ':0:README', ':README'::
A colon, optionally followed by a stage number (0 to 3) and a A colon, optionally followed by a stage number (0 to 3) and a
colon, followed by a path, names a blob object in the colon, followed by a path, names a blob object in the
index at the given path. A missing stage number (and the colon index at the given path. A missing stage number (and the colon