Thread (6 messages) flat view 6 messages, 3 authors, 2016-06-15

Re: [PATCHv3] git-rev-parse.txt: Document ":path" specifier

From: Michael J Gruber <hidden>
Date: 2016-06-15 22:49:01

Possibly related (same subject, not in this thread)

Junio C Hamano venit, vidit, dixit 27.06.2010 21:29:
quoted hunk ↗ jump to hunk
Thanks, will replace v2 with this versoin, but I suspect that swapping the
two bullets in the existing documentation without anything else may be a
simpler and easier-to-read alternative.

Orthogonal to this, it would probably make sense to give a simplest
example in-line in the text, i.e.

 Documentation/git-rev-parse.txt |    6 +++---
 1 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt
index 8db600f..c03f31d 100644
--- a/Documentation/git-rev-parse.txt
+++ b/Documentation/git-rev-parse.txt
@@ -291,12 +291,12 @@ the `$GIT_DIR/refs` directory or from the `$GIT_DIR/packed-refs` file.
 
 * A suffix ':' followed by a path; this names the blob or tree
   at the given path in the tree-ish object named by the part
-  before the colon.
+  before the colon (e.g. "HEAD:README").
Yep, I think the whole discussion there is quite theoretical, often
describing symbols like slash and colon by words rather then writing
them out. That could be the topic for a more extensive rewrite. But I'm
often wondering whether git-rev-parse(1) really is the place for that,
or whether the whole revision syntax should into, say, gitrevision, to
go with gitglossary etc.

Michael
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help