git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 6/7] Documentation: be consistent about "git-" versus "git "

From
Jonathan Nieder <jrnieder@uchicago.edu>
Date
Jun 30, 2008, 22:29 UTC
Message-ID
<Pine.GSO.4.62.0806301717320.7190@harper.uchicago.edu>
In-Reply-To
<Pine.GSO.4.62.0806301716150.7190@harper.uchicago.edu>
[Patch at <http://home.uchicago.edu/~jrnieder/20080701-git-doc-hyphens.txt>]

Since the git-* commands are not installed in $(bindir), using "git-command <parameters>" in examples in the documentation is not a good idea. On the other hand, it is nice to be able to refer to each command using one hyphenated word. (There is no escaping it, anyway: man page names cannot have spaces in them.)

This patch retains the dash in naming an operation, command, program, process, or action. Complete command lines that can be entered at a shell (i.e., without options omitted) are made to use the dashless form.

The changes consist only of replacing some spaces with hyphens and vice versa. After a "s/ /-/g", the unpatched and patched versions are identical.

Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu>
 Documentation/git-add.txt                |    2 +-
 Documentation/git-am.txt                 |    4 +-
 Documentation/git-annotate.txt           |    2 +-
 Documentation/git-apply.txt              |    2 +-
 Documentation/git-archimport.txt         |    2 +-
 Documentation/git-archive.txt            |    2 +-
 Documentation/git-bisect.txt             |    2 +-
 Documentation/git-blame.txt              |    2 +-
 Documentation/git-branch.txt             |    8 +-
 Documentation/git-bundle.txt             |   14 ++--
 Documentation/git-cat-file.txt           |    4 +-
 Documentation/git-check-attr.txt         |    2 +-
 Documentation/git-check-ref-format.txt   |    4 +-
 Documentation/git-checkout-index.txt     |   20 +++---
 Documentation/git-checkout.txt           |    8 +-
 Documentation/git-cherry-pick.txt        |    2 +-
 Documentation/git-cherry.txt             |    2 +-
 Documentation/git-clean.txt              |    2 +-
 Documentation/git-clone.txt              |    2 +-
 Documentation/git-commit-tree.txt        |    2 +-
 Documentation/git-commit.txt             |    4 +-
 Documentation/git-config.txt             |   26 ++++----
 Documentation/git-count-objects.txt      |    4 +-
 Documentation/git-cvsexportcommit.txt    |    8 +-
 Documentation/git-cvsimport.txt          |    4 +-
 Documentation/git-cvsserver.txt          |    2 +-
 Documentation/git-daemon.txt             |    2 +-
 Documentation/git-describe.txt           |   10 ++--
 Documentation/git-diff-files.txt         |    2 +-
 Documentation/git-diff-index.txt         |   12 ++--
 Documentation/git-diff-tree.txt          |    8 +-
 Documentation/git-diff.txt               |   18 +++---
 Documentation/git-fast-export.txt        |    2 +-
 Documentation/git-fast-import.txt        |    8 +-
 Documentation/git-fetch-pack.txt         |    2 +-
 Documentation/git-fetch.txt              |    4 +-
 Documentation/git-filter-branch.txt      |    4 +-
 Documentation/git-fmt-merge-msg.txt      |    4 +-
 Documentation/git-for-each-ref.txt       |    8 +-
 Documentation/git-format-patch.txt       |    2 +-
 Documentation/git-fsck-objects.txt       |    2 +-
 Documentation/git-fsck.txt               |    4 +-
 Documentation/git-gc.txt                 |    6 +-
 Documentation/git-get-tar-commit-id.txt  |    2 +-
 Documentation/git-grep.txt               |    2 +-
 Documentation/git-hash-object.txt        |    2 +-
 Documentation/git-http-fetch.txt         |    2 +-
 Documentation/git-http-push.txt          |    2 +-
 Documentation/git-imap-send.txt          |    4 +-
 Documentation/git-index-pack.txt         |    4 +-
 Documentation/git-init-db.txt            |    2 +-
 Documentation/git-init.txt               |    6 +-
 Documentation/git-instaweb.txt           |    4 +-
 Documentation/git-log.txt                |    2 +-
 Documentation/git-lost-found.txt         |    2 +-
 Documentation/git-ls-files.txt           |    2 +-
 Documentation/git-ls-remote.txt          |    2 +-
 Documentation/git-ls-tree.txt            |    2 +-
 Documentation/git-mailinfo.txt           |    4 +-
 Documentation/git-mailsplit.txt          |    2 +-
 Documentation/git-merge-base.txt         |    4 +-
 Documentation/git-merge-file.txt         |    4 +-
 Documentation/git-merge-index.txt        |    6 +-
 Documentation/git-merge-tree.txt         |    2 +-
 Documentation/git-merge.txt              |   10 ++--
 Documentation/git-mergetool.txt          |   16 +++---
 Documentation/git-mktag.txt              |    2 +-
 Documentation/git-mktree.txt             |    2 +-
 Documentation/git-mv.txt                 |    6 +-
 Documentation/git-name-rev.txt           |    2 +-
 Documentation/git-pack-objects.txt       |    2 +-
 Documentation/git-pack-redundant.txt     |    6 +-
 Documentation/git-pack-refs.txt          |    4 +-
 Documentation/git-patch-id.txt           |    2 +-
 Documentation/git-peek-remote.txt        |    2 +-
 Documentation/git-prune-packed.txt       |    2 +-
 Documentation/git-prune.txt              |    4 +-
 Documentation/git-pull.txt               |    2 +-
 Documentation/git-push.txt               |    2 +-
 Documentation/git-quiltimport.txt        |    2 +-
 Documentation/git-read-tree.txt          |   32 +++++-----
 Documentation/git-rebase.txt             |   20 +++---
 Documentation/git-receive-pack.txt       |   10 ++--
 Documentation/git-relink.txt             |    2 +-
 Documentation/git-remote.txt             |   12 ++--
 Documentation/git-repack.txt             |   10 ++--
 Documentation/git-repo-config.txt        |    2 +-
 Documentation/git-request-pull.txt       |    2 +-
 Documentation/git-rerere.txt             |    4 +-
 Documentation/git-rev-list.txt           |   10 ++--
 Documentation/git-rev-parse.txt          |    6 +-
 Documentation/git-revert.txt             |    2 +-
 Documentation/git-rm.txt                 |    8 +-
 Documentation/git-send-email.txt         |    2 +-
 Documentation/git-send-pack.txt          |    2 +-
 Documentation/git-shortlog.txt           |    6 +-
 Documentation/git-show-branch.txt        |    4 +-
 Documentation/git-show-index.txt         |    2 +-
 Documentation/git-show-ref.txt           |    6 +-
 Documentation/git-show.txt               |    2 +-
 Documentation/git-stash.txt              |   12 ++--
 Documentation/git-status.txt             |    6 +-
 Documentation/git-stripspace.txt         |    2 +-
 Documentation/git-submodule.txt          |   10 ++--
 Documentation/git-svn.txt                |   34 +++++-----
 Documentation/git-symbolic-ref.txt       |    2 +-
 Documentation/git-tag.txt                |   14 ++--
 Documentation/git-tar-tree.txt           |    2 +-
 Documentation/git-unpack-file.txt        |    2 +-
 Documentation/git-unpack-objects.txt     |    2 +-
 Documentation/git-update-index.txt       |   12 ++--
 Documentation/git-update-ref.txt         |   10 ++--
 Documentation/git-update-server-info.txt |    2 +-
 Documentation/git-upload-archive.txt     |    2 +-
 Documentation/git-upload-pack.txt        |    2 +-
 Documentation/git-var.txt                |    4 +-
 Documentation/git-verify-pack.txt        |    2 +-
 Documentation/git-verify-tag.txt         |    2 +-
 Documentation/git-web--browse.txt        |    6 +-
 Documentation/git-whatchanged.txt        |    6 +-
 Documentation/git-write-tree.txt         |    2 +-
 Documentation/gitattributes.txt          |   14 ++--
 Documentation/gitcore-tutorial.txt       |  102 +++++++++++++++---------------
 Documentation/gitcvs-migration.txt       |    8 +-
 Documentation/gitdiffcore.txt            |    2 +-
 Documentation/githooks.txt               |   10 ++--
 Documentation/gitignore.txt              |    4 +-
 Documentation/gitrepository-layout.txt   |   18 +++---
 Documentation/gittutorial-2.txt          |   18 +++---
 Documentation/gittutorial.txt            |   30 +++++-----
 Documentation/user-manual.txt            |   76 +++++++++++-----------
 131 files changed, 462 insertions(+), 462 deletions(-)

Because it is long, I haven't sent the patch. You can find it at <http://home.uchicago.edu/~jrnieder/20080701-git-doc-hyphens.txt>.

Previous: Jonathan NiederNext: Jonathan Nieder
Message 16 of 40 in “Some superficial documentation changes”
  1. 0/7 Some superficial documentation changesJonathan Nieder, Jun 30, 2008
  2. 1/7 Documentation: fix links to tutorials and other new manual pagesJonathan Nieder, Jun 30, 2008
  3. Christian CouderJun 30, 2008
  4. 2/7 whitespace fix in Documentation/git-repack.txtJonathan Nieder, Jun 30, 2008
  5. 3/7 Documentation: complicate example of "man git-command"Jonathan Nieder, Jun 30, 2008
  6. Christian CouderJun 30, 2008
  7. J. Bruce FieldsJul 1, 2008
  8. Junio C HamanoJul 1, 2008
  9. J. Bruce FieldsJul 2, 2008
  10. Jonathan NiederJul 3, 2008
  11. J. Bruce FieldsJul 3, 2008
  12. Christian CouderJul 3, 2008
  13. Junio C HamanoJul 3, 2008
  14. 4/7 git-daemon(1): don't assume git-daemon is in /usr/binJonathan Nieder, Jun 30, 2008
  15. 5/7 Documentation: prepare to be consistent about "git-" versus "git "Jonathan Nieder, Jun 30, 2008
  16. 6/7 Documentation: be consistent about "git-" versus "git "Jonathan Nieder, Jun 30, 2008
  17. 7/7 Documentation formatting and cleanupJonathan Nieder, Jun 30, 2008
  18. Olivier MarinJul 1, 2008
  19. Junio C HamanoJul 1, 2008
  20. Jonathan NiederJul 3, 2008
  21. Jonathan NiederJul 3, 2008
  22. Junio C HamanoJul 1, 2008
  23. Jonathan NiederJul 3, 2008
  24. 01/15 git-format-patch(1): fix stray \ in outputJonathan Nieder, Jul 3, 2008
  25. 02/15 Documentation: fix gitlinksJonathan Nieder, Jul 3, 2008
  26. 03/15 manpages: fix bogus whitespaceJonathan Nieder, Jul 3, 2008
  27. Junio C HamanoJul 3, 2008
  28. Jonathan NiederJul 4, 2008
  29. 04/15 git(1): add commaJonathan Nieder, Jul 3, 2008
  30. 05/15 git-commit(1): depersonalize descriptionJonathan Nieder, Jul 3, 2008
  31. 06/15 Documentation: rewrap to prepare for "git-" vs "git " changeJonathan Nieder, Jul 3, 2008
  32. 07/15 Documentation: more "git-" versus "git " changesJonathan Nieder, Jul 3, 2008
  33. 08/15 gitdiffcore(7): fix awkward wordingJonathan Nieder, Jul 3, 2008
  34. 09/15 manpages: italicize command names in synopsesJonathan Nieder, Jul 3, 2008
  35. 10/15 manpages: italicize command namesJonathan Nieder, Jul 3, 2008
  36. 11/15 manpages: italicize git command names (which were in teletype font)Jonathan Nieder, Jul 3, 2008
  37. 12/15 manpages: italicize gitk's name (where it was in teletype font)Jonathan Nieder, Jul 3, 2008
  38. 13/15 manpages: italicize nongit command names (if they are in teletype font)Jonathan Nieder, Jul 3, 2008
  39. 14/15 manpages: italicize git subcommand names (which were in teletype font)Jonathan Nieder, Jul 3, 2008
  40. 15/15 manpages: use teletype font for sample command linesJonathan Nieder, Jul 3, 2008

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.