{"thread":{"id":"14220","subject":"[RFC/PATCH] Documentation: be consistent about \"git-\" versus \"git \"","startedAt":"2008-06-30T07:30:12Z","lastAt":"2008-06-30T07:30:12Z","messageCount":1,"participants":["Jonathan Nieder"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"81725","messageId":"Pine.GSO.4.62.0806300223030.5848@harper.uchicago.edu","threadId":"14220","inReplyTo":null,"subject":"[RFC/PATCH] Documentation: be consistent about \"git-\" versus \"git \"","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-06-30T07:30:12Z","receivedAt":"2008-06-30T07:30:12Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"I guess this patch is too long (168 KB). You can find it at\n<http://home.uchicago.edu/~jrnieder/20080630-git-documentation-patch.txt>.\n\nIn a world where git-* are not in $(bindir), using \"git-command\n<parameters>\" in examples in the documentation is not a good\nidea. On the other hand, it is convenient for commands to be\nnamed with one word, not two, the manpages are still called\n\"git-command (1)\", and the user is not going to be able to escape\nseeing \"git-command\" in the \"wild\" from time to time anyway. What\nto do?\n\nThis patch keeps the dash when naming an operation, command,\nprogram, process, or action but tries to be dashless in all\ncomplete command lines ready to be entered at a shell (i.e.,\nwithout options omitted).\n\nThe changes consist mostly of adding and removing dashes\naccordingly. Other changes:\n\n * \"git clone\" has been replaced with \"git clone <repo>\" (rather\n   than \"git-clone\") in the example at the beginning of\n   user-manual.txt in an attempt to make the switching between\n   dashed and dashless commands a little less confusing.\n * git-merge-one-file has been replaced with $(git\n   --exec-path)/git-merge-one-file in two places\n * /usr/bin/git has been replaced with /usr/bin/git-daemon in the\n   sample inetd.conf lines in git-daemon(1).  The analogous\n   changes in git-cvsserver(1) have *not* been made.\n * Some whitespace changes (spaces changing into dashes\n   disallowed some line breaks; some sequences of spaces have been\n   changed into tabs in the same line as other changes)\n\nSigned-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n---\n\tI just realized that most of the rest of the man pages\n\t(aside from git-{sh-setup,parse-remote} (1)) are not ready\n\tfor the Git tools to move, either. Here's a start towards\n\tless confusing documentation for that situation.\n\n\tSorry for the enormous patch. Hope it gives someone some\n\tamusement. It is only an RFC because\n\n\t1) I am not sure whether the criterion for dashworthiness\n\t   I used is the right one. I tried to follow the lead of\n\t   good existing documentation, but there is no one\n\t   convention used throughout.\n\t2) I also want to make the formatting a bit more consistent\n\t   (always 'git-command' or always `git-command`) in\n\t   another patch if that is appropriate, while I am at it.\n\t   So I don't want this commited yet.\n\t3) I would be much more comfortable if I could run some\n\t   commands to quickly check that this patch only does\n\t   what I have claimed it does.\n\n\tThoughts? Suggestions?\n\n Documentation/git-add.txt                |    2 +-\n Documentation/git-am.txt                 |    4 +-\n Documentation/git-annotate.txt           |    2 +-\n Documentation/git-apply.txt              |    2 +-\n Documentation/git-archimport.txt         |    2 +-\n Documentation/git-archive.txt            |    2 +-\n Documentation/git-blame.txt              |    2 +-\n Documentation/git-branch.txt             |    8 +-\n Documentation/git-bundle.txt             |   14 ++--\n Documentation/git-cat-file.txt           |    4 +-\n Documentation/git-check-attr.txt         |    2 +-\n Documentation/git-check-ref-format.txt   |    4 +-\n Documentation/git-checkout-index.txt     |   20 +++---\n Documentation/git-checkout.txt           |    8 +-\n Documentation/git-cherry-pick.txt        |    2 +-\n Documentation/git-clean.txt              |    2 +-\n Documentation/git-clone.txt              |    2 +-\n Documentation/git-commit-tree.txt        |    2 +-\n Documentation/git-commit.txt             |    4 +-\n Documentation/git-config.txt             |   26 ++++----\n Documentation/git-count-objects.txt      |    4 +-\n Documentation/git-cvsexportcommit.txt    |    9 ++-\n Documentation/git-cvsimport.txt          |    4 +-\n Documentation/git-cvsserver.txt          |    2 +-\n Documentation/git-daemon.txt             |   10 ++--\n Documentation/git-describe.txt           |   10 ++--\n Documentation/git-diff-files.txt         |    2 +-\n Documentation/git-diff-index.txt         |   12 ++--\n Documentation/git-diff-tree.txt          |    8 +-\n Documentation/git-diff.txt               |   18 +++---\n Documentation/git-fast-import.txt        |    8 +-\n Documentation/git-fetch-pack.txt         |    2 +-\n Documentation/git-fetch.txt              |    4 +-\n Documentation/git-filter-branch.txt      |    4 +-\n Documentation/git-fmt-merge-msg.txt      |    4 +-\n Documentation/git-for-each-ref.txt       |    8 +-\n Documentation/git-format-patch.txt       |    2 +-\n Documentation/git-fsck-objects.txt       |    2 +-\n Documentation/git-fsck.txt               |    4 +-\n Documentation/git-gc.txt                 |    4 +-\n Documentation/git-get-tar-commit-id.txt  |    2 +-\n Documentation/git-grep.txt               |    2 +-\n Documentation/git-hash-object.txt        |    2 +-\n Documentation/git-http-fetch.txt         |    2 +-\n Documentation/git-http-push.txt          |    2 +-\n Documentation/git-imap-send.txt          |    4 +-\n Documentation/git-index-pack.txt         |    4 +-\n Documentation/git-init-db.txt            |    2 +-\n Documentation/git-init.txt               |    6 +-\n Documentation/git-instaweb.txt           |    4 +-\n Documentation/git-lost-found.txt         |    2 +-\n Documentation/git-ls-files.txt           |    2 +-\n Documentation/git-ls-remote.txt          |    2 +-\n Documentation/git-ls-tree.txt            |    2 +-\n Documentation/git-mailinfo.txt           |    6 +-\n Documentation/git-mailsplit.txt          |    2 +-\n Documentation/git-merge-base.txt         |    4 +-\n Documentation/git-merge-file.txt         |    4 +-\n Documentation/git-merge-index.txt        |    6 +-\n Documentation/git-merge-tree.txt         |    2 +-\n Documentation/git-merge.txt              |    8 +-\n Documentation/git-mergetool.txt          |   16 +++---\n Documentation/git-mktag.txt              |    2 +-\n Documentation/git-mv.txt                 |    6 +-\n Documentation/git-name-rev.txt           |    2 +-\n Documentation/git-pack-objects.txt       |    2 +-\n Documentation/git-pack-redundant.txt     |    4 +-\n Documentation/git-pack-refs.txt          |    8 +-\n Documentation/git-patch-id.txt           |    2 +-\n Documentation/git-peek-remote.txt        |    2 +-\n Documentation/git-prune-packed.txt       |    2 +-\n Documentation/git-prune.txt              |    2 +-\n Documentation/git-pull.txt               |    2 +-\n Documentation/git-push.txt               |    2 +-\n Documentation/git-quiltimport.txt        |    2 +-\n Documentation/git-read-tree.txt          |   32 +++++-----\n Documentation/git-rebase.txt             |   18 +++---\n Documentation/git-receive-pack.txt       |    6 +-\n Documentation/git-relink.txt             |    2 +-\n Documentation/git-remote.txt             |   12 ++--\n Documentation/git-repack.txt             |   10 ++--\n Documentation/git-repo-config.txt        |    2 +-\n Documentation/git-request-pull.txt       |    2 +-\n Documentation/git-rerere.txt             |    4 +-\n Documentation/git-rev-list.txt           |   10 ++--\n Documentation/git-rev-parse.txt          |    6 +-\n Documentation/git-revert.txt             |    2 +-\n Documentation/git-rm.txt                 |    6 +-\n Documentation/git-send-email.txt         |    2 +-\n Documentation/git-send-pack.txt          |    2 +-\n Documentation/git-shortlog.txt           |    6 +-\n Documentation/git-show-branch.txt        |    4 +-\n Documentation/git-show-index.txt         |    2 +-\n Documentation/git-show-ref.txt           |    6 +-\n Documentation/git-show.txt               |    2 +-\n Documentation/git-stash.txt              |   14 ++--\n Documentation/git-status.txt             |    6 +-\n Documentation/git-stripspace.txt         |    2 +-\n Documentation/git-submodule.txt          |   10 ++--\n Documentation/git-svn.txt                |   34 +++++-----\n Documentation/git-symbolic-ref.txt       |    2 +-\n Documentation/git-tag.txt                |   16 +++---\n Documentation/git-tar-tree.txt           |    2 +-\n Documentation/git-unpack-file.txt        |    2 +-\n Documentation/git-unpack-objects.txt     |    2 +-\n Documentation/git-update-index.txt       |   12 ++--\n Documentation/git-update-ref.txt         |   10 ++--\n Documentation/git-update-server-info.txt |    2 +-\n Documentation/git-upload-archive.txt     |    2 +-\n Documentation/git-upload-pack.txt        |    2 +-\n Documentation/git-var.txt                |    4 +-\n Documentation/git-verify-pack.txt        |    2 +-\n Documentation/git-verify-tag.txt         |    2 +-\n Documentation/git-web--browse.txt        |    2 +-\n Documentation/git-whatchanged.txt        |    6 +-\n Documentation/git-write-tree.txt         |    2 +-\n Documentation/gitattributes.txt          |   14 ++--\n Documentation/gitcore-tutorial.txt       |   94 +++++++++++++++---------------\n Documentation/gitcvs-migration.txt       |    8 +-\n Documentation/gitdiffcore.txt            |    2 +-\n Documentation/githooks.txt               |   10 ++--\n Documentation/gitignore.txt              |    4 +-\n Documentation/gitrepository-layout.txt   |   20 +++---\n Documentation/gittutorial-2.txt          |   18 +++---\n Documentation/gittutorial.txt            |   34 +++++-----\n Documentation/user-manual.txt            |   76 ++++++++++++------------\n 126 files changed, 456 insertions(+), 455 deletions(-)\n\nPatch at\n<http://home.uchicago.edu/~jrnieder/20080630-git-documentation-patch.txt>.\n"}]}