From: Mark Lodato <lodatom@gmail.com>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>, Mark Lodato <lodatom@gmail.com>
Subject: [PATCHv2 0/8] docs: use metavariables consistently
Date: Sat, 18 Dec 2010 00:38:37 -0500 [thread overview]
Message-ID: <1292650725-21149-1-git-send-email-lodatom@gmail.com> (raw)
Update the documentation and usage statements to use metavariables, such as
<commit>, more consistently. The biggest change is to drop the <tree-ish> and
<commit-ish> (or <committish>) notation and just use <tree> or <commit>, since
every command but commit-tree accepts tree-ishes and commit-ishes. The "-ish"
terms are still kept around in various places where it makes sense to
differentiate between an actual tree or commit and a tree-ish or commit-ish.
This is a rework of my earlier patch set from March [1], with the following
differences:
- Drop the patch to commit-tree that makes it accept a tree-ish.
- Drop the patch dealing with <tag> and <tagname>.
- Leave -ish terms in comments and in places where they make sense.
- Rebase onto master (1b97434). Some of the patches from before have since
been accepted from other authors.
- Fix a problem that Junio noticed with the "grep docs" patch.
[1] http://kerneltrap.org/mailarchive/git/2010/3/13/25484
Mark Lodato (8):
fsck docs: remove outdated and useless diagnostic
docs: use `...' instead of `*' for multiplicity
docs: use <sha1> to mean unabbreviated ID
http-fetch docs: use <commit-id> consistently
grep docs: grep accepts a <tree-ish>, not a <tree>
docs: use <tree> instead of <tree-ish>
docs: use <commit> instead of <commit-ish>
describe docs: note that <commit> is optional
Documentation/RelNotes/1.6.2.4.txt | 2 +-
Documentation/diff-format.txt | 10 +++++-----
Documentation/diff-generate-patch.txt | 2 +-
Documentation/git-archive.txt | 4 ++--
Documentation/git-cat-file.txt | 2 +-
Documentation/git-checkout.txt | 16 ++++++++--------
Documentation/git-commit-tree.txt | 3 ++-
Documentation/git-describe.txt | 15 ++++++++-------
Documentation/git-diff-index.txt | 4 ++--
Documentation/git-diff-tree.txt | 18 +++++++++---------
Documentation/git-fast-import.txt | 22 +++++++++++-----------
Documentation/git-fsck.txt | 5 +----
Documentation/git-http-fetch.txt | 4 ++--
Documentation/git-ls-files.txt | 6 +++---
Documentation/git-ls-tree.txt | 6 +++---
Documentation/git-merge-index.txt | 2 +-
Documentation/git-merge-tree.txt | 2 +-
Documentation/git-name-rev.txt | 2 +-
Documentation/git-read-tree.txt | 10 +++++-----
Documentation/git-rebase.txt | 2 +-
Documentation/git-svn.txt | 6 +++---
Documentation/git-tar-tree.txt | 4 ++--
Documentation/git.txt | 27 +++++++++++++--------------
Documentation/gitcli.txt | 6 +++---
Documentation/gittutorial-2.txt | 6 ++----
Documentation/glossary-content.txt | 4 ++++
archive.c | 4 ++--
builtin/commit-tree.c | 2 +-
builtin/describe.c | 4 ++--
builtin/diff-index.c | 2 +-
builtin/diff-tree.c | 2 +-
builtin/ls-files.c | 4 ++--
builtin/ls-tree.c | 2 +-
builtin/merge-index.c | 2 +-
builtin/read-tree.c | 2 +-
builtin/revert.c | 4 ++--
builtin/tar-tree.c | 2 +-
contrib/examples/git-reset.sh | 2 +-
contrib/examples/git-revert.sh | 4 ++--
git-svn.perl | 6 +++---
t/t4100/t-apply-3.patch | 8 ++++----
t/t4100/t-apply-7.patch | 8 ++++----
42 files changed, 124 insertions(+), 124 deletions(-)
--
1.7.3.2
next reply other threads:[~2010-12-18 5:39 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-12-18 5:38 Mark Lodato [this message]
2010-12-18 5:38 ` [PATCH 1/8] fsck docs: remove outdated and useless diagnostic Mark Lodato
2010-12-18 5:38 ` [PATCH 2/8] docs: use `...' instead of `*' for multiplicity Mark Lodato
2010-12-18 10:00 ` Jakub Narebski
2010-12-18 16:32 ` Mark Lodato
2010-12-18 5:38 ` [PATCH 3/8] docs: use <sha1> to mean unabbreviated ID Mark Lodato
2010-12-18 7:47 ` Jonathan Nieder
2010-12-18 18:50 ` Junio C Hamano
2010-12-18 5:38 ` [PATCH 4/8] http-fetch docs: use <commit-id> consistently Mark Lodato
2010-12-18 7:51 ` Jonathan Nieder
2010-12-18 5:38 ` [PATCH 5/8] grep docs: grep accepts a <tree-ish>, not a <tree> Mark Lodato
2010-12-18 5:38 ` [PATCH 6/8] docs: use <tree> instead of <tree-ish> Mark Lodato
2010-12-18 8:35 ` Jonathan Nieder
2010-12-18 5:38 ` [PATCH 7/8] docs: use <commit> instead of <commit-ish> Mark Lodato
2010-12-18 8:39 ` Jonathan Nieder
2010-12-18 5:38 ` [PATCH 8/8] describe docs: note that <commit> is optional Mark Lodato
2010-12-18 8:49 ` [PATCHv2 0/8] docs: use metavariables consistently Jonathan Nieder
2010-12-18 16:45 ` Mark Lodato
2010-12-18 20:27 ` Junio C Hamano
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=1292650725-21149-1-git-send-email-lodatom@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).