From: Philippe Blain <levraiphilippeblain@xxxxxxxxx>
`git log` accepts multiple revision ranges, but makes no mention of that
in its documentation. Currently readers have to go to the `git
rev-list` documentation to discover this useful feature.
Mention it and adjust the synopsys in the doc and in the short
help for `git log`.
Also add links to the documentation for `git rev-list` and `git diff`
instead of simply mentioning them, to make it easier for readers to reach
these documentation pages. Let's link to `git diff` as this is the
porcelain command, and the rest of the family (`diff-index`, `diff-tree` and
`diff-files`) are mentioned in the "Raw output format" section of the
`git diff` documentation.
Signed-off-by: Philippe Blain <levraiphilippeblain@xxxxxxxxx>
---
doc: log takes multiple revision ranges
I hesitated to send this in two patches but decided not to, if it would
be preferred I'll split it.
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-590%2Fphil-blain%2Fdoc-log-multiple-ranges-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-590/phil-blain/doc-log-multiple-ranges-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/590
Documentation/git-log.txt | 12 ++++++------
builtin/log.c | 2 +-
2 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index bed09bb09e5..fa8affd436a 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -9,15 +9,15 @@ git-log - Show commit logs
SYNOPSIS
--------
[verse]
-'git log' [<options>] [<revision range>] [[--] <path>...]
+'git log' [<options>] [<revision range>...] [[--] <path>...]
DESCRIPTION
-----------
Shows the commit logs.
-The command takes options applicable to the `git rev-list`
+The command takes options applicable to the linkgit:git-rev-list[1]
command to control what is shown and how, and options applicable to
-the `git diff-*` commands to control how the changes
+the linkgit:git-diff[1] family of commands to control how the changes
each commit introduces are shown.
@@ -90,9 +90,9 @@ include::line-range-format.txt[]
<revision range> is specified, it defaults to `HEAD` (i.e. the
whole history leading to the current commit). `origin..HEAD`
specifies all the commits reachable from the current commit
- (i.e. `HEAD`), but not from `origin`. For a complete list of
- ways to spell <revision range>, see the 'Specifying Ranges'
- section of linkgit:gitrevisions[7].
+ (i.e. `HEAD`), but not from `origin`. You can give more than
+ one revision range. For a complete list of ways to spell <revision range>,
+ see the 'Specifying Ranges' section of linkgit:gitrevisions[7].
[--] <path>...::
Show only commits that are enough to explain how the files
diff --git a/builtin/log.c b/builtin/log.c
index 83a4a6188e2..51c2ef54823 100644
--- a/builtin/log.c
+++ b/builtin/log.c
@@ -53,7 +53,7 @@ static const char *fmt_patch_subject_prefix = "PATCH";
static const char *fmt_pretty;
static const char * const builtin_log_usage[] = {
- N_("git log [<options>] [<revision-range>] [[--] <path>...]"),
+ N_("git log [<options>] [<revision-range>...] [[--] <path>...]"),
N_("git show [<options>] <object>..."),
NULL
};
base-commit: 076cbdcd739aeb33c1be87b73aebae5e43d7bcc5
--
gitgitgadget
