From: Olivier Marin <dkr+ml.git@free.fr>
To: Jonathan Nieder <jrnieder@uchicago.edu>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>,
Christian Couder <chriscool@tuxfamily.org>,
Jon Loeliger <jdl@jdl.com>
Subject: Re: [RFC/PATCH 7/7] Documentation formatting and cleanup
Date: Tue, 01 Jul 2008 15:09:32 +0200 [thread overview]
Message-ID: <486A2C8C.5050204@free.fr> (raw)
In-Reply-To: <Pine.GSO.4.62.0806301730230.7190@harper.uchicago.edu>
Jonathan Nieder a écrit :
> [184 KB patch online at
> <http://home.uchicago.edu/~jrnieder/20080701-git-doc-style.txt>]
>
> Following what appears to be the predominant style, format
> names of commands and commandlines both as `teletype text`.
>
> While we're at it, add articles ("a" and "the") in some
> places, italicize the name of the command in the manual page
> synopsis line, and add a comma or two where it seems appropriate.
>
> Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu>
>
> 1) I am using `teletype text` both for command names and
> for command lines. Probably I should be using italics
> for the command names.
You did a lot of:
> -replaced; you need to use a tool such as linkgit:git-diff[1] or the "pickaxe"
> +replaced; you need to use a tool such as `git-diff` or the "pickaxe"
Are those kind of changes really an improvement?
Also, in Documentation/gitdiffcore.txt, you did:
> -These are applied in sequence. The set of filepairs git-diff-\*
> +These are applied in sequence. The set of filepairs `git-diff-*`
but the file does not compile, now.
Olivier.
next prev parent reply other threads:[~2008-07-01 13:10 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 ` [PATCH 3/7] Documentation: complicate example of "man git-command" Jonathan Nieder
2008-06-30 23:39 ` 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 [this message]
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=486A2C8C.5050204@free.fr \
--to=dkr+ml.git@free.fr \
--cc=chriscool@tuxfamily.org \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jdl@jdl.com \
--cc=jrnieder@uchicago.edu \
/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).