@matheusbsbs / matheus-bagliano / commits / f028cdae66

Fork 0

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>

Michael J Gruber committed Jul 5, 2010 at 18:11 UTC f028cdae6663166ebfd777e73aacce1f5e7159d6

16 files changed +21 -22

Documentation/git-cat-file.txt

+1 -1

@@ -27,7 +27,7 @@ OPTIONS

27 <object>::

28 The name of the object to show.

29 For a more complete list of ways to spell object names, see

30 - the "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].

30 + the "SPECIFYING REVISIONS" section in linkgit:gitrevisions[1].

32 -t::

33 Instead of the content, show the object type identified by

Documentation/git-check-ref-format.txt

+1 -1

@@ -49,7 +49,7 @@ git imposes the following rules on how references are named:

49 These rules make it easy for shell script based tools to parse

50 reference names, pathname expansion by the shell when a reference name is used

51 unquoted (by mistake), and also avoids ambiguities in certain

52 -reference name expressions (see linkgit:git-rev-parse[1]):

52 +reference name expressions (see linkgit:gitrevisions[1]):

54 . A double-dot `..` is often used as in `ref1..ref2`, and in some

55 contexts this notation means `{caret}ref1 ref2` (i.e. not in

Documentation/git-cherry-pick.txt

+2 -2

@@ -20,8 +20,8 @@ OPTIONS

20 -------

21 <commit>...::

22 Commits to cherry-pick.

23 - For a more complete list of ways to spell commits, see the

24 - "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].

23 + For a more complete list of ways to spell commits, see

24 + linkgit:gitrevisions[1].

25 Sets of commits can be passed but no traversal is done by

26 default, as if the '--no-walk' option was specified, see

27 linkgit:git-rev-list[1].

Documentation/git-diff.txt

+2 -2

@@ -68,11 +68,11 @@ for the last two forms that use ".." notations, can be any

68 <tree-ish>.

70 For a more complete list of ways to spell <commit>, see

71 -"SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].

71 +"SPECIFYING REVISIONS" section in linkgit:gitrevisions[1].

72 However, "diff" is about comparing two _endpoints_, not ranges,

73 and the range notations ("<commit>..<commit>" and

74 "<commit>\...<commit>") do not mean a range as defined in the

75 -"SPECIFYING RANGES" section in linkgit:git-rev-parse[1].

75 +"SPECIFYING RANGES" section in linkgit:gitrevisions[1].

77 OPTIONS

78 -------

Documentation/git-fast-import.txt

+1 -1

@@ -439,7 +439,7 @@ Marks must be declared (via `mark`) before they can be used.

439 * A complete 40 byte or abbreviated commit SHA-1 in hex.

440

441 * Any valid Git SHA-1 expression that resolves to a commit. See

442 - ``SPECIFYING REVISIONS'' in linkgit:git-rev-parse[1] for details.

442 + ``SPECIFYING REVISIONS'' in linkgit:gitrevisions[1] for details.

443

444 The special case of restarting an incremental import from the

445 current branch value should be written as:

Documentation/git-format-patch.txt

+1 -1

@@ -39,7 +39,7 @@ There are two ways to specify which commits to operate on.

39 that leads to the <since> to be output.

41 2. Generic <revision range> expression (see "SPECIFYING

42 - REVISIONS" section in linkgit:git-rev-parse[1]) means the

42 + REVISIONS" section in linkgit:gitrevisions[1]) means the

43 commits in the specified range.

45 The first rule takes precedence in the case of a single <commit>. To

Documentation/git-log.txt

+1 -2

@@ -34,8 +34,7 @@ include::diff-options.txt[]

34 either <since> or <until> is omitted, it defaults to

35 `HEAD`, i.e. the tip of the current branch.

36 For a more complete list of ways to spell <since>

37 - and <until>, see "SPECIFYING REVISIONS" section in

38 - linkgit:git-rev-parse[1].

37 + and <until>, see linkgit:gitrevisions[1].

39 --no-decorate::

40 --decorate[=short|full|no]::

Documentation/git-push.txt

+1 -1

@@ -41,7 +41,7 @@ OPTIONS[[OPTIONS]]

41 +

42 The <src> is often the name of the branch you would want to push, but

43 it can be any arbitrary "SHA-1 expression", such as `master~4` or

44 -`HEAD` (see linkgit:git-rev-parse[1]).

44 +`HEAD` (see linkgit:gitrevisions[1]).

45 +

46 The <dst> tells which ref on the remote side is updated with this

47 push. Arbitrary expressions cannot be used here, an actual ref must

Documentation/git-reflog.txt

+1 -1

@@ -40,7 +40,7 @@ see linkgit:git-log[1].

40 The reflog is useful in various git commands, to specify the old value

41 of a reference. For example, `HEAD@\{2\}` means "where HEAD used to be

42 two moves ago", `master@\{one.week.ago\}` means "where master used to

43 -point to one week ago", and so on. See linkgit:git-rev-parse[1] for

43 +point to one week ago", and so on. See linkgit:gitrevisions[1] for

44 more details.

46 To delete single entries from the reflog, use the subcommand "delete"

Documentation/git-revert.txt

+1 -1

@@ -31,7 +31,7 @@ OPTIONS

31 <commit>...::

32 Commits to revert.

33 For a more complete list of ways to spell commit names, see

34 - "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].

34 + linkgit:gitrevisions[1].

35 Sets of commits can also be given but no traversal is done by

36 default, see linkgit:git-rev-list[1] and its '--no-walk'

37 option.

Documentation/git-show-branch.txt

+1 -1

@@ -32,7 +32,7 @@ no <rev> nor <glob> is given on the command line.

32 OPTIONS

33 -------

34 <rev>::

35 - Arbitrary extended SHA1 expression (see linkgit:git-rev-parse[1])

35 + Arbitrary extended SHA1 expression (see linkgit:gitrevisions[1])

36 that typically names a branch head or a tag.

38 <glob>::

Documentation/git-show.txt

+1 -1

@@ -36,7 +36,7 @@ OPTIONS

36 <object>...::

37 The names of objects to show.

38 For a more complete list of ways to spell object names, see

39 - "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].

39 + "SPECIFYING REVISIONS" section in linkgit:gitrevisions[1].

41 include::pretty-options.txt[]

Documentation/git.txt

+1 -1

@@ -479,7 +479,7 @@ HEAD::

479 (i.e. the contents of `$GIT_DIR/refs/heads/<head>`).

480

481 For a more complete list of ways to spell object names, see

482 -"SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].

482 +"SPECIFYING REVISIONS" section in linkgit:gitrevisions[1].

483

484

485 File/Directory Structure

Documentation/gitcore-tutorial.txt

+1 -1

@@ -971,7 +971,7 @@ commits from the master branch. The string inside brackets

971 before the commit log message is a short name you can use to

972 name the commit. In the above example, 'master' and 'mybranch'

973 are branch heads. 'master^' is the first parent of 'master'

974 -branch head. Please see linkgit:git-rev-parse[1] if you want to

974 +branch head. Please see linkgit:gitrevisions[1] if you want to

975 see more complex cases.

976

977 [NOTE]

Documentation/gitk.txt

+1 -1

@@ -69,7 +69,7 @@ frequently used options.

69 the form "'<from>'..'<to>'" to show all revisions between '<from>' and

70 back to '<to>'. Note, more advanced revision selection can be applied.

71 For a more complete list of ways to spell object names, see

72 - "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].

72 + linkgit:gitrevisions[1].

74 <path>...::

Documentation/user-manual.txt

+4 -4

@@ -397,7 +397,7 @@ is usually a shortcut for the HEAD branch in the repository "origin".

397 For the complete list of paths which git checks for references, and

398 the order it uses to decide which to choose when there are multiple

399 references with the same shorthand name, see the "SPECIFYING

400 -REVISIONS" section of linkgit:git-rev-parse[1].

400 +REVISIONS" section of linkgit:gitrevisions[1].

401

402 [[Updating-a-repository-With-git-fetch]]

403 Updating a repository with git fetch

@@ -568,7 +568,7 @@ We have seen several ways of naming commits already:

568 - HEAD: refers to the head of the current branch

569

570 There are many more; see the "SPECIFYING REVISIONS" section of the

571 -linkgit:git-rev-parse[1] man page for the complete list of ways to

571 +linkgit:gitrevisions[1] man page for the complete list of ways to

572 name revisions. Some examples:

573

574 -------------------------------------------------

@@ -909,7 +909,7 @@ commits reachable from some head but not from any tag in the repository:

909 $ gitk $( git show-ref --heads ) --not $( git show-ref --tags )

910 -------------------------------------------------

911

912 -(See linkgit:git-rev-parse[1] for explanations of commit-selecting

912 +(See linkgit:gitrevisions[1] for explanations of commit-selecting

913 syntax such as `--not`.)

914

915 [[making-a-release]]

@@ -1635,7 +1635,7 @@ you've checked out.

1635 The reflogs are kept by default for 30 days, after which they may be

1636 pruned. See linkgit:git-reflog[1] and linkgit:git-gc[1] to learn

1637 how to control this pruning, and see the "SPECIFYING REVISIONS"

1638 -section of linkgit:git-rev-parse[1] for details.

1638 +section of linkgit:gitrevisions[1] for details.

1639

1640 Note that the reflog history is very different from normal git history.

1641 While normal history is shared by every repository that works on the