Reorganize `git-log' man page to clarify common diff options.

This will reduce considerably the common confusion where people miss the `--follow' option, and wonder why `-M'/`-C' is not working. * Move the diff options include to after the log-specific flags, and add a "Common diff options" subtitle before them. (These options apply only when patches are shown, which is not a common use case among newbies, so having them first is confusing.) * Move the `--follow' description to the top of the listed options. The options before that seem less important: `--full-diff' applies only when patches are shown, `--source' and `--decorate' are less useful with many common commit specifications. * Clarify that `--follow' works only for a single path argument. Signed-off-by: Eli Barzilay <eli@barzilay.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Eli Barzilay committed Jul 7, 2010 at 22:14 UTC 4ded69169b02f08eb3e097bdf068d3061c049e91

1 file changed +9 -6

Documentation/git-log.txt

+9 -6

@@ -23,9 +23,6 @@ each commit introduces are shown.

23 OPTIONS

24 -------

26 -:git-log: 1

27 -include::diff-options.txt[]

28 -

26 -<n>::

27 Limits the number of commits to show.

@@ -37,6 +34,10 @@ include::diff-options.txt[]

34 and <until>, see "SPECIFYING REVISIONS" section in

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

37 +--follow::

38 + Continue listing the history of a file beyond renames

39 + (works only for a single file).

40 +

41 --no-decorate::

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

43 Print out the ref names of any commits that are shown. If 'short' is

@@ -56,9 +57,6 @@ include::diff-options.txt[]

57 the specified paths; this means that "<path>..." limits only

58 commits, and doesn't limit diff for those commits.

59 ---follow::

60 - Continue listing the history of a file beyond renames/copies.

61 -

60 --log-size::

61 Before the log message print out its size in bytes. Intended

62 mainly for porcelain tools consumption. If git is unable to

@@ -72,6 +70,11 @@ include::diff-options.txt[]

70 to be prefixed with "\-- " to separate them from options or

71 refnames.

73 +Common diff options

74 +~~~~~~~~~~~~~~~~~~~

75 +

76 +:git-log: 1

77 +include::diff-options.txt[]

79 include::rev-list-options.txt[]