{"thread":{"id":"14232","subject":"[PATCH 0/7] Some superficial documentation changes","startedAt":"2008-06-30T21:56:56Z","lastAt":"2008-07-04T01:14:20Z","messageCount":40,"participants":["Jonathan Nieder","Christian Couder","Junio C Hamano","Olivier Marin","J. Bruce Fields"],"isPatch":true,"patchVersion":1,"patchTotal":7},"messages":[{"id":"81778","messageId":"Pine.GSO.4.62.0806301650530.7190@harper.uchicago.edu","threadId":"14232","inReplyTo":null,"subject":"[PATCH 0/7] Some superficial documentation changes","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-06-30T21:56:56Z","receivedAt":"2008-06-30T21:56:56Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"This patch series is an updated version of a patch I sent this morning.\nThe purpose of the patches is to make the absence of git- commands not\nso jarring while reading the manual.  It does this by holding fast to a\ndistinction between programs (like git-clone) and command lines (like\n\"git clone <repo>\").\n\nIssues:\n\n - It is a huge patch touching most of the manpages, not made by any\n   automated process\n\n - Sometimes it is not clear whether a mention of git-diff, say, is\n   referring to the `git-diff` program or the command line `git diff`\n   (without any options). So we guess.\n\n - Most non-git man pages use 'italics' for the names of programs, but I\n   stuck to `teletype text` because that is what seems to be most common\n   in the Git docs. If people want to change this, I can send a separate\n   patch to that end.\n\n - There are not enough cross-references (the \"see also\" sections are\n   too often absent).\n\nBut at least I was able to check that patch 6/7 (which redistributes the\ndashes in the world) doesn't touch anything but spaces and hyphens.\nHopefully that should make this easier to review.\n\nEnjoy...\n\n  Documentation: fix links to tutorials and other new manual pages\n  whitespace fix in Documentation/git-repack.txt\n  Documentation: complicate example of \"man git-blah\"\n  git-daemon(1): don't assume git-daemon in /usr/bin\n  Documentation: prepare to be consistent about \"git-\" versus \"git \"\n  Documentation: be consistent about \"git-\" versus \"git \"\n  Documentation formatting and cleanup\n\n Documentation/diff-options.txt           |    2 +-\n Documentation/git-add.txt                |    4 +-\n Documentation/git-am.txt                 |    4 +-\n Documentation/git-annotate.txt           |    2 +-\n Documentation/git-apply.txt              |   14 ++--\n Documentation/git-archimport.txt         |    8 +-\n Documentation/git-archive.txt            |    8 +-\n Documentation/git-bisect.txt             |    8 +-\n Documentation/git-blame.txt              |    6 +-\n Documentation/git-branch.txt             |   16 ++--\n Documentation/git-bundle.txt             |   41 ++++----\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     |   22 ++--\n Documentation/git-checkout.txt           |   12 +-\n Documentation/git-cherry-pick.txt        |    4 +-\n Documentation/git-cherry.txt             |   10 +-\n Documentation/git-citool.txt             |    4 +-\n Documentation/git-clean.txt              |    6 +-\n Documentation/git-clone.txt              |   14 ++--\n Documentation/git-commit-tree.txt        |    4 +-\n Documentation/git-commit.txt             |   28 +++---\n Documentation/git-config.txt             |   38 ++++----\n Documentation/git-count-objects.txt      |    4 +-\n Documentation/git-cvsexportcommit.txt    |   13 ++-\n Documentation/git-cvsimport.txt          |   20 ++--\n Documentation/git-cvsserver.txt          |   45 +++++-----\n Documentation/git-daemon.txt             |   34 ++++----\n Documentation/git-describe.txt           |   14 ++--\n Documentation/git-diff-files.txt         |    4 +-\n Documentation/git-diff-index.txt         |   34 ++++----\n Documentation/git-diff-tree.txt          |   18 ++--\n Documentation/git-diff.txt               |   18 ++--\n Documentation/git-fast-export.txt        |   10 +-\n Documentation/git-fast-import.txt        |   24 +++---\n Documentation/git-fetch-pack.txt         |   18 ++--\n Documentation/git-fetch.txt              |    4 +-\n Documentation/git-filter-branch.txt      |   14 ++--\n Documentation/git-fmt-merge-msg.txt      |    4 +-\n Documentation/git-for-each-ref.txt       |    8 +-\n Documentation/git-format-patch.txt       |    6 +-\n Documentation/git-fsck-objects.txt       |    2 +-\n Documentation/git-fsck.txt               |   10 +-\n Documentation/git-gc.txt                 |   16 ++--\n Documentation/git-get-tar-commit-id.txt  |    8 +-\n Documentation/git-grep.txt               |    4 +-\n Documentation/git-gui.txt                |   24 +++---\n Documentation/git-hash-object.txt        |    4 +-\n Documentation/git-help.txt               |    6 +-\n Documentation/git-http-fetch.txt         |    4 +-\n Documentation/git-http-push.txt          |    2 +-\n Documentation/git-imap-send.txt          |    6 +-\n Documentation/git-index-pack.txt         |   12 +-\n Documentation/git-init-db.txt            |    2 +-\n Documentation/git-init.txt               |    6 +-\n Documentation/git-instaweb.txt           |    8 +-\n Documentation/git-log.txt                |    6 +-\n Documentation/git-lost-found.txt         |    2 +-\n Documentation/git-ls-files.txt           |   10 +-\n Documentation/git-ls-remote.txt          |    4 +-\n Documentation/git-ls-tree.txt            |    2 +-\n Documentation/git-mailinfo.txt           |    8 +-\n Documentation/git-mailsplit.txt          |    2 +-\n Documentation/git-merge-base.txt         |   10 +-\n Documentation/git-merge-file.txt         |   14 ++--\n Documentation/git-merge-index.txt        |   20 ++--\n Documentation/git-merge-one-file.txt     |    4 +-\n Documentation/git-merge-tree.txt         |    2 +-\n Documentation/git-merge.txt              |   24 +++--\n Documentation/git-mergetool.txt          |   18 ++--\n Documentation/git-mktag.txt              |    2 +-\n Documentation/git-mktree.txt             |    2 +-\n Documentation/git-mv.txt                 |    6 +-\n Documentation/git-name-rev.txt           |    8 +-\n Documentation/git-pack-objects.txt       |   10 +-\n Documentation/git-pack-redundant.txt     |   10 +-\n Documentation/git-pack-refs.txt          |    4 +-\n Documentation/git-patch-id.txt           |    4 +-\n Documentation/git-peek-remote.txt        |    6 +-\n Documentation/git-prune-packed.txt       |    2 +-\n Documentation/git-prune.txt              |   14 ++--\n Documentation/git-pull.txt               |    5 +-\n Documentation/git-push.txt               |    4 +-\n Documentation/git-quiltimport.txt        |    2 +-\n Documentation/git-read-tree.txt          |   46 +++++-----\n Documentation/git-rebase.txt             |   38 ++++----\n Documentation/git-receive-pack.txt       |   24 +++---\n Documentation/git-relink.txt             |    2 +-\n Documentation/git-remote.txt             |   12 +-\n Documentation/git-repack.txt             |   15 ++--\n Documentation/git-repo-config.txt        |    2 +-\n Documentation/git-request-pull.txt       |    2 +-\n Documentation/git-rerere.txt             |   14 ++--\n Documentation/git-reset.txt              |    2 +-\n Documentation/git-rev-list.txt           |   16 ++--\n Documentation/git-rev-parse.txt          |   18 ++--\n Documentation/git-revert.txt             |    2 +-\n Documentation/git-rm.txt                 |   10 +-\n Documentation/git-send-email.txt         |    2 +-\n Documentation/git-send-pack.txt          |   16 ++--\n Documentation/git-shell.txt              |    2 +-\n Documentation/git-shortlog.txt           |    6 +-\n Documentation/git-show-branch.txt        |    8 +-\n Documentation/git-show-index.txt         |    6 +-\n Documentation/git-show-ref.txt           |   10 +-\n Documentation/git-show.txt               |    8 +-\n Documentation/git-stash.txt              |   22 ++--\n Documentation/git-status.txt             |    6 +-\n Documentation/git-stripspace.txt         |    2 +-\n Documentation/git-submodule.txt          |   14 ++--\n Documentation/git-svn.txt                |  153 +++++++++++++++---------------\n Documentation/git-symbolic-ref.txt       |    4 +-\n Documentation/git-tag.txt                |   18 ++--\n Documentation/git-tar-tree.txt           |    6 +-\n Documentation/git-unpack-file.txt        |    2 +-\n Documentation/git-unpack-objects.txt     |    4 +-\n Documentation/git-update-index.txt       |   26 +++---\n Documentation/git-update-ref.txt         |   10 +-\n Documentation/git-update-server-info.txt |    4 +-\n Documentation/git-upload-archive.txt     |    4 +-\n Documentation/git-upload-pack.txt        |    8 +-\n Documentation/git-var.txt                |    4 +-\n Documentation/git-verify-pack.txt        |    6 +-\n Documentation/git-verify-tag.txt         |    4 +-\n Documentation/git-web--browse.txt        |   10 +-\n Documentation/git-whatchanged.txt        |   10 +-\n Documentation/git-write-tree.txt         |    2 +-\n Documentation/git.txt                    |   30 +++---\n Documentation/gitattributes.txt          |   18 ++--\n Documentation/gitcore-tutorial.txt       |  127 ++++++++++++-------------\n Documentation/gitcvs-migration.txt       |   24 +++---\n Documentation/gitdiffcore.txt            |   34 ++++----\n Documentation/githooks.txt               |   10 +-\n Documentation/gitignore.txt              |    8 +-\n Documentation/gitk.txt                   |    3 +-\n Documentation/gitrepository-layout.txt   |   24 +++---\n Documentation/gittutorial-2.txt          |   40 ++++----\n Documentation/gittutorial.txt            |   66 +++++++-------\n Documentation/user-manual.txt            |   85 ++++++++---------\n 140 files changed, 961 insertions(+), 964 deletions(-)\n"},{"id":"81780","messageId":"Pine.GSO.4.62.0806301657320.7190@harper.uchicago.edu","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0806301650530.7190@harper.uchicago.edu","subject":"[PATCH 1/7] Documentation: fix links to tutorials and other new manual pages","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-06-30T22:01:21Z","receivedAt":"2008-06-30T22:01:21Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"With the conversion of HTML documentation to man pages\n\ntutorial.html -> gittutorial (7)\ntutorial-2.html -> gittutorial-2 (7)\ncvs-migration.html -> gitcvs-migration (7)\ndiffcore.html -> gitdiffcore (7)\nrepository-layout.html -> gitrepository-layout (5)\nhooks.html -> githooks (5)\nglossary.html -> gitglossary (7)\ncore-tutorial.html -> gitcore-tutorial (7)\n\nand the automatic update of references to these pages,\na little debris was left behind. We clear it away.\n\nSigned-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n---\n Documentation/diff-options.txt           |    2 +-\n Documentation/git-add.txt                |    2 +-\n Documentation/git-commit.txt             |    4 ++--\n Documentation/git-update-server-info.txt |    2 +-\n Documentation/git.txt                    |   20 ++++++++++----------\n Documentation/gitcore-tutorial.txt       |    9 ++++-----\n Documentation/gitcvs-migration.txt       |   12 ++++++------\n Documentation/gitrepository-layout.txt   |    2 +-\n Documentation/gittutorial-2.txt          |   12 +++++-------\n Documentation/gittutorial.txt            |    8 ++++----\n Documentation/user-manual.txt            |    7 +++----\n 11 files changed, 38 insertions(+), 42 deletions(-)\n\ndiff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt\nindex 5721548..cba90fd 100644\n--- a/Documentation/diff-options.txt\n+++ b/Documentation/diff-options.txt\n@@ -241,4 +241,4 @@ endif::git-format-patch[]\n \tDo not show any source or destination prefix.\n \n For more detailed explanation on these common options, see also\n-linkgit:gitdiffcore[7][diffcore documentation].\n+linkgit:gitdiffcore[7].\ndiff --git a/Documentation/git-add.txt b/Documentation/git-add.txt\nindex b8e3fa6..2b0ccb3 100644\n--- a/Documentation/git-add.txt\n+++ b/Documentation/git-add.txt\n@@ -107,7 +107,7 @@ Configuration\n The optional configuration variable 'core.excludesfile' indicates a path to a\n file containing patterns of file names to exclude from git-add, similar to\n $GIT_DIR/info/exclude.  Patterns in the exclude file are used in addition to\n-those in info/exclude.  See linkgit:gitrepository-layout[5][repository layout].\n+those in info/exclude.  See linkgit:gitrepository-layout[5].\n \n \n EXAMPLES\ndiff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt\nindex d0fe192..656d4db 100644\n--- a/Documentation/git-commit.txt\n+++ b/Documentation/git-commit.txt\n@@ -97,7 +97,7 @@ OPTIONS\n -n::\n --no-verify::\n \tThis option bypasses the pre-commit and commit-msg hooks.\n-\tSee also linkgit:githooks[5][hooks].\n+\tSee also linkgit:githooks[5].\n \n --allow-empty::\n \tUsually recording a commit that has the exact same tree as its\n@@ -316,7 +316,7 @@ order).\n HOOKS\n -----\n This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`,\n-and `post-commit` hooks.  See linkgit:githooks[5][hooks] for more\n+and `post-commit` hooks.  See linkgit:githooks[5] for more\n information.\n \n \ndiff --git a/Documentation/git-update-server-info.txt b/Documentation/git-update-server-info.txt\nindex d21be41..0102410 100644\n--- a/Documentation/git-update-server-info.txt\n+++ b/Documentation/git-update-server-info.txt\n@@ -31,7 +31,7 @@ OUTPUT\n ------\n \n Currently the command updates the following files.  Please see\n-linkgit:gitrepository-layout[5][repository-layout] for description of\n+linkgit:gitrepository-layout[5] for description of\n what they are for:\n \n * objects/info/packs\ndiff --git a/Documentation/git.txt b/Documentation/git.txt\nindex a791ce7..27eebfb 100644\n--- a/Documentation/git.txt\n+++ b/Documentation/git.txt\n@@ -20,11 +20,11 @@ Git is a fast, scalable, distributed revision control system with an\n unusually rich command set that provides both high-level operations\n and full access to internals.\n \n-See this linkgit:gittutorial[7][tutorial] to get started, then see\n+See linkgit:gittutorial[7] to get started, then see\n link:everyday.html[Everyday Git] for a useful minimum set of commands, and\n \"man git-commandname\" for documentation of each command.  CVS users may\n-also want to read linkgit:gitcvs-migration[7][CVS migration].  See\n-link:user-manual.html[Git User's Manual] for a more in-depth\n+also want to read linkgit:gitcvs-migration[7].  See\n+the link:user-manual.html[Git User's Manual] for a more in-depth\n introduction.\n \n The COMMAND is either a name of a Git command (see below) or an alias\n@@ -182,13 +182,14 @@ See the references above to get started using git.  The following is\n probably more detail than necessary for a first-time user.\n \n The link:user-manual.html#git-concepts[git concepts chapter of the\n-user-manual] and the linkgit:gitcore-tutorial[7][Core tutorial] both provide\n+user-manual] and linkgit:gitcore-tutorial[7] both provide\n introductions to the underlying git architecture.\n \n See also the link:howto-index.html[howto] documents for some useful\n examples.\n \n-The internals are documented link:technical/api-index.html[here].\n+The internals are documented in the\n+link:technical/api-index.html[GIT API documentation].\n \n GIT COMMANDS\n ------------\n@@ -372,10 +373,9 @@ For a more complete list of ways to spell object names, see\n File/Directory Structure\n ------------------------\n \n-Please see the linkgit:gitrepository-layout[5][repository layout]\n-document.\n+Please see the linkgit:gitrepository-layout[5] document.\n \n-Read linkgit:githooks[5][hooks] for more details about each hook.\n+Read linkgit:githooks[5] for more details about each hook.\n \n Higher level SCMs may provide and manage additional information in the\n `$GIT_DIR`.\n@@ -383,7 +383,7 @@ Higher level SCMs may provide and manage additional information in the\n \n Terminology\n -----------\n-Please see the linkgit:gitglossary[7][glossary] document.\n+Please see linkgit:gitglossary[7].\n \n \n Environment Variables\n@@ -535,7 +535,7 @@ Discussion[[Discussion]]\n \n More detail on the following is available from the\n link:user-manual.html#git-concepts[git concepts chapter of the\n-user-manual] and the linkgit:gitcore-tutorial[7][Core tutorial].\n+user-manual] and linkgit:gitcore-tutorial[7].\n \n A git project normally consists of a working directory with a \".git\"\n subdirectory at the top level.  The .git directory contains, among other\ndiff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt\nindex cb4ec40..6bb32a8 100644\n--- a/Documentation/gitcore-tutorial.txt\n+++ b/Documentation/gitcore-tutorial.txt\n@@ -16,8 +16,8 @@ This tutorial explains how to use the \"core\" git programs to set up and\n work with a git repository.\n \n If you just need to use git as a revision control system you may prefer\n-to start with linkgit:gittutorial[7][a tutorial introduction to git] or\n-link:user-manual.html[the git user manual].\n+to start with \"A Tutorial Introduction to GIT\" (linkgit:gittutorial[7]) or\n+link:user-manual.html[the GIT User Manual].\n \n However, an understanding of these low-level tools can be helpful if\n you want to understand git's internals.\n@@ -108,8 +108,7 @@ references in these `refs` subdirectories when you actually start\n populating your tree.\n \n [NOTE]\n-An advanced user may want to take a look at the\n-linkgit:gitrepository-layout[5][repository layout] document\n+An advanced user may want to take a look at linkgit:gitrepository-layout[5]\n after finishing this tutorial.\n \n You have now created your first git repository. Of course, since it's\n@@ -1589,7 +1588,7 @@ suggested in the previous section may be new to you. You do not\n have to worry. git supports \"shared public repository\" style of\n cooperation you are probably more familiar with as well.\n \n-See linkgit:gitcvs-migration[7][git for CVS users] for the details.\n+See linkgit:gitcvs-migration[7] for the details.\n \n Bundling your work together\n ---------------------------\ndiff --git a/Documentation/gitcvs-migration.txt b/Documentation/gitcvs-migration.txt\nindex 1db3f52..d652658 100644\n--- a/Documentation/gitcvs-migration.txt\n+++ b/Documentation/gitcvs-migration.txt\n@@ -18,9 +18,9 @@ important than any other.  However, you can emulate the CVS model by\n designating a single shared repository which people can synchronize with;\n this document explains how to do that.\n \n-Some basic familiarity with git is required.  This\n-linkgit:gittutorial[7][tutorial introduction to git] and the\n-linkgit:gitglossary[7][git glossary] should be sufficient.\n+Some basic familiarity with git is required. Having gone through\n+linkgit:gittutorial[7] and\n+linkgit:gitglossary[7] should be sufficient.\n \n Developing against a shared repository\n --------------------------------------\n@@ -81,8 +81,8 @@ Setting Up a Shared Repository\n ------------------------------\n \n We assume you have already created a git repository for your project,\n-possibly created from scratch or from a tarball (see the\n-linkgit:gittutorial[7][tutorial]), or imported from an already existing CVS\n+possibly created from scratch or from a tarball (see\n+linkgit:gittutorial[7]), or imported from an already existing CVS\n repository (see the next section).\n \n Assume your existing repo is at /home/alice/myproject.  Create a new \"bare\"\n@@ -148,7 +148,7 @@ Advanced Shared Repository Management\n \n Git allows you to specify scripts called \"hooks\" to be run at certain\n points.  You can use these, for example, to send all commits to the shared\n-repository to a mailing list.  See linkgit:githooks[5][Hooks used by git].\n+repository to a mailing list.  See linkgit:githooks[5].\n \n You can enforce finer grained permissions using update hooks.  See\n link:howto/update-hook-example.txt[Controlling access to branches using\ndiff --git a/Documentation/gitrepository-layout.txt b/Documentation/gitrepository-layout.txt\nindex 03c52ff..b75508a 100644\n--- a/Documentation/gitrepository-layout.txt\n+++ b/Documentation/gitrepository-layout.txt\n@@ -135,7 +135,7 @@ hooks::\n \tcommands.  A handful of sample hooks are installed when\n \t`git init` is run, but all of them are disabled by\n \tdefault.  To enable, they need to be made executable.\n-\tRead linkgit:githooks[5][hooks] for more details about\n+\tRead linkgit:githooks[5] for more details about\n \teach hook.\n \n index::\ndiff --git a/Documentation/gittutorial-2.txt b/Documentation/gittutorial-2.txt\nindex 31e8a23..2c54670 100644\n--- a/Documentation/gittutorial-2.txt\n+++ b/Documentation/gittutorial-2.txt\n@@ -12,8 +12,7 @@ git *\n DESCRIPTION\n -----------\n \n-You should work through linkgit:gittutorial[7][A tutorial introduction to\n-git] before reading this tutorial.\n+You should work through linkgit:gittutorial[7] before reading this tutorial.\n \n The goal of this tutorial is to introduce two fundamental pieces of\n git's architecture--the object database and the index file--and to\n@@ -390,7 +389,7 @@ in the index file is identical to the one in the working directory.\n In addition to being the staging area for new commits, the index file\n is also populated from the object database when checking out a\n branch, and is used to hold the trees involved in a merge operation.\n-See the linkgit:gitcore-tutorial[7][core tutorial] and the relevant man\n+See linkgit:gitcore-tutorial[7] and the relevant man\n pages for details.\n \n What next?\n@@ -399,20 +398,19 @@ What next?\n At this point you should know everything necessary to read the man\n pages for any of the git commands; one good place to start would be\n with the commands mentioned in link:everyday.html[Everyday git].  You\n-should be able to find any unknown jargon in the\n-linkgit:gitglossary[7][Glossary].\n+should be able to find any unknown jargon in linkgit:gitglossary[7].\n \n The link:user-manual.html[Git User's Manual] provides a more\n comprehensive introduction to git.\n \n-The linkgit:gitcvs-migration[7][CVS migration] document explains how to\n+linkgit:gitcvs-migration[7] explains how to\n import a CVS repository into git, and shows how to use git in a\n CVS-like way.\n \n For some interesting examples of git use, see the\n link:howto-index.html[howtos].\n \n-For git developers, the linkgit:gitcore-tutorial[7][Core tutorial] goes\n+For git developers, linkgit:gitcore-tutorial[7] goes\n into detail on the lower-level git mechanisms involved in, for\n example, creating a new commit.\n \ndiff --git a/Documentation/gittutorial.txt b/Documentation/gittutorial.txt\nindex d465aab..3d16e3d 100644\n--- a/Documentation/gittutorial.txt\n+++ b/Documentation/gittutorial.txt\n@@ -392,7 +392,7 @@ see linkgit:git-pull[1] for details.\n \n Git can also be used in a CVS-like mode, with a central repository\n that various users push changes to; see linkgit:git-push[1] and\n-linkgit:gitcvs-migration[7][git for CVS users].\n+linkgit:gitcvs-migration[7].\n \n Exploring history\n -----------------\n@@ -571,9 +571,9 @@ is based:\n     used to create commits, check out working directories, and\n     hold the various trees involved in a merge.\n \n-linkgit:gittutorial-2[7][Part two of this tutorial] explains the object\n+Part two of this tutorial explains the object\n database, the index file, and a few other odds and ends that you'll\n-need to make the most of git.\n+need to make the most of git. You can find it at linkgit:gittutorial-2[7].\n \n If you don't want to continue with that right away, a few other\n digressions that may be interesting at this point are:\n@@ -592,7 +592,7 @@ digressions that may be interesting at this point are:\n \n   * link:everyday.html[Everyday GIT with 20 Commands Or So]\n \n-  * linkgit:gitcvs-migration[7][git for CVS users].\n+  * linkgit:gitcvs-migration[7]: Git for CVS users.\n \n SEE ALSO\n --------\ndiff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt\nindex 64a820b..ca4363f 100644\n--- a/Documentation/user-manual.txt\n+++ b/Documentation/user-manual.txt\n@@ -1879,8 +1879,7 @@ $ chmod a+x hooks/post-update\n -------------------------------------------------\n \n (For an explanation of the last two lines, see\n-linkgit:git-update-server-info[1], and the documentation\n-linkgit:githooks[5][Hooks used by git].)\n+linkgit:git-update-server-info[1] and linkgit:githooks[5].)\n \n Advertise the URL of proj.git.  Anybody else should then be able to\n clone or pull from that URL, for example with a command line like:\n@@ -1992,7 +1991,7 @@ the right to push to the same repository.  In that case, the correct\n solution is to retry the push after first updating your work by either a\n pull or a fetch followed by a rebase; see the\n <<setting-up-a-shared-repository,next section>> and\n-linkgit:gitcvs-migration[7][git for CVS users] for more.\n+linkgit:gitcvs-migration[7] for more.\n \n [[setting-up-a-shared-repository]]\n Setting up a shared repository\n@@ -2001,7 +2000,7 @@ Setting up a shared repository\n Another way to collaborate is by using a model similar to that\n commonly used in CVS, where several developers with special rights\n all push to and pull from a single shared repository.  See\n-linkgit:gitcvs-migration[7][git for CVS users] for instructions on how to\n+linkgit:gitcvs-migration[7] for instructions on how to\n set this up.\n \n However, while there is nothing wrong with git's support for shared\n-- \n1.5.5.GIT\n"},{"id":"81781","messageId":"Pine.GSO.4.62.0806301703340.7190@harper.uchicago.edu","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0806301650530.7190@harper.uchicago.edu","subject":"[PATCH 2/7] whitespace fix in Documentation/git-repack.txt","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-06-30T22:05:15Z","receivedAt":"2008-06-30T22:05:15Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Change leading spaces to tabs to match the rest of the file.\n\nSigned-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n---\n Documentation/git-repack.txt |    6 +++---\n 1 files changed, 3 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt\nindex 04d6f1f..9011d06 100644\n--- a/Documentation/git-repack.txt\n+++ b/Documentation/git-repack.txt\n@@ -55,15 +55,15 @@ OPTIONS\n \tAlso runs linkgit:git-prune-packed[1].\n \n -l::\n-        Pass the `--local` option to `git pack-objects`, see\n+\tPass the `--local` option to `git pack-objects`, see\n \tlinkgit:git-pack-objects[1].\n \n -f::\n-        Pass the `--no-reuse-delta` option to `git pack-objects`, see\n+\tPass the `--no-reuse-delta` option to `git pack-objects`, see\n \tlinkgit:git-pack-objects[1].\n \n -q::\n-        Pass the `-q` option to `git pack-objects`, see\n+\tPass the `-q` option to `git pack-objects`, see\n \tlinkgit:git-pack-objects[1].\n \n -n::\n-- \n1.5.5.GIT\n"},{"id":"81782","messageId":"Pine.GSO.4.62.0806301706090.7190@harper.uchicago.edu","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0806301650530.7190@harper.uchicago.edu","subject":"[PATCH 3/7] Documentation: complicate example of \"man git-command\"","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-06-30T22:10:25Z","receivedAt":"2008-06-30T22:10:25Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"The manual page for the command invoked as \"git clone\" is named\ngit-clone(1), and similarly for the rest of the git commands.\nMake sure our first example of this in tutorials makes it clear\nthat it is the first two words of a command line that make up the\ncommand's name (that is: for example, the effect of \"git svn\ndcommit\" is described in git-svn(1)).\n\nSigned-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n---\n\tIf I didn't make this change, consistency would mean\n\tsaying \"you can get documentation for a command such\n\tas `git-diff` with `man git-diff`\", which might not be\n\tvery enlightening.\n\n Documentation/gittutorial.txt |    4 ++--\n Documentation/user-manual.txt |    2 +-\n 2 files changed, 3 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/gittutorial.txt b/Documentation/gittutorial.txt\nindex 3d16e3d..b833167 100644\n--- a/Documentation/gittutorial.txt\n+++ b/Documentation/gittutorial.txt\n@@ -20,10 +20,10 @@ for example, to test the latest version, you may prefer to start with\n the first two chapters of link:user-manual.html[The Git User's Manual].\n \n First, note that you can get documentation for a command such as \"git\n-diff\" with:\n+log --graph\" with:\n \n ------------------------------------------------\n-$ man git-diff\n+$ man git-log\n ------------------------------------------------\n \n It is a good idea to introduce yourself to git with your name and\ndiff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt\nindex ca4363f..36ab372 100644\n--- a/Documentation/user-manual.txt\n+++ b/Documentation/user-manual.txt\n@@ -18,7 +18,7 @@ People needing to do actual development will also want to read\n Further chapters cover more specialized topics.\n \n Comprehensive reference documentation is available through the man\n-pages.  For a command such as \"git clone\", just use\n+pages.  For a command such as \"git clone <repo>\", just use\n \n ------------------------------------------------\n $ man git-clone\n-- \n1.5.5.GIT\n"},{"id":"81785","messageId":"Pine.GSO.4.62.0806301711210.7190@harper.uchicago.edu","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0806301650530.7190@harper.uchicago.edu","subject":"[PATCH 4/7] git-daemon(1): don't assume git-daemon is in /usr/bin","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-06-30T22:15:57Z","receivedAt":"2008-06-30T22:15:57Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"In the example inetd.conf lines in git-daemon(1), it was\nassumed that `git-daemon` resides in the user's /usr/bin.\nWith this patch, we only assume `git` is in /usr/bin.\n\nThe stronger assumption fails in the default installation\nnowadays.\n\nSigned-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n---\n Documentation/git-daemon.txt |   10 +++++-----\n 1 files changed, 5 insertions(+), 5 deletions(-)\n\ndiff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt\nindex 344f24e..b71eb94 100644\n--- a/Documentation/git-daemon.txt\n+++ b/Documentation/git-daemon.txt\n@@ -206,8 +206,8 @@ git-daemon as inetd server::\n \t/etc/inetd all on one line:\n +\n ------------------------------------------------\n-\tgit stream tcp nowait nobody  /usr/bin/git-daemon\n-\t\tgit-daemon --inetd --verbose --export-all\n+\tgit stream tcp nowait nobody  /usr/bin/git\n+\t\tgit daemon --inetd --verbose --export-all\n \t\t/pub/foo /pub/bar\n ------------------------------------------------\n \n@@ -219,8 +219,8 @@ git-daemon as inetd server for virtual hosts::\n \t`/etc/inetd` all on one line:\n +\n ------------------------------------------------\n-\tgit stream tcp nowait nobody /usr/bin/git-daemon\n-\t\tgit-daemon --inetd --verbose --export-all\n+\tgit stream tcp nowait nobody /usr/bin/git\n+\t\tgit daemon --inetd --verbose --export-all\n \t\t--interpolated-path=/pub/%H%D\n \t\t/pub/www.example.org/software\n \t\t/pub/www.example.com/software\n@@ -241,7 +241,7 @@ git-daemon as regular daemon for virtual hosts::\n \ttheir IP addresses, start the daemon like this:\n +\n ------------------------------------------------\n-\tgit-daemon --verbose --export-all\n+\tgit daemon --verbose --export-all\n \t\t--interpolated-path=/pub/%IP/%D\n \t\t/pub/192.168.1.200/software\n \t\t/pub/10.10.220.23/software\n-- \n1.5.5.GIT\n"},{"id":"81786","messageId":"Pine.GSO.4.62.0806301716150.7190@harper.uchicago.edu","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0806301650530.7190@harper.uchicago.edu","subject":"[PATCH 5/7] Documentation: prepare to be consistent about \"git-\" versus \"git \"","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-06-30T22:17:07Z","receivedAt":"2008-06-30T22:17:07Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"With the dashed forms of git commands not in $(bindir), we have\nto change many instances of \"git-command\" to \"git command\". Also,\nfor consistency it is at times appropriate to make the opposite\nchange. In some cases, the change is not so simple as changing one\ncharacter.\n\nThis patch gets rid of some of those cases by rewrapping lines.\n\nSigned-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n---\n Documentation/git-mailinfo.txt         |    4 ++--\n Documentation/git-tag.txt              |    4 ++--\n Documentation/gitrepository-layout.txt |    8 ++++----\n Documentation/gittutorial.txt          |    4 ++--\n 4 files changed, 10 insertions(+), 10 deletions(-)\n\ndiff --git a/Documentation/git-mailinfo.txt b/Documentation/git-mailinfo.txt\nindex 183dc1d..6a73b73 100644\n--- a/Documentation/git-mailinfo.txt\n+++ b/Documentation/git-mailinfo.txt\n@@ -29,8 +29,8 @@ OPTIONS\n \tamong which (1) remove 'Re:' or 're:', (2) leading\n \twhitespaces, (3) '[' up to ']', typically '[PATCH]', and\n \tthen prepends \"[PATCH] \".  This flag forbids this\n-\tmunging, and is most useful when used to read back 'git\n-\tformat-patch -k' output.\n+\tmunging, and is most useful when used to read back\n+\t'git format-patch -k' output.\n \n -u::\n \tThe commit log message, author name and author email are\ndiff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt\nindex 8f40f4b..0c41711 100644\n--- a/Documentation/git-tag.txt\n+++ b/Documentation/git-tag.txt\n@@ -122,8 +122,8 @@ others have already seen the old one. So just use \"git tag -f\"\n again, as if you hadn't already published the old one.\n \n However, Git does *not* (and it should not) change tags behind\n-users back. So if somebody already got the old tag, doing a \"git\n-pull\" on your tree shouldn't just make them overwrite the old\n+users back. So if somebody already got the old tag, doing a\n+\"git pull\" on your tree shouldn't just make them overwrite the old\n one.\n \n If somebody got a release tag from you, you cannot just change\ndiff --git a/Documentation/gitrepository-layout.txt b/Documentation/gitrepository-layout.txt\nindex b75508a..2afc5a3 100644\n--- a/Documentation/gitrepository-layout.txt\n+++ b/Documentation/gitrepository-layout.txt\n@@ -167,14 +167,14 @@ info/grafts::\n info/exclude::\n \tThis file, by convention among Porcelains, stores the\n \texclude pattern list. `.gitignore` is the per-directory\n-\tignore file.  `git status`, `git add`, `git rm` and `git\n-\tclean` look at it but the core git commands do not look\n+\tignore file.  `git status`, `git add`, `git rm` and\n+\t`git clean` look at it but the core git commands do not look\n \tat it.  See also: linkgit:gitignore[5].\n \n remotes::\n \tStores shorthands to be used to give URL and default\n-\trefnames to interact with remote repository to `git\n-\tfetch`, `git pull` and `git push` commands.\n+\trefnames to interact with remote repository to\n+\t`git fetch`, `git pull` and `git push` commands.\n \n logs::\n \tRecords of changes made to refs are stored in this\ndiff --git a/Documentation/gittutorial.txt b/Documentation/gittutorial.txt\nindex b833167..144bacd 100644\n--- a/Documentation/gittutorial.txt\n+++ b/Documentation/gittutorial.txt\n@@ -19,8 +19,8 @@ If you are instead primarily interested in using git to fetch a project,\n for example, to test the latest version, you may prefer to start with\n the first two chapters of link:user-manual.html[The Git User's Manual].\n \n-First, note that you can get documentation for a command such as \"git\n-log --graph\" with:\n+First, note that you can get documentation for a command such as\n+\"git log --graph\" with:\n \n ------------------------------------------------\n $ man git-log\n-- \n1.5.5.GIT\n"},{"id":"81787","messageId":"Pine.GSO.4.62.0806301717320.7190@harper.uchicago.edu","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0806301716150.7190@harper.uchicago.edu","subject":"[PATCH 6/7] Documentation: be consistent about \"git-\" versus \"git \"","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-06-30T22:29:51Z","receivedAt":"2008-06-30T22:29:51Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"[Patch at <http://home.uchicago.edu/~jrnieder/20080701-git-doc-hyphens.txt>]\n\nSince the git-* commands are not installed in $(bindir), using\n\"git-command <parameters>\" in examples in the documentation is\nnot a good idea. On the other hand, it is nice to be able to\nrefer to each command using one hyphenated word. (There is no\nescaping it, anyway: man page names cannot have spaces in them.)\n\nThis patch retains the dash in naming an operation, command,\nprogram, process, or action. Complete command lines that can\nbe entered at a shell (i.e., without options omitted) are\nmade to use the dashless form.\n\nThe changes consist only of replacing some spaces with hyphens\nand vice versa. After a \"s/ /-/g\", the unpatched and patched\nversions are identical.\n\nSigned-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\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-bisect.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-cherry.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    |    8 +-\n Documentation/git-cvsimport.txt          |    4 +-\n Documentation/git-cvsserver.txt          |    2 +-\n Documentation/git-daemon.txt             |    2 +-\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-export.txt        |    2 +-\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                 |    6 +-\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-log.txt                |    2 +-\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           |    4 +-\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              |   10 ++--\n Documentation/git-mergetool.txt          |   16 +++---\n Documentation/git-mktag.txt              |    2 +-\n Documentation/git-mktree.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     |    6 +-\n Documentation/git-pack-refs.txt          |    4 +-\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              |    4 +-\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             |   20 +++---\n Documentation/git-receive-pack.txt       |   10 ++--\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                 |    8 +-\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              |   12 ++--\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                |   14 ++--\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        |    6 +-\n Documentation/git-whatchanged.txt        |    6 +-\n Documentation/git-write-tree.txt         |    2 +-\n Documentation/gitattributes.txt          |   14 ++--\n Documentation/gitcore-tutorial.txt       |  102 +++++++++++++++---------------\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   |   18 +++---\n Documentation/gittutorial-2.txt          |   18 +++---\n Documentation/gittutorial.txt            |   30 +++++-----\n Documentation/user-manual.txt            |   76 +++++++++++-----------\n 131 files changed, 462 insertions(+), 462 deletions(-)\n\nBecause it is long, I haven't sent the patch. You can find it at\n<http://home.uchicago.edu/~jrnieder/20080701-git-doc-hyphens.txt>.\n"},{"id":"81788","messageId":"Pine.GSO.4.62.0806301730230.7190@harper.uchicago.edu","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0806301650530.7190@harper.uchicago.edu","subject":"[RFC/PATCH 7/7] Documentation formatting and cleanup","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-06-30T22:36:41Z","receivedAt":"2008-06-30T22:36:41Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"[184 KB patch online at\n<http://home.uchicago.edu/~jrnieder/20080701-git-doc-style.txt>]\n\nFollowing what appears to be the predominant style, format\nnames of commands and commandlines both as `teletype text`.\n\nWhile we're at it, add articles (\"a\" and \"the\") in some\nplaces, italicize the name of the command in the manual page\nsynopsis line, and add a comma or two where it seems appropriate.\n\nSigned-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n\n\t1) I am using `teletype text` both for command names and\n\t   for command lines. Probably I should be using italics\n\t   for the command names.\n\n\t2) Should these changes be split up more?\n\n Documentation/git-annotate.txt          |    2 +-\n Documentation/git-apply.txt             |   12 ++--\n Documentation/git-archimport.txt        |    6 +-\n Documentation/git-archive.txt           |    6 +-\n Documentation/git-bisect.txt            |    8 +-\n Documentation/git-blame.txt             |    4 +-\n Documentation/git-branch.txt            |    8 +-\n Documentation/git-bundle.txt            |   27 +++---\n Documentation/git-check-ref-format.txt  |    2 +-\n Documentation/git-checkout-index.txt    |    2 +-\n Documentation/git-checkout.txt          |    4 +-\n Documentation/git-cherry-pick.txt       |    2 +-\n Documentation/git-cherry.txt            |    8 +-\n Documentation/git-citool.txt            |    4 +-\n Documentation/git-clean.txt             |    4 +-\n Documentation/git-clone.txt             |   12 ++--\n Documentation/git-commit-tree.txt       |    2 +-\n Documentation/git-commit.txt            |   20 +++---\n Documentation/git-config.txt            |   12 ++--\n Documentation/git-cvsexportcommit.txt   |    7 +-\n Documentation/git-cvsimport.txt         |   18 ++--\n Documentation/git-cvsserver.txt         |   43 +++++-----\n Documentation/git-daemon.txt            |   22 +++---\n Documentation/git-describe.txt          |    8 +-\n Documentation/git-diff-files.txt        |    2 +-\n Documentation/git-diff-index.txt        |   26 +++---\n Documentation/git-diff-tree.txt         |   10 +-\n Documentation/git-fast-export.txt       |    8 +-\n Documentation/git-fast-import.txt       |   16 ++--\n Documentation/git-fetch-pack.txt        |   16 ++--\n Documentation/git-fetch.txt             |    2 +-\n Documentation/git-filter-branch.txt     |   12 ++--\n Documentation/git-fmt-merge-msg.txt     |    4 +-\n Documentation/git-format-patch.txt      |    4 +-\n Documentation/git-fsck.txt              |    6 +-\n Documentation/git-gc.txt                |   10 +-\n Documentation/git-get-tar-commit-id.txt |    6 +-\n Documentation/git-grep.txt              |    2 +-\n Documentation/git-gui.txt               |   24 +++---\n Documentation/git-hash-object.txt       |    2 +-\n Documentation/git-help.txt              |    6 +-\n Documentation/git-http-fetch.txt        |    2 +-\n Documentation/git-imap-send.txt         |    2 +-\n Documentation/git-index-pack.txt        |    8 +-\n Documentation/git-instaweb.txt          |    4 +-\n Documentation/git-log.txt               |    4 +-\n Documentation/git-ls-files.txt          |    8 +-\n Documentation/git-ls-remote.txt         |    2 +-\n Documentation/git-mailinfo.txt          |    4 +-\n Documentation/git-merge-base.txt        |    8 +-\n Documentation/git-merge-file.txt        |   10 +-\n Documentation/git-merge-index.txt       |   14 ++--\n Documentation/git-merge-one-file.txt    |    4 +-\n Documentation/git-merge.txt             |   14 ++--\n Documentation/git-mergetool.txt         |    2 +-\n Documentation/git-name-rev.txt          |    6 +-\n Documentation/git-pack-objects.txt      |    8 +-\n Documentation/git-pack-redundant.txt    |    4 +-\n Documentation/git-patch-id.txt          |    2 +-\n Documentation/git-peek-remote.txt       |    4 +-\n Documentation/git-prune.txt             |   10 +-\n Documentation/git-pull.txt              |    3 +-\n Documentation/git-push.txt              |    2 +-\n Documentation/git-read-tree.txt         |   14 ++--\n Documentation/git-rebase.txt            |   22 +++---\n Documentation/git-receive-pack.txt      |   16 ++--\n Documentation/git-repack.txt            |   11 ++-\n Documentation/git-rerere.txt            |   10 +-\n Documentation/git-reset.txt             |    2 +-\n Documentation/git-rev-list.txt          |    6 +-\n Documentation/git-rev-parse.txt         |   12 ++--\n Documentation/git-rm.txt                |    2 +-\n Documentation/git-send-pack.txt         |   14 ++--\n Documentation/git-shell.txt             |    2 +-\n Documentation/git-shortlog.txt          |    2 +-\n Documentation/git-show-branch.txt       |    4 +-\n Documentation/git-show-index.txt        |    4 +-\n Documentation/git-show-ref.txt          |    4 +-\n Documentation/git-show.txt              |    6 +-\n Documentation/git-stash.txt             |   12 ++--\n Documentation/git-submodule.txt         |    4 +-\n Documentation/git-svn.txt               |  133 +++++++++++++++----------------\n Documentation/git-symbolic-ref.txt      |    2 +-\n Documentation/git-tag.txt               |    8 +-\n Documentation/git-tar-tree.txt          |    4 +-\n Documentation/git-unpack-objects.txt    |    2 +-\n Documentation/git-update-index.txt      |   14 ++--\n Documentation/git-upload-archive.txt    |    2 +-\n Documentation/git-upload-pack.txt       |    6 +-\n Documentation/git-verify-pack.txt       |    4 +-\n Documentation/git-verify-tag.txt        |    2 +-\n Documentation/git-web--browse.txt       |    6 +-\n Documentation/git-whatchanged.txt       |    4 +-\n Documentation/git.txt                   |   10 +-\n Documentation/gitattributes.txt         |   12 ++--\n Documentation/gitcore-tutorial.txt      |   18 ++--\n Documentation/gitcvs-migration.txt      |    4 +-\n Documentation/gitdiffcore.txt           |   34 ++++----\n Documentation/gitignore.txt             |    4 +-\n Documentation/gitk.txt                  |    3 +-\n Documentation/gitrepository-layout.txt  |    2 +-\n Documentation/gittutorial-2.txt         |   28 +++---\n Documentation/gittutorial.txt           |   46 ++++++------\n 103 files changed, 510 insertions(+), 509 deletions(-)\n\nSee <http://home.uchicago.edu/~jrnieder/20080701-git-doc-style.txt>.\n"},{"id":"81802","messageId":"200807010130.31258.chriscool@tuxfamily.org","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0806301657320.7190@harper.uchicago.edu","subject":"Re: [PATCH 1/7] Documentation: fix links to tutorials and other new manual pages","fromName":"Christian Couder","fromEmail":"chriscool@tuxfamily.org","sentAt":"2008-06-30T23:30:31Z","receivedAt":"2008-06-30T23:30:31Z","isPatch":true,"sender":{"key":"christian.couder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/208954?v=4"},"body":"Le mardi 1 juillet 2008, Jonathan Nieder a écrit :\n> With the conversion of HTML documentation to man pages\n>\n> tutorial.html -> gittutorial (7)\n> tutorial-2.html -> gittutorial-2 (7)\n> cvs-migration.html -> gitcvs-migration (7)\n> diffcore.html -> gitdiffcore (7)\n> repository-layout.html -> gitrepository-layout (5)\n> hooks.html -> githooks (5)\n> glossary.html -> gitglossary (7)\n> core-tutorial.html -> gitcore-tutorial (7)\n>\n> and the automatic update of references to these pages,\n> a little debris was left behind. We clear it away.\n\nI left them behind because I thought they might be usefull and in fact in \nsome places you also leave them like this:\n\n> -to start with linkgit:gittutorial[7][a tutorial introduction to git]\n> +to start with \"A Tutorial Introduction to GIT\" (linkgit:gittutorial[7])\n\nI understand that some people might prefer your version though.\n\nThanks,\nChristian.\n"},{"id":"81805","messageId":"200807010139.17754.chriscool@tuxfamily.org","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0806301706090.7190@harper.uchicago.edu","subject":"Re: [PATCH 3/7] Documentation: complicate example of \"man git-command\"","fromName":"Christian Couder","fromEmail":"chriscool@tuxfamily.org","sentAt":"2008-06-30T23:39:17Z","receivedAt":"2008-06-30T23:39:17Z","isPatch":true,"sender":{"key":"christian.couder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/208954?v=4"},"body":"Le mardi 1 juillet 2008, Jonathan Nieder a écrit :\n> The manual page for the command invoked as \"git clone\" is named\n> git-clone(1), and similarly for the rest of the git commands.\n> Make sure our first example of this in tutorials makes it clear\n> that it is the first two words of a command line that make up the\n> command's name (that is: for example, the effect of \"git svn\n> dcommit\" is described in git-svn(1)).\n>\n> Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n> ---\n> \tIf I didn't make this change, consistency would mean\n> \tsaying \"you can get documentation for a command such\n> \tas `git-diff` with `man git-diff`\", which might not be\n> \tvery enlightening.\n\nBy the way, while at it, maybe we could talk about \"git help <cmd/topic>\" at \nthe same time.\n\nThanks,\nChristian.\n"},{"id":"81846","messageId":"7viqvqov01.fsf@gitster.siamese.dyndns.org","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0806301650530.7190@harper.uchicago.edu","subject":"Re: [PATCH 0/7] Some superficial documentation changes","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2008-07-01T08:42:54Z","receivedAt":"2008-07-01T08:42:54Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Jonathan Nieder <jrnieder@uchicago.edu> writes:\n\n> But at least I was able to check that patch 6/7 (which redistributes the\n> dashes in the world) doesn't touch anything but spaces and hyphens.\n> Hopefully that should make this easier to review.\n\nYes, the earlier \"line break adjustments\" patch really helped.\n\nI've queued all of them to 'pu' while reading them over, except for the\nlast one.  I did not look very carefully, but the parts I did look at made\nsense.\n\nIn general, I've always preferred to see command names \"git-foo\" typeset\nin teletype face, consistent with examples (also typeset in tt), because\nthey are both something the end users are expected to type.  With this\ntransition, we are however making \"git-foo\" not something users are\nexpected to type, which means that the use of a typeface that is different\nfrom the body text to spell command names is now strictly for making them\nstand out in context.  In that sense, I share your hesitation about the\nlast one to use tt for command names.  It probably is better to use italic\nnow.\n\nOn my next git day (coming Wednesday, if nothing goes wrong at day job),\nI'll merge all except the last one to 'master' so that the HTML version of\nthe manual page k.org serves to the general public is updated and we can\nget a wider exposure to looking for conversion errors more easily.  If you\nalso prefer 'italics' and list agrees, it might be a better idea to also\napply that patch when I do so, as that step is the most error prone one\nand benefits from more eyeballs.\n\nThanks. \n"},{"id":"81875","messageId":"486A2C8C.5050204@free.fr","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0806301730230.7190@harper.uchicago.edu","subject":"Re: [RFC/PATCH 7/7] Documentation formatting and cleanup","fromName":"Olivier Marin","fromEmail":"dkr+ml.git@free.fr","sentAt":"2008-07-01T13:09:32Z","receivedAt":"2008-07-01T13:09:32Z","isPatch":true,"sender":{"key":"dkr+ml.git@free.fr","avatar":null},"body":"Jonathan Nieder a écrit :\n> [184 KB patch online at\n> <http://home.uchicago.edu/~jrnieder/20080701-git-doc-style.txt>]\n> \n> Following what appears to be the predominant style, format\n> names of commands and commandlines both as `teletype text`.\n> \n> While we're at it, add articles (\"a\" and \"the\") in some\n> places, italicize the name of the command in the manual page\n> synopsis line, and add a comma or two where it seems appropriate.\n> \n> Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n> \n> \t1) I am using `teletype text` both for command names and\n> \t   for command lines. Probably I should be using italics\n> \t   for the command names.\n\nYou did a lot of:\n\n> -replaced; you need to use a tool such as linkgit:git-diff[1] or the \"pickaxe\"\n> +replaced; you need to use a tool such as `git-diff` or the \"pickaxe\"\n\nAre those kind of changes really an improvement?\n\nAlso, in Documentation/gitdiffcore.txt, you did:\n\n> -These are applied in sequence.  The set of filepairs git-diff-\\*\n> +These are applied in sequence.  The set of filepairs `git-diff-*`\n\nbut the file does not compile, now.\n\nOlivier.\n"},{"id":"81886","messageId":"20080701162358.GA18305@fieldses.org","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0806301706090.7190@harper.uchicago.edu","subject":"Re: [PATCH 3/7] Documentation: complicate example of \"man git-command\"","fromName":"J. Bruce Fields","fromEmail":"bfields@fieldses.org","sentAt":"2008-07-01T16:23:58Z","receivedAt":"2008-07-01T16:23:58Z","isPatch":true,"sender":{"key":"bfields@citi.umich.edu","avatar":null},"body":"On Mon, Jun 30, 2008 at 05:10:25PM -0500, Jonathan Nieder wrote:\n> The manual page for the command invoked as \"git clone\" is named\n> git-clone(1), and similarly for the rest of the git commands.\n> Make sure our first example of this in tutorials makes it clear\n> that it is the first two words of a command line that make up the\n> command's name (that is: for example, the effect of \"git svn\n> dcommit\" is described in git-svn(1)).\n\nIs this confusion really common?\n\nI can see how it might be possible in the case of a subcommand that\nitself has subcommands, but it seems less likely in the two examples you\nadd below (where the third token is an option or a url).  I like your\n\"git svn\" example better.  Or \"git remote\" might be good.\n\n--b.\n\n> \n> Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n> ---\n> \tIf I didn't make this change, consistency would mean\n> \tsaying \"you can get documentation for a command such\n> \tas `git-diff` with `man git-diff`\", which might not be\n> \tvery enlightening.\n> \n>  Documentation/gittutorial.txt |    4 ++--\n>  Documentation/user-manual.txt |    2 +-\n>  2 files changed, 3 insertions(+), 3 deletions(-)\n> \n> diff --git a/Documentation/gittutorial.txt b/Documentation/gittutorial.txt\n> index 3d16e3d..b833167 100644\n> --- a/Documentation/gittutorial.txt\n> +++ b/Documentation/gittutorial.txt\n> @@ -20,10 +20,10 @@ for example, to test the latest version, you may prefer to start with\n>  the first two chapters of link:user-manual.html[The Git User's Manual].\n>  \n>  First, note that you can get documentation for a command such as \"git\n> -diff\" with:\n> +log --graph\" with:\n>  \n>  ------------------------------------------------\n> -$ man git-diff\n> +$ man git-log\n>  ------------------------------------------------\n>  \n>  It is a good idea to introduce yourself to git with your name and\n> diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt\n> index ca4363f..36ab372 100644\n> --- a/Documentation/user-manual.txt\n> +++ b/Documentation/user-manual.txt\n> @@ -18,7 +18,7 @@ People needing to do actual development will also want to read\n>  Further chapters cover more specialized topics.\n>  \n>  Comprehensive reference documentation is available through the man\n> -pages.  For a command such as \"git clone\", just use\n> +pages.  For a command such as \"git clone <repo>\", just use\n>  \n>  ------------------------------------------------\n>  $ man git-clone\n> -- \n> 1.5.5.GIT\n> \n> \n"},{"id":"81904","messageId":"7vej6dmgps.fsf@gitster.siamese.dyndns.org","threadId":"14232","inReplyTo":"486A2C8C.5050204@free.fr","subject":"Re: [RFC/PATCH 7/7] Documentation formatting and cleanup","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2008-07-01T21:34:23Z","receivedAt":"2008-07-01T21:34:23Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Olivier Marin <dkr+ml.git@free.fr> writes:\n\n> Also, in Documentation/gitdiffcore.txt, you did:\n>\n>> -These are applied in sequence.  The set of filepairs git-diff-\\*\n>> +These are applied in sequence.  The set of filepairs `git-diff-*`\n>\n> but the file does not compile, now.\n\nThere are other places with the same breakage.\n\nYou would need something like this (using the {asterisk} macro I\nwrote for updating the docs for another topic).  The patch shows only a\nsingle use location but there are others in the same file.\n\ndiff --git a/Documentation/asciidoc.conf b/Documentation/asciidoc.conf\nindex 10c1a15..40d43b7 100644\n--- a/Documentation/asciidoc.conf\n+++ b/Documentation/asciidoc.conf\n@@ -8,6 +8,7 @@\n # the command.\n \n [attributes]\n+asterisk=&#42;\n plus=&#43;\n caret=&#94;\n startsb=&#91;\ndiff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt\nindex 71568ab..7169eee 100644\n--- a/Documentation/gitdiffcore.txt\n+++ b/Documentation/gitdiffcore.txt\n@@ -23,7 +23,7 @@ that are easier to understand than the conventional kind.\n The chain of operation\n ----------------------\n \n-The `git-diff-*` family works by first comparing two sets of\n+The `git-diff-{asterisk}` family works by first comparing two sets of\n files:\n \n  - `git-diff-index` compares contents of a \"tree\" object and the\n"},{"id":"81906","messageId":"7vmyl1kvn6.fsf@gitster.siamese.dyndns.org","threadId":"14232","inReplyTo":"20080701162358.GA18305@fieldses.org","subject":"Re: [PATCH 3/7] Documentation: complicate example of \"man git-command\"","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2008-07-01T23:54:53Z","receivedAt":"2008-07-01T23:54:53Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"\"J. Bruce Fields\" <bfields@fieldses.org> writes:\n\n> On Mon, Jun 30, 2008 at 05:10:25PM -0500, Jonathan Nieder wrote:\n>> The manual page for the command invoked as \"git clone\" is named\n>> git-clone(1), and similarly for the rest of the git commands.\n>> Make sure our first example of this in tutorials makes it clear\n>> that it is the first two words of a command line that make up the\n>> command's name (that is: for example, the effect of \"git svn\n>> dcommit\" is described in git-svn(1)).\n>\n> Is this confusion really common?\n>\n> I can see how it might be possible in the case of a subcommand that\n> itself has subcommands, but it seems less likely in the two examples you\n> add below (where the third token is an option or a url).  I like your\n> \"git svn\" example better.  Or \"git remote\" might be good.\n>\n> --b.\n\nWhile I agree with the above, are we ready to talk about \"git-svn\"\nor \"git-remote\" that early in the tutorial material?\n\nWe would want to mention the typesetting convention early in the manuals\n(git(7), gittutorial(7) and user-manual.html) as well, so how about...\n\n\tConventions used in this document\n        ---------------------------------\n\n\tWhen talking about a git subcommand 'cmd', this documentation\n\ttypesets the name of it like 'git-cmd', and that is the name you\n\task for its manual page.\n\n        Examples are typeset like this: `$ git cmd` (`$` is your command\n\tprompt, do not actually type it to your shell).  Note that a\n\tsubcommand is specified as the first parameter to the 'git'\n\tprogram when you actually run it from the command line.\n\n\tE.g. a typical command description may go like this:\n\n        To propagate the changes you made back to the original subversion\n        repository, you would use 'git-svn dcommit' command.  It does\n        these things (long description here).  Some examples:\n\n        ------------\n\t$ ... some example command sequence ...\n        $ git svn dcommit\n        ------------\n\n        For full details, type:\n\n\t------------\n        $ man git-svn\n        ------------\n"},{"id":"82033","messageId":"20080702213148.GA26921@fieldses.org","threadId":"14232","inReplyTo":"7vmyl1kvn6.fsf@gitster.siamese.dyndns.org","subject":"Re: [PATCH 3/7] Documentation: complicate example of \"man git-command\"","fromName":"J. Bruce Fields","fromEmail":"bfields@fieldses.org","sentAt":"2008-07-02T21:31:48Z","receivedAt":"2008-07-02T21:31:48Z","isPatch":true,"sender":{"key":"bfields@citi.umich.edu","avatar":null},"body":"On Tue, Jul 01, 2008 at 04:54:53PM -0700, Junio C Hamano wrote:\n> \"J. Bruce Fields\" <bfields@fieldses.org> writes:\n> \n> > On Mon, Jun 30, 2008 at 05:10:25PM -0500, Jonathan Nieder wrote:\n> >> The manual page for the command invoked as \"git clone\" is named\n> >> git-clone(1), and similarly for the rest of the git commands.\n> >> Make sure our first example of this in tutorials makes it clear\n> >> that it is the first two words of a command line that make up the\n> >> command's name (that is: for example, the effect of \"git svn\n> >> dcommit\" is described in git-svn(1)).\n> >\n> > Is this confusion really common?\n> >\n> > I can see how it might be possible in the case of a subcommand that\n> > itself has subcommands, but it seems less likely in the two examples you\n> > add below (where the third token is an option or a url).  I like your\n> > \"git svn\" example better.  Or \"git remote\" might be good.\n> >\n> > --b.\n> \n> While I agree with the above, are we ready to talk about \"git-svn\"\n> or \"git-remote\" that early in the tutorial material?\n\nNo, but for the purposes of this example it's not necessary to be\nfamiliar with the command.  (Though it might be less distracting to use\nsomething that'll be discussed early on.)\n\n> We would want to mention the typesetting convention early in the manuals\n> (git(7), gittutorial(7) and user-manual.html) as well, so how about...\n> \n> \tConventions used in this document\n>         ---------------------------------\n> \n> \tWhen talking about a git subcommand 'cmd', this documentation\n> \ttypesets the name of it like 'git-cmd', and that is the name you\n> \task for its manual page.\n> \n>         Examples are typeset like this: `$ git cmd` (`$` is your command\n> \tprompt, do not actually type it to your shell).  Note that a\n> \tsubcommand is specified as the first parameter to the 'git'\n> \tprogram when you actually run it from the command line.\n\nI'm not convinced this last sentence is necessary.\n\n> \n> \tE.g. a typical command description may go like this:\n> \n>         To propagate the changes you made back to the original subversion\n>         repository, you would use 'git-svn dcommit' command.  It does\n>         these things (long description here).  Some examples:\n\n> \n>         ------------\n> \t$ ... some example command sequence ...\n>         $ git svn dcommit\n>         ------------\n\nTypographical conventions shouldn't need so much explanation.\n\nI'm curious: Jonathan, was this the original patch the result of a\nreal-life instance of confusion?  What happened?\n\n--b.\n\n> \n>         For full details, type:\n> \n> \t------------\n>         $ man git-svn\n>         ------------\n"},{"id":"82082","messageId":"Pine.GSO.4.62.0807022010280.10323@harper.uchicago.edu","threadId":"14232","inReplyTo":"20080702213148.GA26921@fieldses.org","subject":"Re: [PATCH 3/7] Documentation: complicate example of \"man git-command\"","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-07-03T01:45:59Z","receivedAt":"2008-07-03T01:45:59Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"J. Bruce Fields wrote:\n\n> On Tue, Jul 01, 2008 at 04:54:53PM -0700, Junio C Hamano wrote:\n>\n>> We would want to mention the typesetting convention early in the manuals\n>> (git(7), gittutorial(7) and user-manual.html) as well, so how about...\n>> \n>> \tConventions used in this document\n>>         ---------------------------------\n>> \n>> \tWhen talking about a git subcommand 'cmd', this documentation\n>> \ttypesets the name of it like 'git-cmd', and that is the name you\n>> \task for its manual page.\n>> \n>>         Examples are typeset like this: `$ git cmd` (`$` is your command\n>> \tprompt, do not actually type it to your shell).  Note that a\n>> \tsubcommand is specified as the first parameter to the 'git'\n>> \tprogram when you actually run it from the command line.\n> \n> I'm not convinced this last sentence is necessary.\n\nI agree, but I think it doesn't hurt. I think the point was to\nestablish the word and concept \"subcommand\".\n\n> > [example showing typographical conventions]\n> \n> Typographical conventions shouldn't need so much explanation.\n\nYes, I suppose. I'm used to printed manuals having a page on\nthe meaning of different typefaces inside, but that's a bit\nof a different situation.\n\n> I'm curious: Jonathan, was this the original patch the result of a\n> real-life instance of confusion?  What happened?\n\nNo, I'm actually a bit ashamed to have sent the patch... I was just\nchanging `git subcommand` to `git-subcommand` wherever it was the name\nof a command, rather than the command line to run it, that was in\nquestion. Consistency would have made the old example awkward, so I\nlooked around for alternatives.\n\nWhy worry about whether the man pages have no consistent rule about\ndashes? Since it is not obvious why the man pages use the dashed form\nwhen they do, I think a fraction of people will naturally use the\ndashed form by default. That means trouble once Git 1.6.0 comes out\n(e.g. see Ingo's recent post\n<http://thread.gmane.org/gmane.comp.version-control.git/87012/focus=87020>).\n\nHere's a patch implementing Junio's suggestion, because I do like it.\nPlease let me know what you think (especially ideas for making it\nshorter).\n\nThanks for all your thoughts so far. Sorry I took so long to get back.\n\n--- %< --- %< --- %< ----\nSubject: gittutorial(7): add \"Conventions used in this document\" section\n    \nThe manual page for the git subcommand invoked as \"git clone\" is\nnamed git-clone(1), and similarly for the rest of the git\nsubcommands. This patch should make the convention a little\nclearer when it is introduced at the beginning of gittutorial(7).\n\nThanks to Junio C Hamano for the idea and wording.\n\nIt remains to make an analogous change for user-manual.html\nand maybe git(1).\n\nSigned-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n---\n Documentation/gittutorial.txt |   35 ++++++++++++++++++++++++++++++-----\n 1 files changed, 30 insertions(+), 5 deletions(-)\n\ndiff --git a/Documentation/gittutorial.txt\nb/Documentation/gittutorial.txt\nindex 036a27c..51ad814 100644\n--- a/Documentation/gittutorial.txt\n+++ b/Documentation/gittutorial.txt\n@@ -19,12 +19,37 @@ If you are instead primarily interested in using\ngit to fetch a project,\n for example, to test the latest version, you may prefer to start with\n the first two chapters of link:user-manual.html[The Git User's Manual].\n \n-First, note that you can get documentation for a command such as\n-`git log --graph` with:\n+Conventions used in this document\n+---------------------------------\n \n-------------------------------------------------\n-$ man git-log\n-------------------------------------------------\n+When discussing a git subcommand 'cmd', this documentation\n+typesets the name of it like 'git-cmd', and that is the name you\n+ask for its manual page by.\n+\n+Examples are typeset like this: `$ git cmd`. (`$` is your command\n+prompt; do not actually type it to your shell.) A subcommand\n+is specified as the first parameter to the 'git' program\n+when you actually run it from the command line.\n+\n+So a typical command description may go like this:\n+\n+To propagate the changes you made back to the original subversion\n+repository, you would use the 'git-svn dcommit' command. It does\n+these things (long description here).  Some examples:\n+\n+------------\n+$ ... some example command sequence ...\n+$ git svn dcommit\n+------------\n+\n+For full details, type:\n+\n+------------\n+$ man git-svn\n+------------\n+\n+Introducing yourself to git\n+---------------------------\n \n It is a good idea to introduce yourself to git with your name and\n public email address before doing any operation.  The easiest\n-- \n1.5.5.GIT\n"},{"id":"82080","messageId":"Pine.GSO.4.62.0807022053090.10323@harper.uchicago.edu","threadId":"14232","inReplyTo":"7vej6dmgps.fsf@gitster.siamese.dyndns.org","subject":"Re: [RFC/PATCH 7/7] Documentation formatting and cleanup","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-07-03T02:09:24Z","receivedAt":"2008-07-03T02:09:24Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Junio C Hamano writes:\n\n> Olivier Marin <dkr+ml.git@free.fr> writes:\n>\n>> Also, in Documentation/gitdiffcore.txt, you did:\n>>\n>>> -These are applied in sequence.  The set of filepairs git-diff-\\*\n>>> +These are applied in sequence.  The set of filepairs `git-diff-*`\n>>\n>> but the file does not compile, now.\n> \n> There are other places with the same breakage.\n\nSorry about that. Thanks for the fix.\n\nDo you know of a good page to read to learn that subset of Asciidoc 7\nwe use?  Right now, I am wondering: why wouldn't `git-diff-\\*` work?\n\nJonathan\n"},{"id":"82083","messageId":"Pine.GSO.4.62.0807022110460.10323@harper.uchicago.edu","threadId":"14232","inReplyTo":"486A2C8C.5050204@free.fr","subject":"Re: [RFC/PATCH 7/7] Documentation formatting and cleanup","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-07-03T02:28:17Z","receivedAt":"2008-07-03T02:28:17Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Olivier Marin wrote:\n\n> Jonathan Nieder a �crit :\n> > [184 KB patch online at\n> > <http://home.uchicago.edu/~jrnieder/20080701-git-doc-style.txt>]\n> \n> You did a lot of:\n> \n> > -replaced; you need to use a tool such as linkgit:git-diff[1] or the \"pickaxe\"\n> > +replaced; you need to use a tool such as `git-diff` or the \"pickaxe\"\n> \n> Are those kind of changes really an improvement?\n\nI should have also added\n\n\tSEE ALSO\n\t--------\n\n\tlinkgit:git-diff[1], ...\n\nbut I was trying to keep my changes minimal.  I'll send some suggestions\nfor see also sections ome time this week; I haven't found time to prune\ndown the lists of cross references I have in my tree now.  Thanks for\nthe reminder.\n\nJonathan"},{"id":"82065","messageId":"Pine.GSO.4.62.0807022322380.16085@harper.uchicago.edu","threadId":"14232","inReplyTo":"7viqvqov01.fsf@gitster.siamese.dyndns.org","subject":"Re: [PATCH 0/7] Some superficial documentation changes","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-07-03T04:31:21Z","receivedAt":"2008-07-03T04:31:21Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"On Tue, 1 Jul 2008, Junio C Hamano wrote:\n\n> In general, I've always preferred to see command names \"git-foo\" typeset\n> in teletype face, consistent with examples (also typeset in tt), because\n> they are both something the end users are expected to type.  With this\n> transition, we are however making \"git-foo\" not something users are\n> expected to type, which means that the use of a typeface that is different\n> from the body text to spell command names is now strictly for making them\n> stand out in context.\n>\n> [...] If you\n> also prefer 'italics' and list agrees, it might be a better idea to also\n> apply that patch when I do so, as that step is the most error prone one\n> and benefits from more eyeballs.\n\nI am not sure whether the list agrees, but I do prefer italics.\nI haven't finished making the user manual use italics yet, but\nhere are some patches to make the man pages do so. I also included\nsome formatting fixes irrelevant to that purpose to problems I found\nalong the way.\n\nI was surprised to get so much feedback with the patches I sent earlier\nthis week.  Thanks!  I hope you find as much interesting in this series.\nThe bulk of the changes are in patch 11, which only replaces backticks\nwith apostrophes.\n\nJonathan\n\n  git-format-patch(1): fix stray \\ in output\n  Documentation: fix gitlinks\n  manpages: fix bogus whitespace\n  git(1): add comma\n  git-add(1): depersonalize description\n  Documentation: rewrap to prepare for \"git-\" vs \"git \" change\n  Documentation: more \"git-\" versus \"git \" changes\n  gitdiffcore(7): fix awkward wording\n  manpages: italicize command names in synopses\n  manpages: italicize names of commands\n  manpages: italicize git command names (which were in teletype font)\n  manpages: italicize gitk's name (where it was in teletype font)\n  manpages: italicize nongit command names (which were in teletype font)\n  manpages: italicize git subcommand names (which were in teletype font)\n  manpages: use teletype font for sample command lines\n\n Documentation/config.txt                |   70 ++++++------\n Documentation/fetch-options.txt         |    8 +-\n Documentation/git-am.txt                |   14 +-\n Documentation/git-apply.txt             |   18 ++--\n Documentation/git-archimport.txt        |   12 +-\n Documentation/git-archive.txt           |    6 +-\n Documentation/git-bisect.txt            |    8 +-\n Documentation/git-blame.txt             |    8 +-\n Documentation/git-branch.txt            |    8 +-\n Documentation/git-bundle.txt            |   26 ++--\n Documentation/git-check-ref-format.txt  |    2 +-\n Documentation/git-checkout-index.txt    |    8 +-\n Documentation/git-checkout.txt          |    4 +-\n Documentation/git-cherry-pick.txt       |    2 +-\n Documentation/git-cherry.txt            |    6 +-\n Documentation/git-citool.txt            |    4 +-\n Documentation/git-clean.txt             |    4 +-\n Documentation/git-clone.txt             |    6 +-\n Documentation/git-commit-tree.txt       |    2 +-\n Documentation/git-commit.txt            |   26 ++--\n Documentation/git-config.txt            |   12 +-\n Documentation/git-cvsexportcommit.txt   |    2 +-\n Documentation/git-cvsimport.txt         |   18 ++--\n Documentation/git-cvsserver.txt         |   40 ++++----\n Documentation/git-daemon.txt            |   40 ++++----\n Documentation/git-describe.txt          |    6 +-\n Documentation/git-diff-files.txt        |    2 +-\n Documentation/git-diff-index.txt        |   20 ++--\n Documentation/git-diff-tree.txt         |   10 +-\n Documentation/git-fast-export.txt       |    8 +-\n Documentation/git-fast-import.txt       |   22 ++--\n Documentation/git-fetch-pack.txt        |   14 +-\n Documentation/git-fetch.txt             |    2 +-\n Documentation/git-filter-branch.txt     |   14 +-\n Documentation/git-fmt-merge-msg.txt     |    4 +-\n Documentation/git-for-each-ref.txt      |    2 +-\n Documentation/git-format-patch.txt      |   18 ++--\n Documentation/git-fsck.txt              |    6 +-\n Documentation/git-gc.txt                |   20 ++--\n Documentation/git-get-tar-commit-id.txt |    6 +-\n Documentation/git-grep.txt              |    2 +-\n Documentation/git-gui.txt               |   28 +++---\n Documentation/git-hash-object.txt       |    2 +-\n Documentation/git-help.txt              |   10 +-\n Documentation/git-http-fetch.txt        |    2 +-\n Documentation/git-imap-send.txt         |    2 +-\n Documentation/git-index-pack.txt        |    8 +-\n Documentation/git-init.txt              |    6 +-\n Documentation/git-instaweb.txt          |    2 +-\n Documentation/git-log.txt               |    4 +-\n Documentation/git-ls-files.txt          |    6 +-\n Documentation/git-ls-remote.txt         |    2 +-\n Documentation/git-mailinfo.txt          |    4 +-\n Documentation/git-merge-base.txt        |    4 +-\n Documentation/git-merge-file.txt        |   14 +-\n Documentation/git-merge-index.txt       |   14 +-\n Documentation/git-merge-one-file.txt    |    4 +-\n Documentation/git-merge.txt             |   16 ++--\n Documentation/git-mergetool.txt         |   16 ++--\n Documentation/git-name-rev.txt          |    6 +-\n Documentation/git-pack-objects.txt      |    6 +-\n Documentation/git-pack-redundant.txt    |    2 +-\n Documentation/git-parse-remote.txt      |    2 +-\n Documentation/git-patch-id.txt          |    2 +-\n Documentation/git-peek-remote.txt       |    6 +-\n Documentation/git-prune.txt             |   14 +-\n Documentation/git-pull.txt              |   10 +-\n Documentation/git-push.txt              |    4 +-\n Documentation/git-read-tree.txt         |   42 ++++----\n Documentation/git-rebase.txt            |   30 +++---\n Documentation/git-receive-pack.txt      |   12 +-\n Documentation/git-reflog.txt            |   16 ++--\n Documentation/git-remote.txt            |   12 +-\n Documentation/git-repack.txt            |   16 ++--\n Documentation/git-rerere.txt            |   34 +++---\n Documentation/git-reset.txt             |    2 +-\n Documentation/git-rev-list.txt          |    6 +-\n Documentation/git-rev-parse.txt         |   24 ++--\n Documentation/git-revert.txt            |    4 +-\n Documentation/git-rm.txt                |    4 +-\n Documentation/git-send-pack.txt         |   10 +-\n Documentation/git-sh-setup.txt          |    2 +-\n Documentation/git-shell.txt             |    2 +-\n Documentation/git-shortlog.txt          |    4 +-\n Documentation/git-show-branch.txt       |    2 +-\n Documentation/git-show-index.txt        |    4 +-\n Documentation/git-show-ref.txt          |    4 +-\n Documentation/git-show.txt              |    6 +-\n Documentation/git-stash.txt             |    6 +-\n Documentation/git-status.txt            |    6 +-\n Documentation/git-submodule.txt         |    4 +-\n Documentation/git-svn.txt               |  106 +++++++++---------\n Documentation/git-symbolic-ref.txt      |    2 +-\n Documentation/git-tag.txt               |    8 +-\n Documentation/git-tar-tree.txt          |    6 +-\n Documentation/git-update-index.txt      |   22 ++--\n Documentation/git-upload-archive.txt    |    2 +-\n Documentation/git-upload-pack.txt       |    6 +-\n Documentation/git-var.txt               |    2 +-\n Documentation/git-verify-pack.txt       |    2 +-\n Documentation/git-verify-tag.txt        |    2 +-\n Documentation/git-web--browse.txt       |    6 +-\n Documentation/git-whatchanged.txt       |    4 +-\n Documentation/git-write-tree.txt        |    8 +-\n Documentation/git.txt                   |   16 ++--\n Documentation/gitattributes.txt         |   22 ++--\n Documentation/gitcore-tutorial.txt      |  188 +++++++++++++++---------------\n Documentation/gitcvs-migration.txt      |   18 ++--\n Documentation/gitdiffcore.txt           |   38 +++---\n Documentation/githooks.txt              |   74 ++++++------\n Documentation/gitignore.txt             |    4 +-\n Documentation/gitk.txt                  |    2 +-\n Documentation/gitrepository-layout.txt  |   18 ++--\n Documentation/gittutorial-2.txt         |   16 ++--\n Documentation/gittutorial.txt           |   79 +++++++++-----\n Documentation/i18n.txt                  |    4 +-\n Documentation/merge-options.txt         |    4 +-\n Documentation/pull-fetch-param.txt      |    8 +-\n Documentation/urls-remotes.txt          |    4 +-\n Documentation/user-manual.txt           |   42 ++++----\n 120 files changed, 848 insertions(+), 823 deletions(-)\n"},{"id":"82078","messageId":"Pine.GSO.4.62.0807022332540.16085@harper.uchicago.edu","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0807022322380.16085@harper.uchicago.edu","subject":"[PATCH 01/15] git-format-patch(1): fix stray \\ in output","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-07-03T04:47:05Z","receivedAt":"2008-07-03T04:47:05Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"In listing blocks (set off by rows of dashes), the usual\nformatting characters of asciidoc are instead rendered verbatim.\nWhen the escaped double-hyphen of olden days is moved into such a\nblock along with other formatting improvements, it becomes\nbackslash-dash-dash.\n\nSo we remove the backslash.\n\nSigned-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n---\n Documentation/git-format-patch.txt |    2 +-\n 1 files changed, 1 insertions(+), 1 deletions(-)\n\ndiff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt\nindex 894b82d..3c9192a 100644\n--- a/Documentation/git-format-patch.txt\n+++ b/Documentation/git-format-patch.txt\n@@ -206,7 +206,7 @@ For each commit a separate file is created in the current directory.\n project:\n +\n ------------\n-$ git format-patch \\--root origin\n+$ git format-patch --root origin\n ------------\n \n * The same as the previous one:\n-- \n1.5.5.GIT\n"},{"id":"82077","messageId":"Pine.GSO.4.62.0807022347200.16085@harper.uchicago.edu","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0807022322380.16085@harper.uchicago.edu","subject":"[PATCH 02/15] Documentation: fix gitlinks","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-07-03T04:54:38Z","receivedAt":"2008-07-03T04:54:38Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n---\n Documentation/git-repack.txt  |    2 +-\n Documentation/user-manual.txt |    2 +-\n 2 files changed, 2 insertions(+), 2 deletions(-)\n\ndiff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt\nindex 0d72e83..c956aff 100644\n--- a/Documentation/git-repack.txt\n+++ b/Documentation/git-repack.txt\n@@ -72,7 +72,7 @@ OPTIONS\n \t`git-update-server-info`.  This option skips\n \tupdating local catalog files needed to publish\n \tthis repository (or a direct copy of it)\n-\tover HTTP or FTP.  See gitlink:git-update-server-info[1].\n+\tover HTTP or FTP.  See linkgit:git-update-server-info[1].\n \n --window=[N]::\n --depth=[N]::\ndiff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt\nindex ca13266..cbfc5d0 100644\n--- a/Documentation/user-manual.txt\n+++ b/Documentation/user-manual.txt\n@@ -1303,7 +1303,7 @@ $ git diff -3 file.txt\t\t# diff against stage 3\n $ git diff --theirs file.txt\t# same as the above.\n -------------------------------------------------\n \n-The linkgit:git-log[1] and gitk[1] commands also provide special help\n+The linkgit:git-log[1] and linkgit:gitk[1] commands also provide special help\n for merges:\n \n -------------------------------------------------\n-- \n1.5.5.GIT\n"},{"id":"82068","messageId":"Pine.GSO.4.62.0807022354520.16085@harper.uchicago.edu","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0807022322380.16085@harper.uchicago.edu","subject":"[PATCH 03/15] manpages: fix bogus whitespace","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-07-03T05:03:54Z","receivedAt":"2008-07-03T05:03:54Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"It's distracting.\n\nSigned-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n---\n Documentation/git-fast-import.txt  |    2 +-\n Documentation/git-format-patch.txt |    8 ++++----\n Documentation/git-gui.txt          |    4 ++--\n 3 files changed, 7 insertions(+), 7 deletions(-)\n\ndiff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt\nindex 70cc8e8..9602764 100644\n--- a/Documentation/git-fast-import.txt\n+++ b/Documentation/git-fast-import.txt\n@@ -86,7 +86,7 @@ OPTIONS\n \n --quiet::\n \tDisable all non-fatal output, making fast-import silent when it\n-\tis successful.\tThis option disables the output shown by\n+\tis successful.  This option disables the output shown by\n \t\\--stats.\n \n --stats::\ndiff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt\nindex 3c9192a..b990052 100644\n--- a/Documentation/git-format-patch.txt\n+++ b/Documentation/git-format-patch.txt\n@@ -175,10 +175,10 @@ and file suffix, and number patches when outputting more than one.\n \n ------------\n [format]\n-        headers = \"Organization: git-foo\\n\"\n-        subjectprefix = CHANGE\n-        suffix = .txt\n-        numbered = auto\n+\theaders = \"Organization: git-foo\\n\"\n+\tsubjectprefix = CHANGE\n+\tsuffix = .txt\n+\tnumbered = auto\n \tcc = <email>\n ------------\n \ndiff --git a/Documentation/git-gui.txt b/Documentation/git-gui.txt\nindex 940e43f..ea1e4ce 100644\n--- a/Documentation/git-gui.txt\n+++ b/Documentation/git-gui.txt\n@@ -34,7 +34,7 @@ blame::\n \n browser::\n \tStart a tree browser showing all files in the specified\n-\tcommit (or 'HEAD' by default).\tFiles selected through the\n+\tcommit (or 'HEAD' by default).  Files selected through the\n \tbrowser are opened in the blame viewer.\n \n citool::\n@@ -61,7 +61,7 @@ git gui blame Makefile::\n git gui blame v0.99.8 Makefile::\n \n \tShow the contents of 'Makefile' in revision 'v0.99.8'\n-\tand provide annotations for each line.\tUnlike the above\n+\tand provide annotations for each line.  Unlike the above\n \texample the file is read from the object database and not\n \tthe working directory.\n \n-- \n1.5.5.GIT\n"},{"id":"82081","messageId":"Pine.GSO.4.62.0807030004070.16085@harper.uchicago.edu","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0807022322380.16085@harper.uchicago.edu","subject":"[PATCH 04/15] git(1): add comma","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-07-03T05:08:12Z","receivedAt":"2008-07-03T05:08:12Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n---\n Documentation/git.txt |    2 +-\n 1 files changed, 1 insertions(+), 1 deletions(-)\n\ndiff --git a/Documentation/git.txt b/Documentation/git.txt\nindex f9e4416..5f4d666 100644\n--- a/Documentation/git.txt\n+++ b/Documentation/git.txt\n@@ -141,7 +141,7 @@ help ...'.\n --exec-path::\n \tPath to wherever your core git programs are installed.\n \tThis can also be controlled by setting the GIT_EXEC_PATH\n-\tenvironment variable. If no path is given 'git' will print\n+\tenvironment variable. If no path is given, 'git' will print\n \tthe current setting and then exit.\n \n -p::\n-- \n1.5.5.GIT\n"},{"id":"82069","messageId":"Pine.GSO.4.62.0807030008200.16085@harper.uchicago.edu","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0807022322380.16085@harper.uchicago.edu","subject":"[PATCH 05/15] git-commit(1): depersonalize description","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-07-03T05:13:45Z","receivedAt":"2008-07-03T05:13:45Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"The intent is to make git-commit(1) feel more like a manual page.  The\nchange also makes the page four words shorter.\n\nSigned-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n---\n Documentation/git-commit.txt |    4 ++--\n 1 files changed, 2 insertions(+), 2 deletions(-)\n\ndiff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt\nindex 03594cd..0ac6204 100644\n--- a/Documentation/git-commit.txt\n+++ b/Documentation/git-commit.txt\n@@ -15,8 +15,8 @@ SYNOPSIS\n \n DESCRIPTION\n -----------\n-Use 'git commit' to store the current contents of the index in a new\n-commit along with a log message describing the changes you have made.\n+Stores the current contents of the index in a new commit along\n+with a log message from the user describing the changes.\n \n The content to be added can be specified in several ways:\n \n-- \n1.5.5.GIT\n"},{"id":"82079","messageId":"Pine.GSO.4.62.0807030013570.16085@harper.uchicago.edu","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0807022322380.16085@harper.uchicago.edu","subject":"[PATCH 06/15] Documentation: rewrap to prepare for \"git-\" vs \"git \" change","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-07-03T05:20:21Z","receivedAt":"2008-07-03T05:20:21Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Rewrap lines in preparation for added dashes.\n\nSigned-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n---\n Documentation/config.txt      |    4 ++--\n Documentation/user-manual.txt |    8 ++++----\n 2 files changed, 6 insertions(+), 6 deletions(-)\n\ndiff --git a/Documentation/config.txt b/Documentation/config.txt\nindex 52d01b8..498247a 100644\n--- a/Documentation/config.txt\n+++ b/Documentation/config.txt\n@@ -627,8 +627,8 @@ gc.autopacklimit::\n gc.packrefs::\n \t`git gc` does not run `git pack-refs` in a bare repository by\n \tdefault so that older dumb-transport clients can still fetch\n-\tfrom the repository.  Setting this to `true` lets `git\n-\tgc` to run `git pack-refs`.  Setting this to `false` tells\n+\tfrom the repository.  Setting this to `true` lets `git gc`\n+\tto run `git pack-refs`.  Setting this to `false` tells\n \t`git gc` never to run `git pack-refs`. The default setting is\n \t`notbare`. Enable it only when you know you do not have to\n \tsupport such clients.  The default setting will change to `true`\ndiff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt\nindex cbfc5d0..61cf30f 100644\n--- a/Documentation/user-manual.txt\n+++ b/Documentation/user-manual.txt\n@@ -2443,8 +2443,8 @@ patches to the new mywork.  The result will look like:\n ................................................\n \n In the process, it may discover conflicts.  In that case it will stop\n-and allow you to fix the conflicts; after fixing conflicts, use \"git\n-add\" to update the index with those contents, and then, instead of\n+and allow you to fix the conflicts; after fixing conflicts, use \"git add\"\n+to update the index with those contents, and then, instead of\n running git-commit, just run\n \n -------------------------------------------------\n@@ -2700,8 +2700,8 @@ master branch.  In more detail:\n git fetch and fast-forwards\n ---------------------------\n \n-In the previous example, when updating an existing branch, \"git\n-fetch\" checks to make sure that the most recent commit on the remote\n+In the previous example, when updating an existing branch, \"git fetch\"\n+checks to make sure that the most recent commit on the remote\n branch is a descendant of the most recent commit on your copy of the\n branch before updating your copy of the branch to point at the new\n commit.  Git calls this process a <<fast-forwards,fast forward>>.\n-- \n1.5.5.GIT\n"},{"id":"82066","messageId":"Pine.GSO.4.62.0807030020390.16085@harper.uchicago.edu","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0807022322380.16085@harper.uchicago.edu","subject":"[PATCH 07/15] Documentation: more \"git-\" versus \"git \" changes","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-07-03T05:28:15Z","receivedAt":"2008-07-03T05:28:15Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"With git-commands moving out of $(bindir), it is useful to make a\nclearer distinction between the git subcommand 'git-whatever' and\nthe command you type, `git whatever <options>`.  So we use a dash\nafter \"git\" when referring to the former and not the latter.\n\nI already sent a patch doing this same thing, but I missed some\nspots.\n\nSigned-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n---\n Documentation/config.txt            |   52 +++++++++++++++++-----------------\n Documentation/git-bisect.txt        |    4 +-\n Documentation/git-commit.txt        |    2 +-\n Documentation/git-filter-branch.txt |    2 +-\n Documentation/git-format-patch.txt  |    2 +-\n Documentation/git-help.txt          |    2 +-\n Documentation/git-rebase.txt        |    4 +-\n Documentation/git-reflog.txt        |    2 +-\n Documentation/git-remote.txt        |    2 +-\n Documentation/git-rerere.txt        |    2 +-\n Documentation/git-shortlog.txt      |    2 +-\n Documentation/gitcore-tutorial.txt  |   30 ++++++++++----------\n Documentation/user-manual.txt       |   36 ++++++++++++------------\n 13 files changed, 71 insertions(+), 71 deletions(-)\n\ndiff --git a/Documentation/config.txt b/Documentation/config.txt\nindex 498247a..5a98a5b 100644\n--- a/Documentation/config.txt\n+++ b/Documentation/config.txt\n@@ -356,8 +356,8 @@ core.pager::\n \n core.whitespace::\n \tA comma separated list of common whitespace problems to\n-\tnotice.  `git diff` will use `color.diff.whitespace` to\n-\thighlight them, and `git apply --whitespace=error` will\n+\tnotice.  `git-diff` will use `color.diff.whitespace` to\n+\thighlight them, and `git-apply --whitespace=error` will\n \tconsider them as errors:\n +\n * `trailing-space` treats trailing whitespaces at the end of the line\n@@ -426,20 +426,20 @@ branch.autosetuprebase::\n \tThis option defaults to never.\n \n branch.<name>.remote::\n-\tWhen in branch <name>, it tells `git fetch` which remote to fetch.\n-\tIf this option is not given, `git fetch` defaults to remote \"origin\".\n+\tWhen in branch <name>, it tells `git-fetch` which remote to fetch.\n+\tIf this option is not given, `git-fetch` defaults to remote \"origin\".\n \n branch.<name>.merge::\n-\tWhen in branch <name>, it tells `git fetch` the default\n+\tWhen in branch <name>, it tells `git-fetch` the default\n \trefspec to be marked for merging in FETCH_HEAD. The value is\n \thandled like the remote part of a refspec, and must match a\n \tref which is fetched from the remote given by\n \t\"branch.<name>.remote\".\n-\tThe merge information is used by `git pull` (which at first calls\n-\t`git fetch`) to lookup the default branch for merging. Without\n-\tthis option, `git pull` defaults to merge the first refspec fetched.\n+\tThe merge information is used by `git-pull` (which at first calls\n+\t`git-fetch`) to lookup the default branch for merging. Without\n+\tthis option, `git-pull` defaults to merge the first refspec fetched.\n \tSpecify multiple values to get an octopus merge.\n-\tIf you wish to setup `git pull` so that it merges into <name> from\n+\tIf you wish to setup `git-pull` so that it merges into <name> from\n \tanother branch in the local repository, you can point\n \tbranch.<name>.merge to the desired branch, and use the special setting\n \t`.` (a period) for branch.<name>.remote.\n@@ -508,12 +508,12 @@ color.diff.<slot>::\n \n color.interactive::\n \tWhen set to `always`, always use colors for interactive prompts\n-\tand displays (such as those used by \"git add --interactive\").\n+\tand displays (such as those used by \"git-add --interactive\").\n \tWhen false (or `never`), never.  When set to `true` or `auto`, use\n \tcolors only when the output is to the terminal. Defaults to false.\n \n color.interactive.<slot>::\n-\tUse customized color for `git add --interactive`\n+\tUse customized color for `git-add --interactive`\n \toutput. `<slot>` may be `prompt`, `header`, or `help`, for\n \tthree distinct types of normal output from interactive\n \tprograms.  The values of these variables may be specified as\n@@ -550,14 +550,14 @@ color.ui::\n \ttake precedence over this setting. Defaults to false.\n \n diff.autorefreshindex::\n-\tWhen using `git diff` to compare with work tree\n+\tWhen using `git-diff` to compare with work tree\n \tfiles, do not consider stat-only change as changed.\n \tInstead, silently run `git update-index --refresh` to\n \tupdate the cached stat information for paths whose\n \tcontents in the work tree match the contents in the\n \tindex.  This option defaults to true.  Note that this\n-\taffects only `git diff` Porcelain, and not lower level\n-\t`diff` commands, such as `git diff-files`.\n+\taffects only `git-diff` Porcelain, and not lower level\n+\t`diff` commands, such as `git-diff-files`.\n \n diff.external::\n \tIf this config variable is set, diff generation is not\n@@ -568,7 +568,7 @@ diff.external::\n \n diff.renameLimit::\n \tThe number of files to consider when performing the copy/rename\n-\tdetection; equivalent to the git diff option '-l'.\n+\tdetection; equivalent to the git-diff option '-l'.\n \n diff.renames::\n \tTells git to detect renames.  If set to any boolean value, it\n@@ -608,7 +608,7 @@ format.pretty::\n \n gc.aggressiveWindow::\n \tThe window size parameter used in the delta compression\n-\talgorithm used by 'git gc --aggressive'.  This defaults\n+\talgorithm used by 'git-gc --aggressive'.  This defaults\n \tto 10.\n \n gc.auto::\n@@ -625,37 +625,37 @@ gc.autopacklimit::\n \tdefault\tvalue is 50.  Setting this to 0 disables it.\n \n gc.packrefs::\n-\t`git gc` does not run `git pack-refs` in a bare repository by\n+\t`git-gc` does not run `git pack-refs` in a bare repository by\n \tdefault so that older dumb-transport clients can still fetch\n-\tfrom the repository.  Setting this to `true` lets `git gc`\n+\tfrom the repository.  Setting this to `true` lets `git-gc`\n \tto run `git pack-refs`.  Setting this to `false` tells\n-\t`git gc` never to run `git pack-refs`. The default setting is\n+\t`git-gc` never to run `git pack-refs`. The default setting is\n \t`notbare`. Enable it only when you know you do not have to\n \tsupport such clients.  The default setting will change to `true`\n \tat some stage, and setting this to `false` will continue to\n-\tprevent `git pack-refs` from being run from `git gc`.\n+\tprevent `git pack-refs` from being run from `git-gc`.\n \n gc.pruneexpire::\n-\tWhen `git gc` is run, it will call `prune --expire 2.weeks.ago`.\n+\tWhen `git-gc` is run, it will call `prune --expire 2.weeks.ago`.\n \tOverride the grace period with this config variable.\n \n gc.reflogexpire::\n-\t`git reflog expire` removes reflog entries older than\n+\t`git-reflog expire` removes reflog entries older than\n \tthis time; defaults to 90 days.\n \n gc.reflogexpireunreachable::\n-\t`git reflog expire` removes reflog entries older than\n+\t`git-reflog expire` removes reflog entries older than\n \tthis time and are not reachable from the current tip;\n \tdefaults to 30 days.\n \n gc.rerereresolved::\n \tRecords of conflicted merge you resolved earlier are\n-\tkept for this many days when `git rerere gc` is run.\n+\tkept for this many days when `git-rerere gc` is run.\n \tThe default is 60 days.  See linkgit:git-rerere[1].\n \n gc.rerereunresolved::\n \tRecords of conflicted merge you have not resolved are\n-\tkept for this many days when `git rerere gc` is run.\n+\tkept for this many days when `git-rerere gc` is run.\n \tThe default is 15 days.  See linkgit:git-rerere[1].\n \n rerere.autoupdate::\n@@ -849,7 +849,7 @@ instaweb.port::\n \n log.date::\n \tSet default date-time mode for the log command. Setting log.date\n-\tvalue is similar to using git log's --date option. The value is one of\n+\tvalue is similar to using git-log's --date option. The value is one of the\n \tfollowing alternatives: {relative,local,default,iso,rfc,short}.\n \tSee linkgit:git-log[1].\n \ndiff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt\nindex 8bbcb94..a13983f 100644\n--- a/Documentation/git-bisect.txt\n+++ b/Documentation/git-bisect.txt\n@@ -26,7 +26,7 @@ on the subcommand:\n  git bisect log\n  git bisect run <cmd>...\n \n-This command uses `git rev-list --bisect` to help drive the\n+This command uses `git-rev-list --bisect` to help drive the\n binary search process to find which change introduced a bug, given an\n old \"good\" commit object name and a later \"bad\" commit object name.\n \n@@ -101,7 +101,7 @@ $ git bisect visualize\n to see the currently remaining suspects in `gitk`.  `visualize` is a bit\n too long to type and `view` is provided as a synonym.\n \n-If `DISPLAY` environment variable is not set, `git log` is used\n+If 'DISPLAY' environment variable is not set, `git-log` is used\n instead.  You can even give command line options such as `-p` and\n `--stat`.\n \ndiff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt\nindex 0ac6204..9812dbd 100644\n--- a/Documentation/git-commit.txt\n+++ b/Documentation/git-commit.txt\n@@ -155,7 +155,7 @@ but can be used to amend a merge commit.\n \tMake a commit only from the paths specified on the\n \tcommand line, disregarding any contents that have been\n \tstaged so far. This is the default mode of operation of\n-\t'git commit' if any paths are given on the command line,\n+\t'git-commit' if any paths are given on the command line,\n \tin which case this option can be omitted.\n \tIf this option is specified together with '--amend', then\n \tno paths need be specified, which can be used to amend\ndiff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt\nindex a9388e0..4262309 100644\n--- a/Documentation/git-filter-branch.txt\n+++ b/Documentation/git-filter-branch.txt\n@@ -163,7 +163,7 @@ to other tags will be rewritten to point to the underlying commit.\n \n -f::\n --force::\n-\t`git filter-branch` refuses to start with an existing temporary\n+\t`git-filter-branch` refuses to start with an existing temporary\n \tdirectory or when there are already refs starting with\n \t'refs/original/', unless forced.\n \ndiff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt\nindex b990052..41e487a 100644\n--- a/Documentation/git-format-patch.txt\n+++ b/Documentation/git-format-patch.txt\n@@ -190,7 +190,7 @@ EXAMPLES\n the current branch using `git-am` to cherry-pick them:\n +\n ------------\n-$ git format-patch -k --stdout R1..R2 | git-am -3 -k\n+$ git format-patch -k --stdout R1..R2 | git am -3 -k\n ------------\n \n * Extract all commits which are in the current branch but not in the\ndiff --git a/Documentation/git-help.txt b/Documentation/git-help.txt\nindex 5ace863..73ec7ad 100644\n--- a/Documentation/git-help.txt\n+++ b/Documentation/git-help.txt\n@@ -120,7 +120,7 @@ man.<tool>.path\n You can explicitly provide a full path to your preferred man viewer by\n setting the configuration variable 'man.<tool>.path'. For example, you\n can configure the absolute path to konqueror by setting\n-'man.konqueror.path'. Otherwise, 'git help' assumes the tool is\n+'man.konqueror.path'. Otherwise, 'git-help' assumes the tool is\n available in PATH.\n \n man.<tool>.cmd\ndiff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt\nindex 754230e..67aa497 100644\n--- a/Documentation/git-rebase.txt\n+++ b/Documentation/git-rebase.txt\n@@ -259,10 +259,10 @@ NOTES\n When you rebase a branch, you are changing its history in a way that\n will cause problems for anyone who already has a copy of the branch\n in their repository and tries to pull updates from you.  You should\n-understand the implications of using 'git rebase' on a repository that\n+understand the implications of using 'git-rebase' on a repository that\n you share.\n \n-When the git rebase command is run, it will first execute a \"pre-rebase\"\n+When the git-rebase command is run, it will first execute a \"pre-rebase\"\n hook if one exists.  You can use this hook to do sanity checks and\n reject the rebase if it isn't appropriate.  Please see the template\n pre-rebase hook script for an example.\ndiff --git a/Documentation/git-reflog.txt b/Documentation/git-reflog.txt\nindex 8492aea..d963c51 100644\n--- a/Documentation/git-reflog.txt\n+++ b/Documentation/git-reflog.txt\n@@ -60,7 +60,7 @@ OPTIONS\n \trefs.\n +\n This computation involves traversing all the reachable objects, i.e. it\n-has the same cost as 'git prune'.  Fortunately, once this is run, we\n+has the same cost as 'git-prune'.  Fortunately, once this is run, we\n should not have to ever worry about missing objects, because the current\n prune and pack-objects know about reflogs and protect objects referred by\n them.\ndiff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt\nindex 32db0ae..3634efd 100644\n--- a/Documentation/git-remote.txt\n+++ b/Documentation/git-remote.txt\n@@ -124,7 +124,7 @@ $ git checkout -b nfs linux-nfs/master\n ...\n ------------\n \n-* Imitate 'git clone' but track only selected branches\n+* Imitate 'git-clone' but track only selected branches\n +\n ------------\n $ mkdir project.git\ndiff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt\nindex 3458029..ae2b2b5 100644\n--- a/Documentation/git-rerere.txt\n+++ b/Documentation/git-rerere.txt\n@@ -163,7 +163,7 @@ If this three-way merge resolves cleanly, the result is written\n out to your working tree file, so you would not have to manually\n resolve it.  Note that `git-rerere` leaves the index file alone,\n so you still need to do the final sanity checks with `git diff`\n-(or `git diff -c`) and `git add` when you are satisfied.\n+(or `git diff -c`) and `git-add` when you are satisfied.\n \n As a convenience measure, `git-merge` automatically invokes\n `git-rerere` when it exits with a failed automerge, which\ndiff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt\nindex 6e4cbc4..74a5f29 100644\n--- a/Documentation/git-shortlog.txt\n+++ b/Documentation/git-shortlog.txt\n@@ -3,7 +3,7 @@ git-shortlog(1)\n \n NAME\n ----\n-git-shortlog - Summarize 'git log' output\n+git-shortlog - Summarize 'git-log' output\n \n SYNOPSIS\n --------\ndiff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt\nindex 7d721c5..059c8ff 100644\n--- a/Documentation/gitcore-tutorial.txt\n+++ b/Documentation/gitcore-tutorial.txt\n@@ -595,7 +595,7 @@ pointer to the state you want to tag, but also a small tag name and\n message, along with optionally a PGP signature that says that yes,\n you really did\n that tag. You create these annotated tags with either the `-a` or\n-`-s` flag to `git tag`:\n+`-s` flag to `git-tag`:\n \n ----------------\n $ git tag -s <tagname>\n@@ -642,7 +642,7 @@ and it will be gone. There's no external repository, and there's no\n history outside the project you created.\n \n  - if you want to move or duplicate a git repository, you can do so. There\n-   is `git clone` command, but if all you want to do is just to\n+   is `git-clone` command, but if all you want to do is just to\n    create a copy of your repository (with all the full history that\n    went along with it), you can do so with a regular\n    `cp -a git-tutorial new-git-tutorial`.\n@@ -776,7 +776,7 @@ to it.\n ================================================\n If you make the decision to start your new branch at some\n other point in the history than the current `HEAD`, you can do so by\n-just telling `git checkout` what the base of the checkout would be.\n+just telling `git-checkout` what the base of the checkout would be.\n In other words, if you have an earlier tag or branch, you'd just do\n \n ------------\n@@ -819,7 +819,7 @@ $ git branch <branchname> [startingpoint]\n \n which will simply _create_ the branch, but will not do anything further.\n You can then later -- once you decide that you want to actually develop\n-on that branch -- switch to that branch with a regular `git checkout`\n+on that branch -- switch to that branch with a regular `git-checkout`\n with the branchname as the argument.\n \n \n@@ -881,7 +881,7 @@ source.\n Anyway, let's exit `gitk` (`^Q` or the File menu), and decide that we want\n to merge the work we did on the `mybranch` branch into the `master`\n branch (which is currently our `HEAD` too). To do that, there's a nice\n-script called `git merge`, which wants to know which branches you want\n+script called `git-merge`, which wants to know which branches you want\n to resolve and what the merge is all about:\n \n ------------\n@@ -1023,12 +1023,12 @@ Merging external work\n It's usually much more common that you merge with somebody else than\n merging with your own branches, so it's worth pointing out that git\n makes that very easy too, and in fact, it's not that different from\n-doing a `git merge`. In fact, a remote merge ends up being nothing\n+doing a `git-merge`. In fact, a remote merge ends up being nothing\n more than \"fetch the work from a remote repository into a temporary tag\"\n-followed by a `git merge`.\n+followed by a `git-merge`.\n \n Fetching from a remote repository is done by, unsurprisingly,\n-`git fetch`:\n+`git-fetch`:\n \n ----------------\n $ git fetch <remote-repository>\n@@ -1115,7 +1115,7 @@ argument.\n [NOTE]\n You could do without using any branches at all, by\n keeping as many local repositories as you would like to have\n-branches, and merging between them with `git pull`, just like\n+branches, and merging between them with `git-pull`, just like\n you merge between branches. The advantage of this approach is\n that it lets you keep a set of files for each `branch` checked\n out and you may find it easier to switch back and forth if you\n@@ -1132,7 +1132,7 @@ like this:\n $ git config remote.linus.url http://www.kernel.org/pub/scm/git/git.git/\n ------------------------------------------------\n \n-and use the \"linus\" keyword with `git pull` instead of the full URL.\n+and use the \"linus\" keyword with `git-pull` instead of the full URL.\n \n Examples.\n \n@@ -1168,7 +1168,7 @@ $ git show-branch --more=2 master mybranch\n +* [master^] Some fun.\n ------------\n \n-Remember, before running `git merge`, our `master` head was at\n+Remember, before running `git-merge`, our `master` head was at\n \"Some fun.\" commit, while our `mybranch` head was at \"Some\n work.\" commit.\n \n@@ -1345,7 +1345,7 @@ $ mkdir my-git.git\n ------------\n \n Then, make that directory into a git repository by running\n-`git init`, but this time, since its name is not the usual\n+`git-init`, but this time, since its name is not the usual\n `.git`, we do things slightly differently:\n \n ------------\n@@ -1407,7 +1407,7 @@ $ git repack\n \n will do it for you. If you followed the tutorial examples, you\n would have accumulated about 17 objects in `.git/objects/??/`\n-directories by now. `git repack` tells you how many objects it\n+directories by now. `git-repack` tells you how many objects it\n packed, and stores the packed file in `.git/objects/pack`\n directory.\n \n@@ -1656,8 +1656,8 @@ $ git reset --hard master~2\n ------------\n \n You can make sure 'git show-branch' matches the state before\n-those two 'git merge' you just did.  Then, instead of running\n-two 'git merge' commands in a row, you would merge these two\n+those two 'git-merge' you just did.  Then, instead of running\n+two 'git-merge' commands in a row, you would merge these two\n branch heads (this is known as 'making an Octopus'):\n \n ------------\ndiff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt\nindex 61cf30f..01c1af6 100644\n--- a/Documentation/user-manual.txt\n+++ b/Documentation/user-manual.txt\n@@ -1963,10 +1963,10 @@ error: failed to push to 'ssh://yourserver.com/~you/proj.git'\n \n This can happen, for example, if you:\n \n-\t- use `git reset --hard` to remove already-published commits, or\n-\t- use `git commit --amend` to replace already-published commits\n+\t- use `git-reset --hard` to remove already-published commits, or\n+\t- use `git-commit --amend` to replace already-published commits\n \t  (as in <<fixing-a-mistake-by-rewriting-history>>), or\n-\t- use `git rebase` to rebase any already-published commits (as\n+\t- use `git-rebase` to rebase any already-published commits (as\n \t  in <<using-git-rebase>>).\n \n You may force git-push to perform the update anyway by preceding the\n@@ -2170,7 +2170,7 @@ they are for, or what status they are in.  To get a reminder of what\n changes are in a specific branch, use:\n \n -------------------------------------------------\n-$ git log linux..branchname | git-shortlog\n+$ git log linux..branchname | git shortlog\n -------------------------------------------------\n \n To see whether it has already been merged into the test or release branches,\n@@ -2443,7 +2443,7 @@ patches to the new mywork.  The result will look like:\n ................................................\n \n In the process, it may discover conflicts.  In that case it will stop\n-and allow you to fix the conflicts; after fixing conflicts, use \"git add\"\n+and allow you to fix the conflicts; after fixing conflicts, use \"git-add\"\n to update the index with those contents, and then, instead of\n running git-commit, just run\n \n@@ -2700,7 +2700,7 @@ master branch.  In more detail:\n git fetch and fast-forwards\n ---------------------------\n \n-In the previous example, when updating an existing branch, \"git fetch\"\n+In the previous example, when updating an existing branch, \"git-fetch\"\n checks to make sure that the most recent commit on the remote\n branch is a descendant of the most recent commit on your copy of the\n branch before updating your copy of the branch to point at the new\n@@ -2726,7 +2726,7 @@ resulting in a situation like:\n             o--o--o <-- new head of the branch\n ................................................\n \n-In this case, \"git fetch\" will fail, and print out a warning.\n+In this case, \"git-fetch\" will fail, and print out a warning.\n \n In that case, you can still force git to update to the new head, as\n described in the following section.  However, note that in the\n@@ -3106,7 +3106,7 @@ $ git prune\n \n to remove any of the \"loose\" objects that are now contained in the\n pack.  This will also remove any unreferenced objects (which may be\n-created when, for example, you use \"git reset\" to remove a commit).\n+created when, for example, you use \"git-reset\" to remove a commit).\n You can verify that the loose objects are gone by looking at the\n .git/objects directory or by running\n \n@@ -3135,7 +3135,7 @@ branch still exists, as does everything it pointed to. The branch\n pointer itself just doesn't, since you replaced it with another one.\n \n There are also other situations that cause dangling objects. For\n-example, a \"dangling blob\" may arise because you did a \"git add\" of a\n+example, a \"dangling blob\" may arise because you did a \"git-add\" of a\n file, but then, before you actually committed it and made it part of the\n bigger picture, you changed something else in that file and committed\n that *updated* thing--the old state that you added originally ends up\n@@ -3185,7 +3185,7 @@ Usually, dangling blobs and trees aren't very interesting. They're\n almost always the result of either being a half-way mergebase (the blob\n will often even have the conflict markers from a merge in it, if you\n have had conflicting merges that you fixed up by hand), or simply\n-because you interrupted a \"git fetch\" with ^C or something like that,\n+because you interrupted a \"git-fetch\" with ^C or something like that,\n leaving _some_ of the new objects in the object database, but just\n dangling and useless.\n \n@@ -3694,7 +3694,7 @@ removed. The only thing `--remove` means is that update-index will be\n considering a removed file to be a valid thing, and if the file really\n does not exist any more, it will update the index accordingly.\n \n-As a special case, you can also do `git-update-index --refresh`, which\n+As a special case, you can also do `git update-index --refresh`, which\n will refresh the \"stat\" information of each index to match the current\n stat information. It will 'not' update the object status itself, and\n it will only update the fields that are used to quickly test whether\n@@ -3770,7 +3770,7 @@ from one representation to the other:\n Tying it all together\n ~~~~~~~~~~~~~~~~~~~~~\n \n-To commit a tree you have instantiated with \"git-write-tree\", you'd\n+To commit a tree you have instantiated with \"git write-tree\", you'd\n create a \"commit\" object that refers to that tree and the history\n behind it--most notably the \"parent\" commits that preceded it in\n history.\n@@ -3927,7 +3927,7 @@ $ git read-tree -m -u <origtree> <yourtree> <targettree>\n \n which will do all trivial merge operations for you directly in the\n index file, and you can just write the result out with\n-`git-write-tree`.\n+`git write-tree`.\n \n \n [[merging-multiple-trees-2]]\n@@ -4095,7 +4095,7 @@ functions like `get_sha1_basic()` or the likes.\n This is just to get you into the groove for the most libified part of Git:\n the revision walker.\n \n-Basically, the initial version of `git log` was a shell script:\n+Basically, the initial version of `git-log` was a shell script:\n \n ----------------------------------------------------------------\n $ git-rev-list --pretty $(git-rev-parse --default HEAD \"$@\") | \\\n@@ -4130,7 +4130,7 @@ just have a look at the first implementation of `cmd_log()`; call\n `git show v1.3.0{tilde}155^2{tilde}4` and scroll down to that function (note that you\n no longer need to call `setup_pager()` directly).\n \n-Nowadays, `git log` is a builtin, which means that it is _contained_ in the\n+Nowadays, `git-log` is a builtin, which means that it is _contained_ in the\n command `git`.  The source side of a builtin is\n \n - a function called `cmd_<bla>`, typically defined in `builtin-<bla>.c`,\n@@ -4146,7 +4146,7 @@ since they share quite a bit of code.  In that case, the commands which are\n _not_ named like the `.c` file in which they live have to be listed in\n `BUILT_INS` in the `Makefile`.\n \n-`git log` looks more complicated in C than it does in the original script,\n+`git-log` looks more complicated in C than it does in the original script,\n but that allows for a much greater flexibility and performance.\n \n Here again it is a good point to take a pause.\n@@ -4157,9 +4157,9 @@ the organization of Git (after you know the basic concepts).\n So, think about something which you are interested in, say, \"how can I\n access a blob just knowing the object name of it?\".  The first step is to\n find a Git command with which you can do it.  In this example, it is either\n-`git show` or `git cat-file`.\n+`git-show` or `git-cat-file`.\n \n-For the sake of clarity, let's stay with `git cat-file`, because it\n+For the sake of clarity, let's stay with `git-cat-file`, because it\n \n - is plumbing, and\n \n-- \n1.5.5.GIT\n"},{"id":"82088","messageId":"Pine.GSO.4.62.0807030028250.16085@harper.uchicago.edu","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0807022322380.16085@harper.uchicago.edu","subject":"[PATCH 08/15] gitdiffcore(7): fix awkward wording","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-07-03T05:30:25Z","receivedAt":"2008-07-03T05:30:25Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"The phrase \"diff outputs\" sounds awkward to my ear (I think\n\"output\" is meant to be used as a substantive noun.)\n\nSigned-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n---\n Documentation/gitdiffcore.txt |    4 ++--\n 1 files changed, 2 insertions(+), 2 deletions(-)\n\ndiff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt\nindex 0b7daed..1171b5c 100644\n--- a/Documentation/gitdiffcore.txt\n+++ b/Documentation/gitdiffcore.txt\n@@ -16,8 +16,8 @@ The diff commands `git-diff-index`, `git-diff-files`, and `git-diff-tree`\n can be told to manipulate differences they find in\n unconventional ways before showing `diff` output.  The manipulation\n is collectively called \"diffcore transformation\".  This short note\n-describes what they are and how to use them to produce diff outputs\n-that are easier to understand than the conventional kind.\n+describes what they are and how to use them to produce diff output\n+that is easier to understand than the conventional kind.\n \n \n The chain of operation\n-- \n1.5.5.GIT\n"},{"id":"82067","messageId":"Pine.GSO.4.62.0807030030320.16085@harper.uchicago.edu","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0807022322380.16085@harper.uchicago.edu","subject":"[PATCH 09/15] manpages: italicize command names in synopses","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-07-03T05:36:04Z","receivedAt":"2008-07-03T05:36:04Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"To tell command names from options in a glance.\n\nSigned-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n---\n Documentation/git-reflog.txt |   10 +++++-----\n Documentation/git-remote.txt |   10 +++++-----\n 2 files changed, 10 insertions(+), 10 deletions(-)\n\ndiff --git a/Documentation/git-reflog.txt b/Documentation/git-reflog.txt\nindex d963c51..1710626 100644\n--- a/Documentation/git-reflog.txt\n+++ b/Documentation/git-reflog.txt\n@@ -16,12 +16,12 @@ The command takes various subcommands, and different options\n depending on the subcommand:\n \n [verse]\n-git reflog expire [--dry-run] [--stale-fix] [--verbose]\n+'git reflog expire' [--dry-run] [--stale-fix] [--verbose]\n \t[--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>...\n-\n-git reflog delete ref@\\{specifier\\}...\n-\n-git reflog [show] [log-options] [<ref>]\n++\n+'git reflog delete' ref@\\{specifier\\}...\n++\n+'git reflog' ['show'] [log-options] [<ref>]\n \n Reflog is a mechanism to record when the tip of branches are\n updated.  This command is to manage the information recorded in it.\ndiff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt\nindex 3634efd..bb99810 100644\n--- a/Documentation/git-remote.txt\n+++ b/Documentation/git-remote.txt\n@@ -10,11 +10,11 @@ SYNOPSIS\n --------\n [verse]\n 'git remote' [-v | --verbose]\n-'git remote' add [-t <branch>] [-m <master>] [-f] [--mirror] <name> <url>\n-'git remote' rm <name>\n-'git remote' show [-n] <name>\n-'git remote' prune [-n | --dry-run] <name>\n-'git remote' update [group]\n+'git remote add' [-t <branch>] [-m <master>] [-f] [--mirror] <name> <url>\n+'git remote rm' <name>\n+'git remote show' [-n] <name>\n+'git remote prune' [-n | --dry-run] <name>\n+'git remote update' [group]\n \n DESCRIPTION\n -----------\n-- \n1.5.5.GIT\n"},{"id":"82070","messageId":"Pine.GSO.4.62.0807030036120.16085@harper.uchicago.edu","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0807022322380.16085@harper.uchicago.edu","subject":"[PATCH 10/15] manpages: italicize command names","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-07-03T05:37:18Z","receivedAt":"2008-07-03T05:37:18Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"This includes nongit commands like RCS 'merge'.  This patch only\nitalicizes names of commands if they had no formatting before.\n\nSigned-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n---\n\tThe escaping under \"log.date\" in config.txt works for me\n\twith asciidoc 8.2.6 and ASCIIDOC8=YesPlease.  Will it work\n\ton asciidoc 7?\n\n Documentation/config.txt          |    4 ++--\n Documentation/git-apply.txt       |    6 +++---\n Documentation/git-merge-file.txt  |    2 +-\n Documentation/git-merge-index.txt |    2 +-\n Documentation/git-rerere.txt      |    4 ++--\n Documentation/gitdiffcore.txt     |    4 ++--\n 6 files changed, 11 insertions(+), 11 deletions(-)\n\ndiff --git a/Documentation/config.txt b/Documentation/config.txt\nindex 5a98a5b..84a0e77 100644\n--- a/Documentation/config.txt\n+++ b/Documentation/config.txt\n@@ -568,7 +568,7 @@ diff.external::\n \n diff.renameLimit::\n \tThe number of files to consider when performing the copy/rename\n-\tdetection; equivalent to the git-diff option '-l'.\n+\tdetection; equivalent to the 'git-diff' option '-l'.\n \n diff.renames::\n \tTells git to detect renames.  If set to any boolean value, it\n@@ -849,7 +849,7 @@ instaweb.port::\n \n log.date::\n \tSet default date-time mode for the log command. Setting log.date\n-\tvalue is similar to using git-log's --date option. The value is one of the\n+\tvalue is similar to using 'git-log'\\'s --date option. The value is one of the\n \tfollowing alternatives: {relative,local,default,iso,rfc,short}.\n \tSee linkgit:git-log[1].\n \ndiff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt\nindex fbe1130..b2f909d 100644\n--- a/Documentation/git-apply.txt\n+++ b/Documentation/git-apply.txt\n@@ -18,7 +18,7 @@ SYNOPSIS\n \n DESCRIPTION\n -----------\n-Reads supplied diff output and applies it on a git index file\n+Reads supplied 'diff' output and applies it on a git index file\n and a work tree.\n \n OPTIONS\n@@ -165,9 +165,9 @@ behavior:\n * `error-all` is similar to `error` but shows all errors.\n \n --inaccurate-eof::\n-\tUnder certain circumstances, some versions of diff do not correctly\n+\tUnder certain circumstances, some versions of 'diff' do not correctly\n \tdetect a missing new-line at the end of the file. As a result, patches\n-\tcreated by such diff programs do not record incomplete lines\n+\tcreated by such 'diff' programs do not record incomplete lines\n \tcorrectly. This option adds support for applying such patches by\n \tworking around this bug.\n \ndiff --git a/Documentation/git-merge-file.txt b/Documentation/git-merge-file.txt\nindex 2a033dd..b5eb630 100644\n--- a/Documentation/git-merge-file.txt\n+++ b/Documentation/git-merge-file.txt\n@@ -93,7 +93,7 @@ Written by Johannes Schindelin <johannes.schindelin@gmx.de>\n Documentation\n --------------\n Documentation by Johannes Schindelin and the git-list <git@vger.kernel.org>,\n-with parts copied from the original documentation of RCS merge.\n+with parts copied from the original documentation of RCS 'merge'.\n \n GIT\n ---\ndiff --git a/Documentation/git-merge-index.txt b/Documentation/git-merge-index.txt\nindex 4368084..4f04bbb 100644\n--- a/Documentation/git-merge-index.txt\n+++ b/Documentation/git-merge-index.txt\n@@ -41,7 +41,7 @@ processes them in turn only stopping if merge returns a non-zero exit\n code.\n \n Typically this is run with a script calling git's imitation of\n-the merge command from the RCS package.\n+the 'merge' command from the RCS package.\n \n A sample script called `git-merge-one-file` is included in the\n distribution.\ndiff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt\nindex ae2b2b5..30ec68d 100644\n--- a/Documentation/git-rerere.txt\n+++ b/Documentation/git-rerere.txt\n@@ -7,7 +7,7 @@ git-rerere - Reuse recorded resolution of conflicted merges\n \n SYNOPSIS\n --------\n-'git rerere' [clear|diff|status|gc]\n+'git rerere' ['clear'|'diff'|'status'|'gc']\n \n DESCRIPTION\n -----------\n@@ -49,7 +49,7 @@ conflicts.  Additional arguments are passed directly to the system\n \n 'status'::\n \n-Like diff, but this only prints the filenames that will be tracked\n+Like 'diff', but this only prints the filenames that will be tracked\n for resolutions.\n \n 'gc'::\ndiff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt\nindex 1171b5c..949332b 100644\n--- a/Documentation/gitdiffcore.txt\n+++ b/Documentation/gitdiffcore.txt\n@@ -7,7 +7,7 @@ gitdiffcore - Tweaking diff output (June 2005)\n \n SYNOPSIS\n --------\n-git diff *\n+'git diff' *\n \n DESCRIPTION\n -----------\n@@ -16,7 +16,7 @@ The diff commands `git-diff-index`, `git-diff-files`, and `git-diff-tree`\n can be told to manipulate differences they find in\n unconventional ways before showing `diff` output.  The manipulation\n is collectively called \"diffcore transformation\".  This short note\n-describes what they are and how to use them to produce diff output\n+describes what they are and how to use them to produce 'diff' output\n that is easier to understand than the conventional kind.\n \n \n-- \n1.5.5.GIT\n"},{"id":"82072","messageId":"Pine.GSO.4.62.0807030037220.16085@harper.uchicago.edu","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0807022322380.16085@harper.uchicago.edu","subject":"[PATCH 11/15] manpages: italicize git command names (which were in teletype font)","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-07-03T05:45:27Z","receivedAt":"2008-07-03T05:45:27Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"This patch is huge (256 KB), so I am not sending it. You can find it at\n<http://home.uchicago.edu/~jrnieder/20080703-git-italics.txt>.\n\nThe names of git commands are not meant to be entered at the\ncommandline; they are just names. So we render them in italics,\nas is usual for command names in manpages.\n\nUsing\n\n\tdoit () {\n\t  perl -e 'for (<>) { s/\\`(git-[^\\`.]*)\\`/'\\''\\1'\\''/g; print }'\n\t}\n\tfor i in git*.txt config.txt diff*.txt blame*.txt fetch*.txt i18n.txt \\\n\t        merge*.txt pretty*.txt pull*.txt rev*.txt urls*.txt\n\tdo\n\t  doit <\"$i\" >\"$i+\" && mv \"$i+\" \"$i\"\n\tdone\n\tgit diff\n\n.\n\nSigned-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n\n\tMy script missed some spots, but I don't think there were\n\tany false positives. (I hope there weren't.)\n\n Documentation/config.txt                |   56 ++++++------\n Documentation/fetch-options.txt         |    8 +-\n Documentation/git-am.txt                |   14 ++--\n Documentation/git-apply.txt             |   10 +-\n Documentation/git-archimport.txt        |   12 +-\n Documentation/git-archive.txt           |    6 +-\n Documentation/git-bisect.txt            |    6 +-\n Documentation/git-blame.txt             |    8 +-\n Documentation/git-branch.txt            |    8 +-\n Documentation/git-bundle.txt            |   26 +++---\n Documentation/git-check-ref-format.txt  |    2 +-\n Documentation/git-checkout-index.txt    |    8 +-\n Documentation/git-checkout.txt          |    4 +-\n Documentation/git-cherry-pick.txt       |    2 +-\n Documentation/git-cherry.txt            |    6 +-\n Documentation/git-citool.txt            |    4 +-\n Documentation/git-clean.txt             |    4 +-\n Documentation/git-clone.txt             |    6 +-\n Documentation/git-commit-tree.txt       |    2 +-\n Documentation/git-commit.txt            |   20 ++--\n Documentation/git-config.txt            |   12 +-\n Documentation/git-cvsexportcommit.txt   |    2 +-\n Documentation/git-cvsimport.txt         |   18 ++--\n Documentation/git-cvsserver.txt         |   38 ++++----\n Documentation/git-daemon.txt            |   40 ++++----\n Documentation/git-describe.txt          |    6 +-\n Documentation/git-diff-files.txt        |    2 +-\n Documentation/git-diff-index.txt        |   20 ++--\n Documentation/git-diff-tree.txt         |   10 +-\n Documentation/git-fast-export.txt       |    8 +-\n Documentation/git-fast-import.txt       |   20 ++--\n Documentation/git-fetch-pack.txt        |   14 ++--\n Documentation/git-fetch.txt             |    2 +-\n Documentation/git-filter-branch.txt     |   14 ++--\n Documentation/git-fmt-merge-msg.txt     |    4 +-\n Documentation/git-for-each-ref.txt      |    2 +-\n Documentation/git-format-patch.txt      |    6 +-\n Documentation/git-fsck.txt              |    4 +-\n Documentation/git-gc.txt                |   20 ++--\n Documentation/git-get-tar-commit-id.txt |    6 +-\n Documentation/git-grep.txt              |    2 +-\n Documentation/git-gui.txt               |   20 ++--\n Documentation/git-hash-object.txt       |    2 +-\n Documentation/git-help.txt              |    6 +-\n Documentation/git-http-fetch.txt        |    2 +-\n Documentation/git-imap-send.txt         |    2 +-\n Documentation/git-index-pack.txt        |    8 +-\n Documentation/git-init.txt              |    6 +-\n Documentation/git-instaweb.txt          |    2 +-\n Documentation/git-log.txt               |    4 +-\n Documentation/git-ls-files.txt          |    6 +-\n Documentation/git-ls-remote.txt         |    2 +-\n Documentation/git-mailinfo.txt          |    4 +-\n Documentation/git-merge-base.txt        |    4 +-\n Documentation/git-merge-file.txt        |   10 +-\n Documentation/git-merge-index.txt       |    8 +-\n Documentation/git-merge-one-file.txt    |    4 +-\n Documentation/git-merge.txt             |   16 ++--\n Documentation/git-mergetool.txt         |   16 ++--\n Documentation/git-name-rev.txt          |    6 +-\n Documentation/git-pack-objects.txt      |    6 +-\n Documentation/git-pack-redundant.txt    |    2 +-\n Documentation/git-parse-remote.txt      |    2 +-\n Documentation/git-patch-id.txt          |    2 +-\n Documentation/git-peek-remote.txt       |    6 +-\n Documentation/git-prune.txt             |   14 ++--\n Documentation/git-pull.txt              |   10 +-\n Documentation/git-push.txt              |    4 +-\n Documentation/git-read-tree.txt         |   42 ++++----\n Documentation/git-rebase.txt            |   26 +++---\n Documentation/git-receive-pack.txt      |   12 +-\n Documentation/git-repack.txt            |   14 ++--\n Documentation/git-rerere.txt            |   28 +++---\n Documentation/git-reset.txt             |    2 +-\n Documentation/git-rev-list.txt          |    6 +-\n Documentation/git-rev-parse.txt         |   24 +++---\n Documentation/git-revert.txt            |    4 +-\n Documentation/git-rm.txt                |    4 +-\n Documentation/git-send-pack.txt         |   10 +-\n Documentation/git-sh-setup.txt          |    2 +-\n Documentation/git-shell.txt             |    2 +-\n Documentation/git-shortlog.txt          |    2 +-\n Documentation/git-show-branch.txt       |    2 +-\n Documentation/git-show-index.txt        |    4 +-\n Documentation/git-show-ref.txt          |    4 +-\n Documentation/git-show.txt              |    6 +-\n Documentation/git-stash.txt             |    6 +-\n Documentation/git-status.txt            |    6 +-\n Documentation/git-submodule.txt         |    4 +-\n Documentation/git-svn.txt               |  106 ++++++++++----------\n Documentation/git-symbolic-ref.txt      |    2 +-\n Documentation/git-tag.txt               |    8 +-\n Documentation/git-tar-tree.txt          |    6 +-\n Documentation/git-update-index.txt      |   22 ++--\n Documentation/git-upload-archive.txt    |    2 +-\n Documentation/git-upload-pack.txt       |    6 +-\n Documentation/git-var.txt               |    2 +-\n Documentation/git-verify-pack.txt       |    2 +-\n Documentation/git-verify-tag.txt        |    2 +-\n Documentation/git-web--browse.txt       |    6 +-\n Documentation/git-whatchanged.txt       |    4 +-\n Documentation/git-write-tree.txt        |    8 +-\n Documentation/git.txt                   |    8 +-\n Documentation/gitattributes.txt         |   16 ++--\n Documentation/gitcore-tutorial.txt      |  162 +++++++++++++++---------------\n Documentation/gitcvs-migration.txt      |   12 +-\n Documentation/gitdiffcore.txt           |   30 +++---\n Documentation/githooks.txt              |   74 +++++++-------\n Documentation/gitignore.txt             |    4 +-\n Documentation/gitk.txt                  |    2 +-\n Documentation/gitrepository-layout.txt  |   18 ++--\n Documentation/gittutorial-2.txt         |   16 ++--\n Documentation/gittutorial.txt           |   42 ++++----\n Documentation/i18n.txt                  |    4 +-\n Documentation/merge-options.txt         |    4 +-\n Documentation/pull-fetch-param.txt      |    8 +-\n Documentation/urls-remotes.txt          |    4 +-\n 117 files changed, 713 insertions(+), 713 deletions(-)\n\npatch at <http://home.uchicago.edu/~jrnieder/20080703-git-italics.txt>\n"},{"id":"82071","messageId":"Pine.GSO.4.62.0807030045340.16085@harper.uchicago.edu","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0807022322380.16085@harper.uchicago.edu","subject":"[PATCH 12/15] manpages: italicize gitk's name (where it was in teletype font)","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-07-03T05:49:55Z","receivedAt":"2008-07-03T05:49:55Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"The name `gitk` is sometimes meant to be entered at the command\nprompt, but most uses are just referring to the program with that\nname (not the incantation to start it).\n\nSigned-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n---\n Documentation/git-bisect.txt       |    2 +-\n Documentation/git-gui.txt          |    4 ++--\n Documentation/gitcore-tutorial.txt |    2 +-\n Documentation/gittutorial.txt      |    2 +-\n 4 files changed, 5 insertions(+), 5 deletions(-)\n\ndiff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt\nindex c794914..c7981ef 100644\n--- a/Documentation/git-bisect.txt\n+++ b/Documentation/git-bisect.txt\n@@ -98,7 +98,7 @@ During the bisection process, you can say\n $ git bisect visualize\n ------------\n \n-to see the currently remaining suspects in `gitk`.  `visualize` is a bit\n+to see the currently remaining suspects in 'gitk'.  `visualize` is a bit\n too long to type and `view` is provided as a synonym.\n \n If 'DISPLAY' environment variable is not set, 'git-log' is used\ndiff --git a/Documentation/git-gui.txt b/Documentation/git-gui.txt\nindex f067772..a73201d 100644\n--- a/Documentation/git-gui.txt\n+++ b/Documentation/git-gui.txt\n@@ -16,9 +16,9 @@ on allowing users to make changes to their repository by making\n new commits, amending existing ones, creating branches, performing\n local merges, and fetching/pushing to remote repositories.\n \n-Unlike `gitk`, 'git-gui' focuses on commit generation\n+Unlike 'gitk', 'git-gui' focuses on commit generation\n and single file annotation and does not show project history.\n-It does however supply menu actions to start a `gitk` session from\n+It does however supply menu actions to start a 'gitk' session from\n within 'git-gui'.\n \n 'git-gui' is known to work on all popular UNIX systems, Mac OS X,\ndiff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt\nindex 2bbe7de..3eba973 100644\n--- a/Documentation/gitcore-tutorial.txt\n+++ b/Documentation/gitcore-tutorial.txt\n@@ -878,7 +878,7 @@ means: normally it will just show you your current `HEAD`) and their\n histories. You can also see exactly how they came to be from a common\n source.\n \n-Anyway, let's exit `gitk` (`^Q` or the File menu), and decide that we want\n+Anyway, let's exit 'gitk' (`^Q` or the File menu), and decide that we want\n to merge the work we did on the `mybranch` branch into the `master`\n branch (which is currently our `HEAD` too). To do that, there's a nice\n script called 'git-merge', which wants to know which branches you want\ndiff --git a/Documentation/gittutorial.txt b/Documentation/gittutorial.txt\nindex 930f690..85abc6e 100644\n--- a/Documentation/gittutorial.txt\n+++ b/Documentation/gittutorial.txt\n@@ -554,7 +554,7 @@ then merged back together, the order in which 'git-log' presents\n those commits is meaningless.\n \n Most projects with multiple contributors (such as the linux kernel,\n-or git itself) have frequent merges, and `gitk` does a better job of\n+or git itself) have frequent merges, and 'gitk' does a better job of\n visualizing their history.  For example,\n \n -------------------------------------\n-- \n1.5.5.GIT\n"},{"id":"82089","messageId":"Pine.GSO.4.62.0807030050110.16085@harper.uchicago.edu","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0807022322380.16085@harper.uchicago.edu","subject":"[PATCH 13/15] manpages: italicize nongit command names (if they are in teletype font)","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-07-03T05:55:07Z","receivedAt":"2008-07-03T05:55:07Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Some manual pages use teletype font to set command names. We\nchange them to use italics, instead.  This creates a visual\ndistinction between names of commands and command lines that\ncan be typed at the command line. It is also more consistent\nwith other man pages outside Git.\n\nIn this patch, the commands named are non-git commands like bash.\n\nSigned-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n---\n Documentation/git-apply.txt        |    2 +-\n Documentation/git-cvsserver.txt    |    4 ++--\n Documentation/git-fsck.txt         |    2 +-\n Documentation/git-merge-file.txt   |    4 ++--\n Documentation/git-merge-index.txt  |    4 ++--\n Documentation/git-rerere.txt       |    2 +-\n Documentation/git-svn.txt          |    2 +-\n Documentation/git.txt              |    2 +-\n Documentation/gitattributes.txt    |    6 +++---\n Documentation/gitcore-tutorial.txt |   14 +++++++-------\n Documentation/gitcvs-migration.txt |    4 ++--\n Documentation/gitdiffcore.txt      |    2 +-\n 12 files changed, 24 insertions(+), 24 deletions(-)\n\ndiff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt\nindex f82c2ce..ca60efd 100644\n--- a/Documentation/git-apply.txt\n+++ b/Documentation/git-apply.txt\n@@ -121,7 +121,7 @@ discouraged.\n --no-add::\n \tWhen applying a patch, ignore additions made by the\n \tpatch.  This can be used to extract the common part between\n-\ttwo files by first running `diff` on them and applying\n+\ttwo files by first running 'diff' on them and applying\n \tthe result with this option, which would apply the\n \tdeletion part but not addition part.\n \ndiff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt\nindex 1804701..2aacdc6 100644\n--- a/Documentation/git-cvsserver.txt\n+++ b/Documentation/git-cvsserver.txt\n@@ -115,7 +115,7 @@ This has the advantage that it will be saved in your 'CVS/Root' files and\n you don't need to worry about always setting the correct environment\n variable.  SSH users restricted to 'git-shell' don't need to override the default\n with CVS_SERVER (and shouldn't) as 'git-shell' understands `cvs` to mean\n-'git-cvsserver' and pretends that the other end runs the real `cvs` better.\n+'git-cvsserver' and pretends that the other end runs the real 'cvs' better.\n --\n 2. For each repo that you want accessible from CVS you need to edit config in\n    the repo and add the following section.\n@@ -328,7 +328,7 @@ is left blank. But if `gitcvs.allbinary` is set to \"guess\", then\n the correct '-k' mode will be guessed based on the contents of\n the file.\n \n-For best consistency with `cvs`, it is probably best to override the\n+For best consistency with 'cvs', it is probably best to override the\n defaults by setting `gitcvs.usecrlfattr` to true,\n and `gitcvs.allbinary` to \"guess\".\n \ndiff --git a/Documentation/git-fsck.txt b/Documentation/git-fsck.txt\nindex 524e0b1..d5a7647 100644\n--- a/Documentation/git-fsck.txt\n+++ b/Documentation/git-fsck.txt\n@@ -87,7 +87,7 @@ sorted properly etc), but on the whole if 'git-fsck' is happy, you\n do have a valid tree.\n \n Any corrupt objects you will have to find in backups or other archives\n-(i.e., you can just remove them and do an `rsync` with some other site in\n+(i.e., you can just remove them and do an 'rsync' with some other site in\n the hopes that somebody else has the object you have corrupted).\n \n Of course, \"valid tree\" doesn't mean that it wasn't generated by some\ndiff --git a/Documentation/git-merge-file.txt b/Documentation/git-merge-file.txt\nindex 4ae4bdc..a11c475 100644\n--- a/Documentation/git-merge-file.txt\n+++ b/Documentation/git-merge-file.txt\n@@ -42,8 +42,8 @@ lines from `<other-file>` respectively.\n The exit value of this program is negative on error, and the number of\n conflicts otherwise. If the merge was clean, the exit value is 0.\n \n-'git-merge-file' is designed to be a minimal clone of RCS `merge`; that is, it\n-implements all of RCS merge's functionality which is needed by\n+'git-merge-file' is designed to be a minimal clone of RCS 'merge'; that is, it\n+implements all of RCS 'merge''s functionality which is needed by\n linkgit:git[1].\n \n \ndiff --git a/Documentation/git-merge-index.txt b/Documentation/git-merge-index.txt\nindex 5ebed57..ff088c5 100644\n--- a/Documentation/git-merge-index.txt\n+++ b/Documentation/git-merge-index.txt\n@@ -47,9 +47,9 @@ A sample script called 'git-merge-one-file' is included in the\n distribution.\n \n ALERT ALERT ALERT! The git \"merge object order\" is different from the\n-RCS `merge` program merge object order. In the above ordering, the\n+RCS 'merge' program merge object order. In the above ordering, the\n original is first. But the argument order to the 3-way merge program\n-`merge` is to have the original in the middle. Don't ask me why.\n+'merge' is to have the original in the middle. Don't ask me why.\n \n Examples:\n \ndiff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt\nindex 666349d..678bfd3 100644\n--- a/Documentation/git-rerere.txt\n+++ b/Documentation/git-rerere.txt\n@@ -45,7 +45,7 @@ will automatically invoke this command.\n This displays diffs for the current state of the resolution.  It is\n useful for tracking what has changed while the user is resolving\n conflicts.  Additional arguments are passed directly to the system\n-`diff` command installed in PATH.\n+'diff' command installed in PATH.\n \n 'status'::\n \ndiff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt\nindex dd12335..dc5b8f6 100644\n--- a/Documentation/git-svn.txt\n+++ b/Documentation/git-svn.txt\n@@ -565,7 +565,7 @@ branch.\n \n 'git-clone' does not clone branches under the refs/remotes/ hierarchy or\n any 'git-svn' metadata, or config.  So repositories created and managed with\n-using 'git-svn' should use `rsync` for cloning, if cloning is to be done\n+using 'git-svn' should use 'rsync' for cloning, if cloning is to be done\n at all.\n \n Since 'dcommit' uses rebase internally, any git branches you 'git-push' to\ndiff --git a/Documentation/git.txt b/Documentation/git.txt\nindex 992a46d..4d54791 100644\n--- a/Documentation/git.txt\n+++ b/Documentation/git.txt\n@@ -493,7 +493,7 @@ other\n 'GIT_SSH'::\n \tIf this environment variable is set then 'git-fetch'\n \tand 'git-push' will use this command instead\n-\tof `ssh` when they need to connect to a remote system.\n+\tof 'ssh' when they need to connect to a remote system.\n \tThe '$GIT_SSH' command will be given exactly two arguments:\n \tthe 'username@host' (or just 'host') from the URL and the\n \tshell command to execute on that remote system.\ndiff --git a/Documentation/gitattributes.txt b/Documentation/gitattributes.txt\nindex 0b53044..6a246eb 100644\n--- a/Documentation/gitattributes.txt\n+++ b/Documentation/gitattributes.txt\n@@ -278,7 +278,7 @@ is prefixed with a line of the form:\n \n The text is called 'hunk header', and by default a line that\n begins with an alphabet, an underscore or a dollar sign is used,\n-which matches what GNU `diff -p` output uses.  This default\n+which matches what GNU 'diff -p' output uses.  This default\n selection however is not suited for some contents, and you can\n use customized pattern to make a selection.\n \n@@ -322,7 +322,7 @@ and other programs such as `git revert` and `git cherry-pick`.\n Set::\n \n \tBuilt-in 3-way merge driver is used to merge the\n-\tcontents in a way similar to `merge` command of `RCS`\n+\tcontents in a way similar to 'merge' command of `RCS`\n \tsuite.  This is suitable for ordinary text files.\n \n Unset::\n@@ -426,7 +426,7 @@ Checking whitespace errors\n ^^^^^^^^^^^^\n \n The `core.whitespace` configuration variable allows you to define what\n-`diff` and `apply` should consider whitespace errors for all paths in\n+'diff' and 'apply' should consider whitespace errors for all paths in\n the project (See linkgit:git-config[1]).  This attribute gives you finer\n control per path.\n \ndiff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt\nindex 3eba973..5acdeb7 100644\n--- a/Documentation/gitcore-tutorial.txt\n+++ b/Documentation/gitcore-tutorial.txt\n@@ -61,7 +61,7 @@ Initialized empty Git repository in .git/\n which is just git's way of saying that you haven't been doing anything\n strange, and that it will have created a local `.git` directory setup for\n your new project. You will now have a `.git` directory, and you can\n-inspect that with `ls`. For your new empty project, it should show you\n+inspect that with 'ls'. For your new empty project, it should show you\n three entries, among other things:\n \n  - a file called `HEAD`, that has `ref: refs/heads/master` in it.\n@@ -660,7 +660,7 @@ in the new repository to make sure that the index file is up-to-date.\n \n Note that the second point is true even across machines. You can\n duplicate a remote git repository with *any* regular copy mechanism, be it\n-`scp`, `rsync` or `wget`.\n+'scp', 'rsync' or 'wget'.\n \n When copying a remote repository, you'll want to at a minimum update the\n index cache when you do this, and especially with other peoples'\n@@ -1066,9 +1066,9 @@ most efficient way to exchange git objects between repositories.\n Local directory::\n \t`/path/to/repo.git/`\n +\n-This transport is the same as SSH transport but uses `sh` to run\n+This transport is the same as SSH transport but uses 'sh' to run\n both ends on the local machine instead of running other end on\n-the remote machine via `ssh`.\n+the remote machine via 'ssh'.\n \n git Native::\n \t`git://remote.machine/path/to/repo.git/`\n@@ -1275,8 +1275,8 @@ fatal: merge program failed\n describe those three versions, and is responsible to leave the\n merge results in the working tree.\n It is a fairly straightforward shell script, and\n-eventually calls `merge` program from RCS suite to perform a\n-file-level 3-way merge.  In this case, `merge` detects\n+eventually calls 'merge' program from RCS suite to perform a\n+file-level 3-way merge.  In this case, 'merge' detects\n conflicts, and the merge result with conflict marks is left in\n the working tree..  This can be seen if you run `ls-files\n --stage` again at this point:\n@@ -1360,7 +1360,7 @@ program on the `$PATH`.\n [NOTE]\n Many installations of sshd do not invoke your shell as the login\n shell when you directly run programs; what this means is that if\n-your login shell is `bash`, only `.bashrc` is read and not\n+your login shell is 'bash', only `.bashrc` is read and not\n `.bash_profile`. As a workaround, make sure `.bashrc` sets up\n `$PATH` so that you can run 'git-receive-pack' program.\n \ndiff --git a/Documentation/gitcvs-migration.txt b/Documentation/gitcvs-migration.txt\nindex 41ad608..2737d10 100644\n--- a/Documentation/gitcvs-migration.txt\n+++ b/Documentation/gitcvs-migration.txt\n@@ -34,7 +34,7 @@ $ git clone foo.com:/pub/repo.git/ my-project\n $ cd my-project\n ------------------------------------------------\n \n-and hack away.  The equivalent of `cvs update` is\n+and hack away.  The equivalent of 'cvs update' is\n \n ------------------------------------------------\n $ git pull origin\n@@ -60,7 +60,7 @@ $ git push origin master\n ------------------------------------------------\n \n to \"push\" those commits to the shared repository.  If someone else has\n-updated the repository more recently, 'git-push', like `cvs commit`, will\n+updated the repository more recently, 'git-push', like 'cvs commit', will\n complain, in which case you must pull any changes before attempting the\n push again.\n \ndiff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt\nindex 84b95a4..2bdbc3d 100644\n--- a/Documentation/gitdiffcore.txt\n+++ b/Documentation/gitdiffcore.txt\n@@ -14,7 +14,7 @@ DESCRIPTION\n \n The diff commands 'git-diff-index', 'git-diff-files', and 'git-diff-tree'\n can be told to manipulate differences they find in\n-unconventional ways before showing `diff` output.  The manipulation\n+unconventional ways before showing 'diff' output.  The manipulation\n is collectively called \"diffcore transformation\".  This short note\n describes what they are and how to use them to produce 'diff' output\n that is easier to understand than the conventional kind.\n-- \n1.5.5.GIT\n"},{"id":"82091","messageId":"Pine.GSO.4.62.0807030055290.16085@harper.uchicago.edu","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0807022322380.16085@harper.uchicago.edu","subject":"[PATCH 14/15] manpages: italicize git subcommand names (which were in teletype font)","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-07-03T05:59:09Z","receivedAt":"2008-07-03T05:59:09Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Italicize those git subcommand names already in teletype we missed.\n\nSigned-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n---\n Documentation/config.txt           |    8 ++++----\n Documentation/git-svn.txt          |    2 +-\n Documentation/gitcore-tutorial.txt |    6 +++---\n Documentation/gitcvs-migration.txt |    4 ++--\n 4 files changed, 10 insertions(+), 10 deletions(-)\n\ndiff --git a/Documentation/config.txt b/Documentation/config.txt\nindex b431747..a7071df 100644\n--- a/Documentation/config.txt\n+++ b/Documentation/config.txt\n@@ -118,8 +118,8 @@ core.fileMode::\n \tSee linkgit:git-update-index[1]. True by default.\n \n core.quotepath::\n-\tThe commands that output paths (e.g. `ls-files`,\n-\t`diff`), when not given the `-z` option, will quote\n+\tThe commands that output paths (e.g. 'ls-files',\n+\t'diff'), when not given the `-z` option, will quote\n \t\"unusual\" characters in the pathname by enclosing the\n \tpathname in a double-quote pair and with backslashes the\n \tsame way strings in C source code are quoted.  If this\n@@ -557,7 +557,7 @@ diff.autorefreshindex::\n \tcontents in the work tree match the contents in the\n \tindex.  This option defaults to true.  Note that this\n \taffects only 'git-diff' Porcelain, and not lower level\n-\t`diff` commands, such as 'git-diff-files'.\n+\t'diff' commands, such as 'git-diff-files'.\n \n diff.external::\n \tIf this config variable is set, diff generation is not\n@@ -636,7 +636,7 @@ gc.packrefs::\n \tprevent `git pack-refs` from being run from 'git-gc'.\n \n gc.pruneexpire::\n-\tWhen 'git-gc' is run, it will call `prune --expire 2.weeks.ago`.\n+\tWhen 'git-gc' is run, it will call 'prune --expire 2.weeks.ago'.\n \tOverride the grace period with this config variable.\n \n gc.reflogexpire::\ndiff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt\nindex dc5b8f6..e7c0f1c 100644\n--- a/Documentation/git-svn.txt\n+++ b/Documentation/git-svn.txt\n@@ -551,7 +551,7 @@ CAVEATS\n \n For the sake of simplicity and interoperating with a less-capable system\n (SVN), it is recommended that all 'git-svn' users clone, fetch and dcommit\n-directly from the SVN server, and avoid all 'git-clone'/`pull`/`merge`/`push`\n+directly from the SVN server, and avoid all 'git-clone'/'pull'/'merge'/'push'\n operations between git repositories and branches.  The recommended\n method of exchanging code between git branches and users is\n 'git-format-patch' and 'git-am', or just 'dcommit'ing to the SVN repository.\ndiff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt\nindex 5acdeb7..dd6a268 100644\n--- a/Documentation/gitcore-tutorial.txt\n+++ b/Documentation/gitcore-tutorial.txt\n@@ -235,7 +235,7 @@ $ git diff-files\n ------------\n \n Oops. That wasn't very readable. It just spit out its own internal\n-version of a `diff`, but that internal version really just tells you\n+version of a 'diff', but that internal version really just tells you\n that it has noticed that \"hello\" has been modified, and that the old object\n contents it had have been replaced with something else.\n \n@@ -468,7 +468,7 @@ Inspecting Changes\n \n While creating changes is useful, it's even more useful if you can tell\n later what changed. The most useful command for this is another of the\n-`diff` family, namely 'git-diff-tree'.\n+'diff' family, namely 'git-diff-tree'.\n \n 'git-diff-tree' can be given two arbitrary trees, and it will tell you the\n differences between them. Perhaps even more commonly, though, you can\n@@ -1006,7 +1006,7 @@ the tree of your branch to that of the `master` branch. This is\n often called 'fast forward' merge.\n \n You can run `gitk \\--all` again to see how the commit ancestry\n-looks like, or run `show-branch`, which tells you this.\n+looks like, or run 'show-branch', which tells you this.\n \n ------------------------------------------------\n $ git show-branch master mybranch\ndiff --git a/Documentation/gitcvs-migration.txt b/Documentation/gitcvs-migration.txt\nindex 2737d10..2eb6972 100644\n--- a/Documentation/gitcvs-migration.txt\n+++ b/Documentation/gitcvs-migration.txt\n@@ -46,7 +46,7 @@ them first before running git pull.\n \n [NOTE]\n ================================\n-The `pull` command knows where to get updates from because of certain\n+The 'pull' command knows where to get updates from because of certain\n configuration variables that were set by the first 'git-clone'\n command; see `git config -l` and the linkgit:git-config[1] man\n page for details.\n@@ -67,7 +67,7 @@ push again.\n In the 'git-push' command above we specify the name of the remote branch\n to update (`master`).  If we leave that out, 'git-push' tries to update\n any branches in the remote repository that have the same name as a branch\n-in the local repository.  So the last `push` can be done with either of:\n+in the local repository.  So the last 'push' can be done with either of:\n \n ------------\n $ git push origin\n-- \n1.5.5.GIT\n"},{"id":"82075","messageId":"Pine.GSO.4.62.0807030059170.16085@harper.uchicago.edu","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0807022322380.16085@harper.uchicago.edu","subject":"[PATCH 15/15] manpages: use teletype font for sample command lines","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-07-03T06:06:23Z","receivedAt":"2008-07-03T06:06:23Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"I think that some of these uses of italics were meant to be\nrendered in quotation marks, anyway.\n\nSigned-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n---\n Documentation/git-gui.txt          |    2 +-\n Documentation/git-help.txt         |    2 +-\n Documentation/git-reflog.txt       |    4 ++--\n Documentation/git.txt              |    4 ++--\n Documentation/gitcore-tutorial.txt |    2 +-\n 5 files changed, 7 insertions(+), 7 deletions(-)\n\ndiff --git a/Documentation/git-gui.txt b/Documentation/git-gui.txt\nindex a73201d..0e650f4 100644\n--- a/Documentation/git-gui.txt\n+++ b/Documentation/git-gui.txt\n@@ -71,7 +71,7 @@ git gui citool::\n \n git citool::\n \n-\tSame as 'git gui citool' (above).\n+\tSame as `git gui citool` (above).\n \n git gui browser maint::\n \ndiff --git a/Documentation/git-help.txt b/Documentation/git-help.txt\nindex d5b20f8..f414583 100644\n--- a/Documentation/git-help.txt\n+++ b/Documentation/git-help.txt\n@@ -23,7 +23,7 @@ If a git command is named, a manual page for that command is brought\n up. The 'man' program is used by default for this purpose, but this\n can be overridden by other options or configuration variables.\n \n-Note that 'git --help ...' is identical as 'git help ...' because the\n+Note that `git --help ...` is identical to `git help ...` because the\n former is internally converted into the latter.\n \n OPTIONS\ndiff --git a/Documentation/git-reflog.txt b/Documentation/git-reflog.txt\nindex 1710626..146d7f5 100644\n--- a/Documentation/git-reflog.txt\n+++ b/Documentation/git-reflog.txt\n@@ -36,7 +36,7 @@ The subcommand \"show\" (which is also the default, in the absence of any\n subcommands) will take all the normal log options, and show the log of\n the reference provided in the command-line (or `HEAD`, by default).\n The reflog will cover all recent actions (HEAD reflog records branch switching\n-as well).  It is an alias for 'git log -g --abbrev-commit --pretty=oneline';\n+as well).  It is an alias for `git log -g --abbrev-commit --pretty=oneline`;\n see linkgit:git-log[1].\n \n The reflog is useful in various git commands, to specify the old value\n@@ -46,7 +46,7 @@ point to one week ago\", and so on. See linkgit:git-rev-parse[1] for\n more details.\n \n To delete single entries from the reflog, use the subcommand \"delete\"\n-and specify the _exact_ entry (e.g. ``git reflog delete master@\\{2\\}'').\n+and specify the _exact_ entry (e.g. \"`git reflog delete master@\\{2\\}`\").\n \n \n OPTIONS\ndiff --git a/Documentation/git.txt b/Documentation/git.txt\nindex 4d54791..92c0884 100644\n--- a/Documentation/git.txt\n+++ b/Documentation/git.txt\n@@ -135,8 +135,8 @@ OPTIONS\n +\n Other options are available to control how the manual page is\n displayed. See linkgit:git-help[1] for more information,\n-because 'git --help ...' is converted internally into 'git\n-help ...'.\n+because `git --help ...` is converted internally into `git\n+help ...`.\n \n --exec-path::\n \tPath to wherever your core git programs are installed.\ndiff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt\nindex dd6a268..a2b9293 100644\n--- a/Documentation/gitcore-tutorial.txt\n+++ b/Documentation/gitcore-tutorial.txt\n@@ -1655,7 +1655,7 @@ branch before these two merges by resetting it to 'master~2':\n $ git reset --hard master~2\n ------------\n \n-You can make sure 'git show-branch' matches the state before\n+You can make sure `git show-branch` matches the state before\n those two 'git-merge' you just did.  Then, instead of running\n two 'git-merge' commands in a row, you would merge these two\n branch heads (this is known as 'making an Octopus'):\n-- \n1.5.5.GIT\n"},{"id":"82093","messageId":"200807030806.37771.chriscool@tuxfamily.org","threadId":"14232","inReplyTo":"7vmyl1kvn6.fsf@gitster.siamese.dyndns.org","subject":"Re: [PATCH 3/7] Documentation: complicate example of \"man git-command\"","fromName":"Christian Couder","fromEmail":"chriscool@tuxfamily.org","sentAt":"2008-07-03T06:06:37Z","receivedAt":"2008-07-03T06:06:37Z","isPatch":true,"sender":{"key":"christian.couder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/208954?v=4"},"body":"Le mercredi 2 juillet 2008, Junio C Hamano a écrit :\n>\n> \tE.g. a typical command description may go like this:\n>\n>         To propagate the changes you made back to the original subversion\n>         repository, you would use 'git-svn dcommit' command.  It does\n>         these things (long description here).  Some examples:\n\nWe might kill 2 birds with a single stone by describing \"git help\" instead \nof \"git svn\" (that the user may never use).\n\n>         ------------\n> \t$ ... some example command sequence ...\n>         $ git svn dcommit\n>         ------------\n>\n>         For full details, type:\n>\n> \t------------\n>         $ man git-svn\n>         ------------\n\nI saw that in another thread \"git help\" is also being ported to Windows and \nI wonder if we want the tutorial to be usable as is by people on Windows \ntoo.\n\nI mean what if people on Windows launch \"git help tutorial\"? Should they see \nnothing or a tutorial for *nix or a special version of the tutorial for \nWindows or a tutorial that works everywhere? I think the latter would be \nbest but I wonder if it is possible.\n\nAnyway if we want to get there, perhaps we should use \"git help svn\" above \ninstead of \"man git-svn\". (Yeah \"git help help\" might be confusing at \nfirst.)\n\nThanks,\nChristian.\n\n  \n"},{"id":"82098","messageId":"7vvdzn2yza.fsf@gitster.siamese.dyndns.org","threadId":"14232","inReplyTo":"200807030806.37771.chriscool@tuxfamily.org","subject":"Re: [PATCH 3/7] Documentation: complicate example of \"man git-command\"","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2008-07-03T07:44:41Z","receivedAt":"2008-07-03T07:44:41Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Christian Couder <chriscool@tuxfamily.org> writes:\n\n> Anyway if we want to get there, perhaps we should use \"git help svn\" above \n> instead of \"man git-svn\". (Yeah \"git help help\" might be confusing at \n> first.)\n\nI do not particularly like advocating \"git help\" too strongly like that.\nI prefer to keep the user perception of \"git\" to be just \"one of the\nprograms, nothing special\".\n\nIf you want to learn about \"cat\", you say \"man cat\".  If you want to learn\nabout git, you say \"man git\", and while you *can* say \"git help\", the\npoint is you do *not* have to.  You do not have to run \"git\" to learn\nabout it.\n"},{"id":"82138","messageId":"20080703181831.GB29429@fieldses.org","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0807022010280.10323@harper.uchicago.edu","subject":"Re: [PATCH 3/7] Documentation: complicate example of \"man git-command\"","fromName":"J. Bruce Fields","fromEmail":"bfields@fieldses.org","sentAt":"2008-07-03T18:18:31Z","receivedAt":"2008-07-03T18:18:31Z","isPatch":true,"sender":{"key":"bfields@citi.umich.edu","avatar":null},"body":"On Wed, Jul 02, 2008 at 08:45:59PM -0500, Jonathan Nieder wrote:\n> J. Bruce Fields wrote:\n> \n> > On Tue, Jul 01, 2008 at 04:54:53PM -0700, Junio C Hamano wrote:\n> >\n> >> We would want to mention the typesetting convention early in the manuals\n> >> (git(7), gittutorial(7) and user-manual.html) as well, so how about...\n> >> \n> >> \tConventions used in this document\n> >>         ---------------------------------\n> >> \n> >> \tWhen talking about a git subcommand 'cmd', this documentation\n> >> \ttypesets the name of it like 'git-cmd', and that is the name you\n> >> \task for its manual page.\n> >> \n> >>         Examples are typeset like this: `$ git cmd` (`$` is your command\n> >> \tprompt, do not actually type it to your shell).  Note that a\n> >> \tsubcommand is specified as the first parameter to the 'git'\n> >> \tprogram when you actually run it from the command line.\n> > \n> > I'm not convinced this last sentence is necessary.\n> \n> I agree, but I think it doesn't hurt. I think the point was to\n> establish the word and concept \"subcommand\".\n\nWe don't need to define it.  (The word \"subcommand\" is pretty intuitive,\nespecially for anyone with some commandline experience, which we do\nassume throughout.)\n\n> > > [example showing typographical conventions]\n> > \n> > Typographical conventions shouldn't need so much explanation.\n> \n> Yes, I suppose. I'm used to printed manuals having a page on\n> the meaning of different typefaces inside, but that's a bit\n> of a different situation.\n\nYes.\n\n> > I'm curious: Jonathan, was this the original patch the result of a\n> > real-life instance of confusion?  What happened?\n> \n> No, I'm actually a bit ashamed to have sent the patch... I was just\n> changing `git subcommand` to `git-subcommand` wherever it was the name\n> of a command, rather than the command line to run it, that was in\n> question. Consistency would have made the old example awkward, so I\n> looked around for alternatives.\n\nThat being the case, I'd rather leave the text as is; I'm uncomfortable\nadding new text to address something that isn't in practice a problem.\n\n--b.\n\n> \n> Why worry about whether the man pages have no consistent rule about\n> dashes? Since it is not obvious why the man pages use the dashed form\n> when they do, I think a fraction of people will naturally use the\n> dashed form by default. That means trouble once Git 1.6.0 comes out\n> (e.g. see Ingo's recent post\n> <http://thread.gmane.org/gmane.comp.version-control.git/87012/focus=87020>).\n> \n> Here's a patch implementing Junio's suggestion, because I do like it.\n> Please let me know what you think (especially ideas for making it\n> shorter).\n> \n> Thanks for all your thoughts so far. Sorry I took so long to get back.\n> \n> --- %< --- %< --- %< ----\n> Subject: gittutorial(7): add \"Conventions used in this document\" section\n>     \n> The manual page for the git subcommand invoked as \"git clone\" is\n> named git-clone(1), and similarly for the rest of the git\n> subcommands. This patch should make the convention a little\n> clearer when it is introduced at the beginning of gittutorial(7).\n> \n> Thanks to Junio C Hamano for the idea and wording.\n> \n> It remains to make an analogous change for user-manual.html\n> and maybe git(1).\n> \n> Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n> ---\n>  Documentation/gittutorial.txt |   35 ++++++++++++++++++++++++++++++-----\n>  1 files changed, 30 insertions(+), 5 deletions(-)\n> \n> diff --git a/Documentation/gittutorial.txt\n> b/Documentation/gittutorial.txt\n> index 036a27c..51ad814 100644\n> --- a/Documentation/gittutorial.txt\n> +++ b/Documentation/gittutorial.txt\n> @@ -19,12 +19,37 @@ If you are instead primarily interested in using\n> git to fetch a project,\n>  for example, to test the latest version, you may prefer to start with\n>  the first two chapters of link:user-manual.html[The Git User's Manual].\n>  \n> -First, note that you can get documentation for a command such as\n> -`git log --graph` with:\n> +Conventions used in this document\n> +---------------------------------\n>  \n> -------------------------------------------------\n> -$ man git-log\n> -------------------------------------------------\n> +When discussing a git subcommand 'cmd', this documentation\n> +typesets the name of it like 'git-cmd', and that is the name you\n> +ask for its manual page by.\n> +\n> +Examples are typeset like this: `$ git cmd`. (`$` is your command\n> +prompt; do not actually type it to your shell.) A subcommand\n> +is specified as the first parameter to the 'git' program\n> +when you actually run it from the command line.\n> +\n> +So a typical command description may go like this:\n> +\n> +To propagate the changes you made back to the original subversion\n> +repository, you would use the 'git-svn dcommit' command. It does\n> +these things (long description here).  Some examples:\n> +\n> +------------\n> +$ ... some example command sequence ...\n> +$ git svn dcommit\n> +------------\n> +\n> +For full details, type:\n> +\n> +------------\n> +$ man git-svn\n> +------------\n> +\n> +Introducing yourself to git\n> +---------------------------\n>  \n>  It is a good idea to introduce yourself to git with your name and\n>  public email address before doing any operation.  The easiest\n> -- \n> 1.5.5.GIT\n> \n"},{"id":"82178","messageId":"7vprpuwmjj.fsf@gitster.siamese.dyndns.org","threadId":"14232","inReplyTo":"Pine.GSO.4.62.0807022354520.16085@harper.uchicago.edu","subject":"Re: [PATCH 03/15] manpages: fix bogus whitespace","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2008-07-03T23:55:12Z","receivedAt":"2008-07-03T23:55:12Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Jonathan Nieder <jrnieder@uchicago.edu> writes:\n\n> It's distracting.\n>\n> Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu>\n> ---\n>  Documentation/git-fast-import.txt  |    2 +-\n>  Documentation/git-format-patch.txt |    8 ++++----\n>  Documentation/git-gui.txt          |    4 ++--\n>  3 files changed, 7 insertions(+), 7 deletions(-)\n>\n> diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt\n> index 70cc8e8..9602764 100644\n> --- a/Documentation/git-fast-import.txt\n> +++ b/Documentation/git-fast-import.txt\n> @@ -86,7 +86,7 @@ OPTIONS\n>  \n>  --quiet::\n>  \tDisable all non-fatal output, making fast-import silent when it\n> -\tis successful.\tThis option disables the output shown by\n> +\tis successful.  This option disables the output shown by\n\nHow did you find *this* one?  It took me a few minutes to finally notice\nthat you are talking about the HT.  In other words, I had to work hard to\nget distracted by it.\n"},{"id":"82193","messageId":"Pine.GSO.4.62.0807032001110.24268@harper.uchicago.edu","threadId":"14232","inReplyTo":"7vprpuwmjj.fsf@gitster.siamese.dyndns.org","subject":"Re: [PATCH 03/15] manpages: fix bogus whitespace","fromName":"Jonathan Nieder","fromEmail":"jrnieder@uchicago.edu","sentAt":"2008-07-04T01:14:20Z","receivedAt":"2008-07-04T01:14:20Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Junio C Hamano wrote:\n\n> Jonathan Nieder <jrnieder@uchicago.edu> writes:\n> \n>> -\tis successful.\tThis option disables the output shown by\n>> +\tis successful.  This option disables the output shown by\n> \n> How did you find *this* one?  It took me a few minutes to finally notice\n> that you are talking about the HT.  In other words, I had to work hard to\n> get distracted by it.\n\nI use vim with listchars=tab:>-,nbsp:~,trail:$ (I was bit too\nmany times by Makefiles mysteriously breaking) so the tab is\nvisibile.\n\nIf it feels like too much churn for no visible effect, I don't\nmind if you drop the patch. I feel bad for sending so many\ndocumentation patches that don't add to the content in any\nsignificant way.\n\nJonathan\n"}]}