From: Jonathan Nieder <jrnieder@uchicago.edu>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>,
Christian Couder <chriscool@tuxfamily.org>,
Jon Loeliger <jdl@jdl.com>
Subject: [RFC/PATCH 7/7] Documentation formatting and cleanup
Date: Mon, 30 Jun 2008 17:36:41 -0500 (CDT) [thread overview]
Message-ID: <Pine.GSO.4.62.0806301730230.7190@harper.uchicago.edu> (raw)
In-Reply-To: <Pine.GSO.4.62.0806301650530.7190@harper.uchicago.edu>
[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.
2) Should these changes be split up more?
Documentation/git-annotate.txt | 2 +-
Documentation/git-apply.txt | 12 ++--
Documentation/git-archimport.txt | 6 +-
Documentation/git-archive.txt | 6 +-
Documentation/git-bisect.txt | 8 +-
Documentation/git-blame.txt | 4 +-
Documentation/git-branch.txt | 8 +-
Documentation/git-bundle.txt | 27 +++---
Documentation/git-check-ref-format.txt | 2 +-
Documentation/git-checkout-index.txt | 2 +-
Documentation/git-checkout.txt | 4 +-
Documentation/git-cherry-pick.txt | 2 +-
Documentation/git-cherry.txt | 8 +-
Documentation/git-citool.txt | 4 +-
Documentation/git-clean.txt | 4 +-
Documentation/git-clone.txt | 12 ++--
Documentation/git-commit-tree.txt | 2 +-
Documentation/git-commit.txt | 20 +++---
Documentation/git-config.txt | 12 ++--
Documentation/git-cvsexportcommit.txt | 7 +-
Documentation/git-cvsimport.txt | 18 ++--
Documentation/git-cvsserver.txt | 43 +++++-----
Documentation/git-daemon.txt | 22 +++---
Documentation/git-describe.txt | 8 +-
Documentation/git-diff-files.txt | 2 +-
Documentation/git-diff-index.txt | 26 +++---
Documentation/git-diff-tree.txt | 10 +-
Documentation/git-fast-export.txt | 8 +-
Documentation/git-fast-import.txt | 16 ++--
Documentation/git-fetch-pack.txt | 16 ++--
Documentation/git-fetch.txt | 2 +-
Documentation/git-filter-branch.txt | 12 ++--
Documentation/git-fmt-merge-msg.txt | 4 +-
Documentation/git-format-patch.txt | 4 +-
Documentation/git-fsck.txt | 6 +-
Documentation/git-gc.txt | 10 +-
Documentation/git-get-tar-commit-id.txt | 6 +-
Documentation/git-grep.txt | 2 +-
Documentation/git-gui.txt | 24 +++---
Documentation/git-hash-object.txt | 2 +-
Documentation/git-help.txt | 6 +-
Documentation/git-http-fetch.txt | 2 +-
Documentation/git-imap-send.txt | 2 +-
Documentation/git-index-pack.txt | 8 +-
Documentation/git-instaweb.txt | 4 +-
Documentation/git-log.txt | 4 +-
Documentation/git-ls-files.txt | 8 +-
Documentation/git-ls-remote.txt | 2 +-
Documentation/git-mailinfo.txt | 4 +-
Documentation/git-merge-base.txt | 8 +-
Documentation/git-merge-file.txt | 10 +-
Documentation/git-merge-index.txt | 14 ++--
Documentation/git-merge-one-file.txt | 4 +-
Documentation/git-merge.txt | 14 ++--
Documentation/git-mergetool.txt | 2 +-
Documentation/git-name-rev.txt | 6 +-
Documentation/git-pack-objects.txt | 8 +-
Documentation/git-pack-redundant.txt | 4 +-
Documentation/git-patch-id.txt | 2 +-
Documentation/git-peek-remote.txt | 4 +-
Documentation/git-prune.txt | 10 +-
Documentation/git-pull.txt | 3 +-
Documentation/git-push.txt | 2 +-
Documentation/git-read-tree.txt | 14 ++--
Documentation/git-rebase.txt | 22 +++---
Documentation/git-receive-pack.txt | 16 ++--
Documentation/git-repack.txt | 11 ++-
Documentation/git-rerere.txt | 10 +-
Documentation/git-reset.txt | 2 +-
Documentation/git-rev-list.txt | 6 +-
Documentation/git-rev-parse.txt | 12 ++--
Documentation/git-rm.txt | 2 +-
Documentation/git-send-pack.txt | 14 ++--
Documentation/git-shell.txt | 2 +-
Documentation/git-shortlog.txt | 2 +-
Documentation/git-show-branch.txt | 4 +-
Documentation/git-show-index.txt | 4 +-
Documentation/git-show-ref.txt | 4 +-
Documentation/git-show.txt | 6 +-
Documentation/git-stash.txt | 12 ++--
Documentation/git-submodule.txt | 4 +-
Documentation/git-svn.txt | 133 +++++++++++++++----------------
Documentation/git-symbolic-ref.txt | 2 +-
Documentation/git-tag.txt | 8 +-
Documentation/git-tar-tree.txt | 4 +-
Documentation/git-unpack-objects.txt | 2 +-
Documentation/git-update-index.txt | 14 ++--
Documentation/git-upload-archive.txt | 2 +-
Documentation/git-upload-pack.txt | 6 +-
Documentation/git-verify-pack.txt | 4 +-
Documentation/git-verify-tag.txt | 2 +-
Documentation/git-web--browse.txt | 6 +-
Documentation/git-whatchanged.txt | 4 +-
Documentation/git.txt | 10 +-
Documentation/gitattributes.txt | 12 ++--
Documentation/gitcore-tutorial.txt | 18 ++--
Documentation/gitcvs-migration.txt | 4 +-
Documentation/gitdiffcore.txt | 34 ++++----
Documentation/gitignore.txt | 4 +-
Documentation/gitk.txt | 3 +-
Documentation/gitrepository-layout.txt | 2 +-
Documentation/gittutorial-2.txt | 28 +++---
Documentation/gittutorial.txt | 46 ++++++------
103 files changed, 510 insertions(+), 509 deletions(-)
See <http://home.uchicago.edu/~jrnieder/20080701-git-doc-style.txt>.
next prev parent reply other threads:[~2008-06-30 22:38 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 ` Jonathan Nieder [this message]
2008-07-01 13:09 ` [RFC/PATCH 7/7] Documentation formatting and cleanup 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.0806301730230.7190@harper.uchicago.edu \
--to=jrnieder@uchicago.edu \
--cc=chriscool@tuxfamily.org \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jdl@jdl.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).