Re: [PATCH 0/7] Some superficial documentation changes
- From
Jonathan Nieder <jrnieder@uchicago.edu>
- Date
- Jul 3, 2008, 04:31 UTC
- Message-ID
- <Pine.GSO.4.62.0807022322380.16085@harper.uchicago.edu>
- In-Reply-To
- <7viqvqov01.fsf@gitster.siamese.dyndns.org>
On Tue, 1 Jul 2008, Junio C Hamano wrote:
Show 12 quoted lines
> In general, I've always preferred to see command names "git-foo" typeset > in teletype face, consistent with examples (also typeset in tt), because > they are both something the end users are expected to type. With this > transition, we are however making "git-foo" not something users are > expected to type, which means that the use of a typeface that is different > from the body text to spell command names is now strictly for making them > stand out in context. > > [...] If you > also prefer 'italics' and list agrees, it might be a better idea to also > apply that patch when I do so, as that step is the most error prone one > and benefits from more eyeballs.
I am not sure whether the list agrees, but I do prefer italics. I haven't finished making the user manual use italics yet, but here are some patches to make the man pages do so. I also included some formatting fixes irrelevant to that purpose to problems I found along the way.
I was surprised to get so much feedback with the patches I sent earlier this week. Thanks! I hope you find as much interesting in this series. The bulk of the changes are in patch 11, which only replaces backticks with apostrophes.
Jonathan
git-format-patch(1): fix stray \ in output Documentation: fix gitlinks manpages: fix bogus whitespace git(1): add comma git-add(1): depersonalize description Documentation: rewrap to prepare for "git-" vs "git " change Documentation: more "git-" versus "git " changes gitdiffcore(7): fix awkward wording manpages: italicize command names in synopses manpages: italicize names of commands manpages: italicize git command names (which were in teletype font) manpages: italicize gitk's name (where it was in teletype font) manpages: italicize nongit command names (which were in teletype font) manpages: italicize git subcommand names (which were in teletype font) manpages: use teletype font for sample command lines
Documentation/config.txt | 70 ++++++------ Documentation/fetch-options.txt | 8 +- Documentation/git-am.txt | 14 +- Documentation/git-apply.txt | 18 ++-- Documentation/git-archimport.txt | 12 +- Documentation/git-archive.txt | 6 +- Documentation/git-bisect.txt | 8 +- Documentation/git-blame.txt | 8 +- Documentation/git-branch.txt | 8 +- Documentation/git-bundle.txt | 26 ++-- Documentation/git-check-ref-format.txt | 2 +- Documentation/git-checkout-index.txt | 8 +- Documentation/git-checkout.txt | 4 +- Documentation/git-cherry-pick.txt | 2 +- Documentation/git-cherry.txt | 6 +- Documentation/git-citool.txt | 4 +- Documentation/git-clean.txt | 4 +- Documentation/git-clone.txt | 6 +- Documentation/git-commit-tree.txt | 2 +- Documentation/git-commit.txt | 26 ++-- Documentation/git-config.txt | 12 +- Documentation/git-cvsexportcommit.txt | 2 +- Documentation/git-cvsimport.txt | 18 ++-- Documentation/git-cvsserver.txt | 40 ++++---- Documentation/git-daemon.txt | 40 ++++---- Documentation/git-describe.txt | 6 +- Documentation/git-diff-files.txt | 2 +- Documentation/git-diff-index.txt | 20 ++-- Documentation/git-diff-tree.txt | 10 +- Documentation/git-fast-export.txt | 8 +- Documentation/git-fast-import.txt | 22 ++-- Documentation/git-fetch-pack.txt | 14 +- Documentation/git-fetch.txt | 2 +- Documentation/git-filter-branch.txt | 14 +- Documentation/git-fmt-merge-msg.txt | 4 +- Documentation/git-for-each-ref.txt | 2 +- Documentation/git-format-patch.txt | 18 ++-- Documentation/git-fsck.txt | 6 +- Documentation/git-gc.txt | 20 ++-- Documentation/git-get-tar-commit-id.txt | 6 +- Documentation/git-grep.txt | 2 +- Documentation/git-gui.txt | 28 +++--- Documentation/git-hash-object.txt | 2 +- Documentation/git-help.txt | 10 +- Documentation/git-http-fetch.txt | 2 +- Documentation/git-imap-send.txt | 2 +- Documentation/git-index-pack.txt | 8 +- Documentation/git-init.txt | 6 +- Documentation/git-instaweb.txt | 2 +- Documentation/git-log.txt | 4 +- Documentation/git-ls-files.txt | 6 +- Documentation/git-ls-remote.txt | 2 +- Documentation/git-mailinfo.txt | 4 +- Documentation/git-merge-base.txt | 4 +- Documentation/git-merge-file.txt | 14 +- Documentation/git-merge-index.txt | 14 +- Documentation/git-merge-one-file.txt | 4 +- Documentation/git-merge.txt | 16 ++-- Documentation/git-mergetool.txt | 16 ++-- Documentation/git-name-rev.txt | 6 +- Documentation/git-pack-objects.txt | 6 +- Documentation/git-pack-redundant.txt | 2 +- Documentation/git-parse-remote.txt | 2 +- Documentation/git-patch-id.txt | 2 +- Documentation/git-peek-remote.txt | 6 +- Documentation/git-prune.txt | 14 +- Documentation/git-pull.txt | 10 +- Documentation/git-push.txt | 4 +- Documentation/git-read-tree.txt | 42 ++++---- Documentation/git-rebase.txt | 30 +++--- Documentation/git-receive-pack.txt | 12 +- Documentation/git-reflog.txt | 16 ++-- Documentation/git-remote.txt | 12 +- Documentation/git-repack.txt | 16 ++-- Documentation/git-rerere.txt | 34 +++--- Documentation/git-reset.txt | 2 +- Documentation/git-rev-list.txt | 6 +- Documentation/git-rev-parse.txt | 24 ++-- Documentation/git-revert.txt | 4 +- Documentation/git-rm.txt | 4 +- Documentation/git-send-pack.txt | 10 +- Documentation/git-sh-setup.txt | 2 +- Documentation/git-shell.txt | 2 +- Documentation/git-shortlog.txt | 4 +- Documentation/git-show-branch.txt | 2 +- Documentation/git-show-index.txt | 4 +- Documentation/git-show-ref.txt | 4 +- Documentation/git-show.txt | 6 +- Documentation/git-stash.txt | 6 +- Documentation/git-status.txt | 6 +- Documentation/git-submodule.txt | 4 +- Documentation/git-svn.txt | 106 +++++++++--------- Documentation/git-symbolic-ref.txt | 2 +- Documentation/git-tag.txt | 8 +- Documentation/git-tar-tree.txt | 6 +- Documentation/git-update-index.txt | 22 ++-- Documentation/git-upload-archive.txt | 2 +- Documentation/git-upload-pack.txt | 6 +- Documentation/git-var.txt | 2 +- Documentation/git-verify-pack.txt | 2 +- Documentation/git-verify-tag.txt | 2 +- Documentation/git-web--browse.txt | 6 +- Documentation/git-whatchanged.txt | 4 +- Documentation/git-write-tree.txt | 8 +- Documentation/git.txt | 16 ++-- Documentation/gitattributes.txt | 22 ++-- Documentation/gitcore-tutorial.txt | 188 +++++++++++++++--------------- Documentation/gitcvs-migration.txt | 18 ++-- Documentation/gitdiffcore.txt | 38 +++--- Documentation/githooks.txt | 74 ++++++------ Documentation/gitignore.txt | 4 +- Documentation/gitk.txt | 2 +- Documentation/gitrepository-layout.txt | 18 ++-- Documentation/gittutorial-2.txt | 16 ++-- Documentation/gittutorial.txt | 79 +++++++++----- Documentation/i18n.txt | 4 +- Documentation/merge-options.txt | 4 +- Documentation/pull-fetch-param.txt | 8 +- Documentation/urls-remotes.txt | 4 +- Documentation/user-manual.txt | 42 ++++---- 120 files changed, 848 insertions(+), 823 deletions(-)