Code

Documentation: link to gitrevisions rather than git-rev-parse
authorMichael J Gruber <git@drmicha.warpmail.net>
Mon, 5 Jul 2010 16:11:41 +0000 (18:11 +0200)
committerJunio C Hamano <gitster@pobox.com>
Mon, 5 Jul 2010 20:39:13 +0000 (13:39 -0700)
Currently, whenever we need documentation for revisions and ranges, we
link to the git-rev-parse man page, i.e. a plumbing man page, which has
this along with the documentation of all rev-parse modes.

Link to the new gitrevisions man page instead in all cases except
- when the actual git-rev-parse command is referred to or
- in very technical context (git-send-pack).

Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
16 files changed:
Documentation/git-cat-file.txt
Documentation/git-check-ref-format.txt
Documentation/git-cherry-pick.txt
Documentation/git-diff.txt
Documentation/git-fast-import.txt
Documentation/git-format-patch.txt
Documentation/git-log.txt
Documentation/git-push.txt
Documentation/git-reflog.txt
Documentation/git-revert.txt
Documentation/git-show-branch.txt
Documentation/git-show.txt
Documentation/git.txt
Documentation/gitcore-tutorial.txt
Documentation/gitk.txt
Documentation/user-manual.txt

index 9ebbe9402b216d33fb7148f2f796d1f58d12cfd9..a3f56b07fd251cbd121c28189d1f9018b892b48e 100644 (file)
@@ -27,7 +27,7 @@ OPTIONS
 <object>::
        The name of the object to show.
        For a more complete list of ways to spell object names, see
-       the "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
+       the "SPECIFYING REVISIONS" section in linkgit:gitrevisions[1].
 
 -t::
        Instead of the content, show the object type identified by
index 379eee6734323ee566480d5f9159dd28ed27ecd2..f5c2e0601db6782b2a8690c687611b93da935024 100644 (file)
@@ -49,7 +49,7 @@ git imposes the following rules on how references are named:
 These rules make it easy for shell script based tools to parse
 reference names, pathname expansion by the shell when a reference name is used
 unquoted (by mistake), and also avoids ambiguities in certain
