freshlybakedca.ke
Git fork
Merge branch 'rr/shortlog-doc'
Update documentation for "log" and "shortlog".
* rr/shortlog-doc:
builtin/shortlog.c: make usage string consistent with log
builtin/log.c: make usage string consistent with doc
git-shortlog.txt: make SYNOPSIS match log, update OPTIONS
git-log.txt: rewrite note on why "--" may be required
git-log.txt: generalize <since>..<until>
git-log.txt: order OPTIONS properly; move <since>..<until>
revisions.txt: clarify the .. and ... syntax
git-shortlog.txt: remove (-h|--help) from OPTIONS
+12
-10
Documentation/git-log.txt
+12
-10
Documentation/git-log.txt
···
9
9
SYNOPSIS
10
10
--------
11
11
[verse]
12
-
'git log' [<options>] [<since>..<until>] [[\--] <path>...]
12
+
'git log' [<options>] [<revision range>] [[\--] <path>...]
13
13
14
14
DESCRIPTION
15
15
-----------
···
23
23
24
24
OPTIONS
25
25
-------
26
-
27
-
<since>..<until>::
28
-
Show only commits between the named two commits. When
29
-
either <since> or <until> is omitted, it defaults to
30
-
`HEAD`, i.e. the tip of the current branch.
31
-
For a more complete list of ways to spell <since>
32
-
and <until>, see linkgit:gitrevisions[7].
33
26
34
27
--follow::
35
28
Continue listing the history of a file beyond renames
···
69
62
Note that only message is considered, if also a diff is shown
70
63
its size is not included.
71
64
65
+
<revision range>::
66
+
Show only commits in the specified revision range. When no
67
+
<revision range> is specified, it defaults to `HEAD` (i.e. the
68
+
whole history leading to the current commit). `origin..HEAD`
69
+
specifies all the commits reachable from the current commit
70
+
(i.e. `HEAD`), but not from `origin`. For a complete list of
71
+
ways to spell <revision range>, see the "Specifying Ranges"
72
+
section of linkgit:gitrevisions[7].
73
+
72
74
[\--] <path>...::
73
75
Show only commits that are enough to explain how the files
74
76
that match the specified paths came to be. See "History
75
77
Simplification" below for details and other simplification
76
78
modes.
77
79
+
78
-
To prevent confusion with options and branch names, paths may need to
79
-
be prefixed with "\-- " to separate them from options or refnames.
80
+
Paths may need to be prefixed with "\-- " to separate them from
81
+
options or the revision range, when confusion arises.
80
82
81
83
include::rev-list-options.txt[]
82
84
+17
-6
Documentation/git-shortlog.txt
+17
-6
Documentation/git-shortlog.txt
···
8
8
SYNOPSIS
9
9
--------
10
10
[verse]
11
-
git log --pretty=short | 'git shortlog' [-h] [-n] [-s] [-e] [-w]
12
-
'git shortlog' [-n|--numbered] [-s|--summary] [-e|--email] [-w[<width>[,<indent1>[,<indent2>]]]] <commit>...
11
+
git log --pretty=short | 'git shortlog' [<options>]
12
+
'git shortlog' [<options>] [<revision range>] [[\--] <path>...]
13
13
14
14
DESCRIPTION
15
15
-----------
···
25
25
26
26
OPTIONS
27
27
-------
28
-
29
-
-h::
30
-
--help::
31
-
Print a short usage message and exit.
32
28
33
29
-n::
34
30
--numbered::
···
60
56
If width is `0` (zero) then indent the lines of the output without wrapping
61
57
them.
62
58
59
+
<revision range>::
60
+
Show only commits in the specified revision range. When no
61
+
<revision range> is specified, it defaults to `HEAD` (i.e. the
62
+
whole history leading to the current commit). `origin..HEAD`
63
+
specifies all the commits reachable from the current commit
64
+
(i.e. `HEAD`), but not from `origin`. For a complete list of
65
+
ways to spell <revision range>, see the "Specifying Ranges"
66
+
section of linkgit:gitrevisions[7].
67
+
68
+
[\--] <path>...::
69
+
Consider only commits that are enough to explain how the files
70
+
that match the specified paths came to be.
71
+
+
72
+
Paths may need to be prefixed with "\-- " to separate them from
73
+
options or the revision range, when confusion arises.
63
74
64
75
MAPPING AUTHORS
65
76
---------------
+4
-2
Documentation/revisions.txt
+4
-2
Documentation/revisions.txt
···
244
244
245
245
'<rev1>..<rev2>'::
246
246
Include commits that are reachable from <rev2> but exclude
247
-
those that are reachable from <rev1>.
247
+
those that are reachable from <rev1>. When either <rev1> or
248
+
<rev2> is omitted, it defaults to 'HEAD'.
248
249
249
250
'<rev1>\...<rev2>'::
250
251
Include commits that are reachable from either <rev1> or
251
-
<rev2> but exclude those that are reachable from both.
252
+
<rev2> but exclude those that are reachable from both. When
253
+
either <rev1> or <rev2> is omitted, it defaults to 'HEAD'.
252
254
253
255
'<rev>{caret}@', e.g. 'HEAD{caret}@'::
254
256
A suffix '{caret}' followed by an at sign is the same as listing
+1
-1
builtin/log.c
+1
-1
builtin/log.c
···
37
37
static const char *fmt_pretty;
38
38
39
39
static const char * const builtin_log_usage[] = {
40
-
N_("git log [<options>] [<since>..<until>] [[--] <path>...]\n")
40
+
N_("git log [<options>] [<revision range>] [[--] <path>...]\n")
41
41
N_(" or: git show [options] <object>..."),
42
42
NULL
43
43
};
+1
-3
builtin/shortlog.c
+1
-3
builtin/shortlog.c
···
10
10
#include "parse-options.h"
11
11
12
12
static char const * const shortlog_usage[] = {
13
-
N_("git shortlog [-n] [-s] [-e] [-w] [rev-opts] [--] [<commit-id>... ]"),
14
-
"",
15
-
N_("[rev-opts] are documented in git-rev-list(1)"),
13
+
N_("git shortlog [<options>] [<revision range>] [[--] [<path>...]]"),
16
14
NULL
17
15
};
18
16