git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v2 1/4] git-log.txt: add links to 'rev-list' and 'diff' docs

From
Junio C Hamano <gitster@pobox.com>
Date
Jul 7, 2020, 00:55 UTC
Message-ID
<xmqqimf087pq.fsf@gitster.c.googlers.com>
In-Reply-To
<59c48282a094e90b7f4635c4cbcc04b1914b4c0e.1593747509.git.gitgitgadget@gmail.com>
"Philippe Blain via GitGitGadget" <gitgitgadget@gmail.com> writes:
Show 28 quoted lines
> From: Philippe Blain <levraiphilippeblain@gmail.com>
>
> 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@gmail.com>
> ---
>  Documentation/git-log.txt | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
> index 20e6d21a74..04ea18d1c0 100644
> --- a/Documentation/git-log.txt
> +++ b/Documentation/git-log.txt
> @@ -15,9 +15,9 @@ 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.

The original did mean "git diff-*" family of plumbing commands, but I think it makes more sense these days to just refer to "git diff" Porcelain, which is the single entry point everybody uses. So you would probably want to further replace "family of commands" with just "command" in the text.

Other than that, I think making these into links is a good idea.
Previous: Philippe Blain via GitGitGadgetNext: Philippe Blain
Message 10 of 23 in “doc: log takes multiple revision ranges”
  1. doc: log takes multiple revision rangesPhilippe Blain via GitGitGadget, Mar 28, 2020
  2. Junio C HamanoMar 29, 2020
  3. Philippe BlainMar 30, 2020
  4. Junio C HamanoMar 30, 2020
  5. Philip OakleyJul 5, 2020
  6. Philippe BlainJul 7, 2020
  7. Taylor BlauMar 31, 2020
  8. 0/4 doc: include git rev-list description in git log docPhilippe Blain via GitGitGadget, Jul 3, 2020
  9. 1/4 git-log.txt: add links to 'rev-list' and 'diff' docsPhilippe Blain via GitGitGadget, Jul 3, 2020
  10. Junio C HamanoJul 7, 2020
  11. Philippe BlainJul 7, 2020
  12. 3/4 git-log.txt: include rev-list-description.txtPhilippe Blain via GitGitGadget, Jul 3, 2020
  13. 2/4 git-rev-list.txt: move description to separate filePhilippe Blain via GitGitGadget, Jul 3, 2020
  14. 4/4 rev-list-description.txt: fix Asciidoc syntaxPhilippe Blain via GitGitGadget, Jul 3, 2020
  15. Junio C HamanoJul 7, 2020
  16. Philippe BlainJul 7, 2020
  17. 0/6 doc: include git rev-list description in git log docPhilippe Blain via GitGitGadget, Jul 9, 2020
  18. 1/6 git-log.txt: add links to 'rev-list' and 'diff' docsPhilippe Blain via GitGitGadget, Jul 9, 2020
  19. 4/6 git-rev-list.txt: tweak wording in set operationsPhilippe Blain via GitGitGadget, Jul 9, 2020
  20. 2/6 revisions.txt: describe 'rev1 rev2 ...' meaning for rangesPhilippe Blain via GitGitGadget, Jul 9, 2020
  21. 3/6 git-rev-list.txt: fix Asciidoc syntaxPhilippe Blain via GitGitGadget, Jul 9, 2020
  22. 5/6 git-rev-list.txt: move description to separate filePhilippe Blain via GitGitGadget, Jul 9, 2020
  23. 6/6 git-log.txt: include rev-list-description.txtPhilippe Blain via GitGitGadget, Jul 9, 2020

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.