All of lore.kernel.org
 help / color / mirror / Atom feed
From: Michael J Gruber <git@drmicha.warpmail.net>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org, Matthieu Moy <Matthieu.Moy@imag.fr>
Subject: Re: [PATCHv3] git-rev-parse.txt: Document ":path" specifier
Date: Sun, 27 Jun 2010 21:41:54 +0200	[thread overview]
Message-ID: <4C27A982.9080006@drmicha.warpmail.net> (raw)
In-Reply-To: <7vocewff4b.fsf@alter.siamese.dyndns.org>

Junio C Hamano venit, vidit, dixit 27.06.2010 21:29:
> 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

  reply	other threads:[~2010-06-27 19:41 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-06-24 10:14 [PATCH] git-cat-file.txt: Document --textconv Michael J Gruber
2010-06-24 11:53 ` Matthieu Moy
2010-06-24 12:56   ` Michael J Gruber
2010-06-24 12:56     ` [PATCHv2] " Michael J Gruber
2010-06-24 13:54       ` Matthieu Moy
2010-06-24 20:10       ` Junio C Hamano
2010-06-24 13:02     ` [PATCH] git-rev-parse.txt: Document ":path" specifier Michael J Gruber
2010-06-24 20:47       ` Junio C Hamano
2010-06-25 14:32         ` [PATCHv2] " Michael J Gruber
2010-06-25 15:25           ` Matthieu Moy
2010-06-25 17:52             ` Junio C Hamano
2010-06-27 13:15               ` [PATCHv3] " Michael J Gruber
2010-06-27 19:29                 ` Junio C Hamano
2010-06-27 19:41                   ` Michael J Gruber [this message]
2010-06-28  6:22                   ` Matthieu Moy
2010-06-28  8:18                   ` [PATCH] git-rev-parse.txt: Add more examples for caret and colon Michael J Gruber
2010-06-28 10:03                     ` Peter Kjellerstedt
2010-06-28 10:27                       ` Michael J Gruber
2010-06-28 19:01                         ` [PATCHv2] " Michael J Gruber
2010-06-25 15:53           ` [PATCHv2] git-rev-parse.txt: Document ":path" specifier Junio C Hamano
2010-06-24 20:09     ` [PATCH] git-cat-file.txt: Document --textconv Junio C Hamano
2010-06-25  9:04       ` Michael J Gruber

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4C27A982.9080006@drmicha.warpmail.net \
    --to=git@drmicha.warpmail.net \
    --cc=Matthieu.Moy@imag.fr \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.