git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Nieder <jrnieder@uchicago.edu>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>,
	Christian Couder <chriscool@tuxfamily.org>,
	Nguyen Thai Ngoc Duy <pclouds@gmail.com>,
	Jon Loeliger <jdl@jdl.com>,
	"J. Bruce Fields" <bfields@fieldses.org>
Subject: [PATCH 3/7] Documentation: complicate example of "man git-command"
Date: Mon, 30 Jun 2008 17:10:25 -0500 (CDT)	[thread overview]
Message-ID: <Pine.GSO.4.62.0806301706090.7190@harper.uchicago.edu> (raw)
In-Reply-To: <Pine.GSO.4.62.0806301650530.7190@harper.uchicago.edu>

The manual page for the command invoked as "git clone" is named
git-clone(1), and similarly for the rest of the git commands.
Make sure our first example of this in tutorials makes it clear
that it is the first two words of a command line that make up the
command's name (that is: for example, the effect of "git svn
dcommit" is described in git-svn(1)).

Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu>
---
	If I didn't make this change, consistency would mean
	saying "you can get documentation for a command such
	as `git-diff` with `man git-diff`", which might not be
	very enlightening.

 Documentation/gittutorial.txt |    4 ++--
 Documentation/user-manual.txt |    2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/gittutorial.txt b/Documentation/gittutorial.txt
index 3d16e3d..b833167 100644
--- a/Documentation/gittutorial.txt
+++ b/Documentation/gittutorial.txt
@@ -20,10 +20,10 @@ for example, to test the latest version, you may prefer to start with
 the first two chapters of link:user-manual.html[The Git User's Manual].
 
 First, note that you can get documentation for a command such as "git
-diff" with:
+log --graph" with:
 
 ------------------------------------------------
-$ man git-diff
+$ man git-log
 ------------------------------------------------
 
 It is a good idea to introduce yourself to git with your name and
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index ca4363f..36ab372 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -18,7 +18,7 @@ People needing to do actual development will also want to read
 Further chapters cover more specialized topics.
 
 Comprehensive reference documentation is available through the man
-pages.  For a command such as "git clone", just use
+pages.  For a command such as "git clone <repo>", just use
 
 ------------------------------------------------
 $ man git-clone
-- 
1.5.5.GIT

  parent reply	other threads:[~2008-06-30 22:12 UTC|newest]

Thread overview: 40+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-06-30 21:56 [PATCH 0/7] Some superficial documentation changes Jonathan Nieder
2008-06-30 22:01 ` [PATCH 1/7] Documentation: fix links to tutorials and other new manual pages Jonathan Nieder
2008-06-30 23:30   ` Christian Couder
2008-06-30 22:05 ` [PATCH 2/7] whitespace fix in Documentation/git-repack.txt Jonathan Nieder
2008-06-30 22:10 ` Jonathan Nieder [this message]
2008-06-30 23:39   ` [PATCH 3/7] Documentation: complicate example of "man git-command" Christian Couder
2008-07-01 16:23   ` J. Bruce Fields
2008-07-01 23:54     ` Junio C Hamano
2008-07-02 21:31       ` J. Bruce Fields
2008-07-03  1:45         ` Jonathan Nieder
2008-07-03 18:18           ` J. Bruce Fields
2008-07-03  6:06       ` Christian Couder
2008-07-03  7:44         ` Junio C Hamano
2008-06-30 22:15 ` [PATCH 4/7] git-daemon(1): don't assume git-daemon is in /usr/bin Jonathan Nieder
2008-06-30 22:17 ` [PATCH 5/7] Documentation: prepare to be consistent about "git-" versus "git " Jonathan Nieder
2008-06-30 22:29   ` [PATCH 6/7] Documentation: " Jonathan Nieder
2008-06-30 22:36 ` [RFC/PATCH 7/7] Documentation formatting and cleanup Jonathan Nieder
2008-07-01 13:09   ` Olivier Marin
2008-07-01 21:34     ` Junio C Hamano
2008-07-03  2:09       ` Jonathan Nieder
2008-07-03  2:28     ` Jonathan Nieder
2008-07-01  8:42 ` [PATCH 0/7] Some superficial documentation changes Junio C Hamano
2008-07-03  4:31   ` Jonathan Nieder
2008-07-03  4:47     ` [PATCH 01/15] git-format-patch(1): fix stray \ in output Jonathan Nieder
2008-07-03  4:54     ` [PATCH 02/15] Documentation: fix gitlinks Jonathan Nieder
2008-07-03  5:03     ` [PATCH 03/15] manpages: fix bogus whitespace Jonathan Nieder
2008-07-03 23:55       ` Junio C Hamano
2008-07-04  1:14         ` Jonathan Nieder
2008-07-03  5:08     ` [PATCH 04/15] git(1): add comma Jonathan Nieder
2008-07-03  5:13     ` [PATCH 05/15] git-commit(1): depersonalize description Jonathan Nieder
2008-07-03  5:20     ` [PATCH 06/15] Documentation: rewrap to prepare for "git-" vs "git " change Jonathan Nieder
2008-07-03  5:28     ` [PATCH 07/15] Documentation: more "git-" versus "git " changes Jonathan Nieder
2008-07-03  5:30     ` [PATCH 08/15] gitdiffcore(7): fix awkward wording Jonathan Nieder
2008-07-03  5:36     ` [PATCH 09/15] manpages: italicize command names in synopses Jonathan Nieder
2008-07-03  5:37     ` [PATCH 10/15] manpages: italicize command names Jonathan Nieder
2008-07-03  5:45     ` [PATCH 11/15] manpages: italicize git command names (which were in teletype font) Jonathan Nieder
2008-07-03  5:49     ` [PATCH 12/15] manpages: italicize gitk's name (where it was " Jonathan Nieder
2008-07-03  5:55     ` [PATCH 13/15] manpages: italicize nongit command names (if they are " Jonathan Nieder
2008-07-03  5:59     ` [PATCH 14/15] manpages: italicize git subcommand names (which were " Jonathan Nieder
2008-07-03  6:06     ` [PATCH 15/15] manpages: use teletype font for sample command lines Jonathan Nieder

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=Pine.GSO.4.62.0806301706090.7190@harper.uchicago.edu \
    --to=jrnieder@uchicago.edu \
    --cc=bfields@fieldses.org \
    --cc=chriscool@tuxfamily.org \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=jdl@jdl.com \
    --cc=pclouds@gmail.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).