-reference name expressions (see linkgit:git-rev-parse[1]):
+reference name expressions (see linkgit:gitrevisions[1]):
 
 . A double-dot `..` is often used as in `ref1..ref2`, and in some
   contexts this notation means `{caret}ref1 ref2` (i.e. not in
index ca485dbac19da231eca045bcf55c6b5df87e8dec..2cef579316ba11e68d65dc4d7309f2e56a465b3d 100644 (file)
@@ -20,8 +20,8 @@ OPTIONS
 -------
 <commit>...::
        Commits to cherry-pick.
-       For a more complete list of ways to spell commits, see the
-       "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
+       For a more complete list of ways to spell commits, see
+       linkgit:gitrevisions[1].
        Sets of commits can be passed but no traversal is done by
        default, as if the '--no-walk' option was specified, see
        linkgit:git-rev-list[1].
index 723a64872fd4b43612d576781d915a7538189f46..08fd4099addac3959e5aedbd1a0668367f07bb21 100644 (file)
@@ -68,11 +68,11 @@ for the last two forms that use ".." notations, can be any
 <tree-ish>.
 
 For a more complete list of ways to spell <commit>, see
-"SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
+"SPECIFYING REVISIONS" section in linkgit:gitrevisions[1].
 However, "diff" is about comparing two _endpoints_, not ranges,
 and the range notations ("<commit>..<commit>" and
 "<commit>\...<commit>") do not mean a range as defined in the
-"SPECIFYING RANGES" section in linkgit:git-rev-parse[1].
+"SPECIFYING RANGES" section in linkgit:gitrevisions[1].
 
 OPTIONS
 -------
index 19082b04eb7ec77bcf974e0c76b8d20bb736c021..77a0a2481a34f987aab4688002a6e6a0ae2e497f 100644 (file)
@@ -439,7 +439,7 @@ Marks must be declared (via `mark`) before they can be used.
 * A complete 40 byte or abbreviated commit SHA-1 in hex.
 
 * Any valid Git SHA-1 expression that resolves to a commit.  See
-  ``SPECIFYING REVISIONS'' in linkgit:git-rev-parse[1] for details.
+  ``SPECIFYING REVISIONS'' in linkgit:gitrevisions[1] for details.
 
 The special case of restarting an incremental import from the
 current branch value should be written as:
index c8c81e8437c5fdd4ca488e3889345c9831a66329..4b3f5ba5358da469feff4e861e69717f16e81d21 100644 (file)
@@ -39,7 +39,7 @@ There are two ways to specify which commits to operate on.
    that leads to the <since> to be output.
 
 2. Generic <revision range> expression (see "SPECIFYING
-   REVISIONS" section in linkgit:git-rev-parse[1]) means the
+   REVISIONS" section in linkgit:gitrevisions[1]) means the
    commits in the specified range.
 
 The first rule takes precedence in the case of a single <commit>.  To
index 0e6ff3182347c03a9ae9c3992fd1e8a6db2867f9..8a69647f5c36979daea537f20cab6f02875ff619 100644 (file)
@@ -34,8 +34,7 @@ include::diff-options.txt[]
        either <since> or <until> is omitted, it defaults to
        `HEAD`, i.e. the tip of the current branch.
        For a more complete list of ways to spell <since>
-       and <until>, see "SPECIFYING REVISIONS" section in
-       linkgit:git-rev-parse[1].
+       and <until>, see linkgit:gitrevisions[1].
 
 --no-decorate::
 --decorate[=short|full|no]::
index 48570242fb2dda31a5684e2d678d40690d3c4cab..b68abff28a0fe27fbcb2bbffa2296cffb1297eaf 100644 (file)
@@ -41,7 +41,7 @@ OPTIONS[[OPTIONS]]
 +
 The <src> is often the name of the branch you would want to push, but
 it can be any arbitrary "SHA-1 expression", such as `master~4` or
-`HEAD` (see linkgit:git-rev-parse[1]).
+`HEAD` (see linkgit:gitrevisions[1]).
 +
 The <dst> tells which ref on the remote side is updated with this
 push. Arbitrary expressions cannot be used here, an actual ref must
index 4eaa62b6913f15c354e8008c2884f476428ebb0b..5a0451aaf377d13590d6112a9ee8cf51e217a21d 100644 (file)
@@ -40,7 +40,7 @@ see linkgit:git-log[1].
 The reflog is useful in various git commands, to specify the old value
 of a reference. For example, `HEAD@\{2\}` means "where HEAD used to be
 two moves ago", `master@\{one.week.ago\}` means "where master used to
-point to one week ago", and so on. See linkgit:git-rev-parse[1] for
+point to one week ago", and so on. See linkgit:gitrevisions[1] for
 more details.
 
 To delete single entries from the reflog, use the subcommand "delete"
index dea4f53522271ee329658169c2aed41d797dc8a8..b7d9ef7e4726db40f3b0d1ec9474494bb6e07dcf 100644 (file)
@@ -31,7 +31,7 @@ OPTIONS
 <commit>...::
        Commits to revert.
        For a more complete list of ways to spell commit names, see
-       "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
+       linkgit:gitrevisions[1].
        Sets of commits can also be given but no traversal is done by
        default, see linkgit:git-rev-list[1] and its '--no-walk'
        option.
index f1499bba88028775032819708db22a3250b5b840..81ba29669c52a7c50fb126b7b70c3a867df25f00 100644 (file)
@@ -32,7 +32,7 @@ no <rev> nor <glob> is given on the command line.
 OPTIONS
 -------
 <rev>::
-       Arbitrary extended SHA1 expression (see linkgit:git-rev-parse[1])
+       Arbitrary extended SHA1 expression (see linkgit:gitrevisions[1])
        that typically names a branch head or a tag.
 
 <glob>::
index 55e687a7c7f2113615c80e1719c4f3a2120ba7fa..0002bfb0455b38eecf6b29da6a2464058ba42c57 100644 (file)
@@ -36,7 +36,7 @@ OPTIONS
 <object>...::
        The names of objects to show.
        For a more complete list of ways to spell object names, see
-       "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
+       "SPECIFYING REVISIONS" section in linkgit:gitrevisions[1].
 
 include::pretty-options.txt[]
 
index 8f0dd7fe702ee5ab74e4ab0f35ead780f9e31d49..12066ab3fc2ba37c0a9eb291d40e1fb4a985714b 100644 (file)
@@ -479,7 +479,7 @@ HEAD::
        (i.e. the contents of `$GIT_DIR/refs/heads/<head>`).
 
 For a more complete list of ways to spell object names, see
-"SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
+"SPECIFYING REVISIONS" section in linkgit:gitrevisions[1].
 
 
 File/Directory Structure
index f7815e96a268f0eac7602e03255c28ea2fe04e6b..ed3ddc92cb51eaeb3d4a988e396a4f90297037c6 100644 (file)
@@ -971,7 +971,7 @@ commits from the master branch.  The string inside brackets
 before the commit log message is a short name you can use to
 name the commit.  In the above example, 'master' and 'mybranch'
 are branch heads.  'master^' is the first parent of 'master'
-branch head.  Please see linkgit:git-rev-parse[1] if you want to
+branch head.  Please see linkgit:gitrevisions[1] if you want to
 see more complex cases.
 
 [NOTE]
index 99baa24a2d5c8c703d3ad5ce7442bb8363359cd6..05ac1c79f768352be8756eeb483e71f0d09131de 100644 (file)
@@ -69,7 +69,7 @@ frequently used options.
        the form "'<from>'..'<to>'" to show all revisions between '<from>' and
        back to '<to>'. Note, more advanced revision selection can be applied.
        For a more complete list of ways to spell object names, see
-       "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
+       linkgit:gitrevisions[1].
 
 <path>...::
 
index fe6fb722da1a5c288c7ae3757622aac8cac79a73..22aee34d4a49b242370e5244f35d542ad0b79391 100644 (file)
@@ -397,7 +397,7 @@ is usually a shortcut for the HEAD branch in the repository "origin".
 For the complete list of paths which git checks for references, and
 the order it uses to decide which to choose when there are multiple
 references with the same shorthand name, see the "SPECIFYING
-REVISIONS" section of linkgit:git-rev-parse[1].
+REVISIONS" section of linkgit:gitrevisions[1].
 
 [[Updating-a-repository-With-git-fetch]]
 Updating a repository with git fetch
@@ -568,7 +568,7 @@ We have seen several ways of naming commits already:
        - HEAD: refers to the head of the current branch
 
 There are many more; see the "SPECIFYING REVISIONS" section of the
-linkgit:git-rev-parse[1] man page for the complete list of ways to
+linkgit:gitrevisions[1] man page for the complete list of ways to
 name revisions.  Some examples:
 
 -------------------------------------------------
@@ -909,7 +909,7 @@ commits reachable from some head but not from any tag in the repository:
 $ gitk $( git show-ref --heads ) --not  $( git show-ref --tags )
 -------------------------------------------------
 
-(See linkgit:git-rev-parse[1] for explanations of commit-selecting
+(See linkgit:gitrevisions[1] for explanations of commit-selecting
 syntax such as `--not`.)
 
 [[making-a-release]]
@@ -1635,7 +1635,7 @@ you've checked out.
 The reflogs are kept by default for 30 days, after which they may be
 pruned.  See linkgit:git-reflog[1] and linkgit:git-gc[1] to learn
 how to control this pruning, and see the "SPECIFYING REVISIONS"
-section of linkgit:git-rev-parse[1] for details.
+section of linkgit:gitrevisions[1] for details.
 
 Note that the reflog history is very different from normal git history.
 While normal history is shared by every repository that works on the