Subject: [PATCH v2 0/4] doc: include git rev-list description in git log doc

From: "Philippe Blain via GitGitGadget" <[email-masked]>
Date: Fri, 03 Jul 2020 03:38:25 +0000

This series moves the nice explanation in the 'Description' section of the 
git rev-list man page to a separate file and includes this file in the git
log man page.

This goal is to make readers more aware that they can write e.g.

git log branch1 branch2 branch3 branch4 --not master

to see commits on each of branch1-4, that are not on master, since this is
not immediately obvious (at least to me) in the git log man page. 

Note that I made several commits for ease of reviewing, I'll squash some if
this would be preferred.

Changes since v1: took a completely different approach following the
comments received from Junio and Taylor.

Philippe Blain (4):
  git-log.txt: add links to 'rev-list' and 'diff' docs
  git-rev-list.txt: move description to separate file
  git-log.txt: include rev-list-description.txt
  rev-list-description.txt: fix Asciidoc syntax

 Documentation/git-log.txt              |  7 ++-
 Documentation/git-rev-list.txt         | 40 +----------------
 Documentation/rev-list-description.txt | 61 ++++++++++++++++++++++++++
 3 files changed, 68 insertions(+), 40 deletions(-)
 create mode 100644 Documentation/rev-list-description.txt

base-commit: a08a83db2bf27f015bec9a435f6d73e223c21c5e
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-590%2Fphil-blain%2Fdoc-log-multiple-ranges-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-590/phil-blain/doc-log-multiple-ranges-v2
Pull-Request: https://github.com/gitgitgadget/git/pull/590

Range-diff vs v1:

 1:  16b8cdb55c ! 1:  59c48282a0 doc: log takes multiple revision ranges
     @@ Metadata
      Author: Philippe Blain <[email-masked]>
      
       ## Commit message ##
     -    doc: log takes multiple revision ranges
     +    git-log.txt: add links to 'rev-list' and 'diff' docs
      
     -    `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`
     +    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
     @@ Commit message
          Signed-off-by: Philippe Blain <[email-masked]>
      
       ## Documentation/git-log.txt ##
     -@@ Documentation/git-log.txt: git-log - Show commit logs
     - SYNOPSIS
     - --------
     - [verse]
     --'git log' [<options>] [<revision range>] [[--] <path>...]
     -+'git log' [<options>] [<revision range>...] [[--] <path>...]
     - 
     - DESCRIPTION
     +@@ Documentation/git-log.txt: DESCRIPTION
       -----------
       Shows the commit logs.
       
     @@ Documentation/git-log.txt: git-log - Show commit logs
       each commit introduces are shown.

     -@@ Documentation/git-log.txt: 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
     -
     - ## builtin/log.c ##
     -@@ builtin/log.c: 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
     - };
 -:  ---------- > 2:  daf00d9398 git-rev-list.txt: move description to separate file
 -:  ---------- > 3:  eeaf4fe5dc git-log.txt: include rev-list-description.txt
 -:  ---------- > 4:  3b923780c1 rev-list-description.txt: fix Asciidoc syntax

-- 
gitgitgadget