From: Mark Lodato <lodatom@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: git list <git@vger.kernel.org>
Subject: Re: Meta-variable naming convention in documentation
Date: Fri, 26 Feb 2010 21:41:22 -0500 [thread overview]
Message-ID: <ca433831002261841i2b0edab6nf1a6e9170c3ba3c@mail.gmail.com> (raw)
In-Reply-To: <ca433831002261451k3164d413y77d4989239862f30@mail.gmail.com>
On a similar note, what do you think about dropping the term
<tree-ish> and just using <tree> everywhere? The only command that
only accepts a <tree>, and not a <tree-ish>, is git-commit-tree. For
example, `git commit-tree master' fails, but `git commit-tree
master^{tree}' works. This can easily be written in the
documentation, or the program can be fixed so it also accepts a
<tree-ish> like everything else. (git-grep(1) uses the term <tree>,
but this should be <tree-ish>.)
I imagine a similar thing can be done with <commit> vs <commit-ish> vs
<committish>, but I haven't verified this. <commit-ish> is only used
in git(1) and builtin-revert.c, and <committish> is only used in
git-describe(1), git-fast-import(1), git-name-rev(1), git-shortlog(1),
gitcli(1), and builtin-describe.c. I would guess that all the other
commands that say <commit> really accept a <commit-ish>, but perhaps
this is not true.
I also think <rev> should be replaced with <commit>, unless this means
something different.
If you give the go-ahead, I'll work on a patch to do this.
Cheers,
Mark
prev parent reply other threads:[~2010-02-27 2:41 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-02-26 4:55 Meta-variable naming convention in documentation Mark Lodato
2010-02-26 5:42 ` Junio C Hamano
2010-02-26 22:51 ` Mark Lodato
2010-02-27 2:41 ` Mark Lodato [this message]
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=ca433831002261841i2b0edab6nf1a6e9170c3ba3c@mail.gmail.com \
--to=lodatom@gmail.com \
--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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).