Documentation: link to gitrevisions rather than git-rev-parse
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>
This commit is contained in:
parent
1ed6f2c5b9
commit
f028cdae66
@ -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
|
||||
|
@ -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
|
||||
|
@ -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].
|
||||
|
@ -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
|
||||
-------
|
||||
|
@ -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:
|
||||
|
@ -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
|
||||
|
@ -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]::
|
||||
|
@ -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
|
||||
|
@ -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"
|
||||
|
@ -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.
|
||||
|
@ -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>::
|
||||
|
@ -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[]
|
||||
|
||||
|
@ -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
|
||||
|
@ -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]
|
||||
|
@ -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>...::
|
||||
|
||||
|
@ -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
|
||||
|
Loading…
Reference in New Issue
Block a user