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

[PATCH 1/3] rev-list-options.txt: fix rendering of bonus paragraph

From
MÅMartin Ågren <martin.agren@gmail.com>
Date
Feb 17, 2021, 19:56 UTC
Message-ID
<888eca4c3544864fbe222de43b50d4fa25700fea.1613590761.git.martin.agren@gmail.com>
In-Reply-To
<cover.1613590761.git.martin.agren@gmail.com>

In git-log(1) -- but not in git-shortlog(1) or git-rev-list(1) -- we include a bonus paragraph in the description of `--first-parent`. But we forgot to add a lone "+" for a list continuation, and we shouldn't be indenting this second paragraph. As a result, we get a different indentation and the `backticks` render literally.

Signed-off-by: Martin Ågren <martin.agren@gmail.com>
---
 doc-diff:
 --- a/.../man/man1/git-log.1
 +++ b/.../man/man1/git-log.1
 @@ -264,8 +264,8 @@ OPTIONS
             time, and this option allows you to ignore the individual commits
             brought in to your history by such a merge.
 -               This option also changes default diff format for merge commits
 -               to `first-parent`, see `--diff-merges=first-parent` for details.
 +           This option also changes default diff format for merge commits to
 +           first-parent, see --diff-merges=first-parent for details.
         --not
             Reverses the meaning of the ^ prefix (or lack thereof) for all
 Documentation/rev-list-options.txt | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt
index 96cc89d157..2fa1629f1e 100644
--- a/Documentation/rev-list-options.txt
+++ b/Documentation/rev-list-options.txt
@@ -129,10 +129,10 @@ parents) and `--max-parents=-1` (negative numbers denote no upper limit).
 	adjusting to updated upstream from time to time, and
 	this option allows you to ignore the individual commits
 	brought in to your history by such a merge.
-
 ifdef::git-log[]
-	This option also changes default diff format for merge commits
-	to `first-parent`, see `--diff-merges=first-parent` for details.
++
+This option also changes default diff format for merge commits
+to `first-parent`, see `--diff-merges=first-parent` for details.
 endif::git-log[]
 
 --not::
-- 
2.30.0.284.gd98b1dd5ea
Previous: Martin ÅgrenNext: Martin Ågren
Message 2 of 12 in “fix some doc rendering issues since v2.30.0”
  1. 0/3 fix some doc rendering issues since v2.30.0Martin Ågren, Feb 17, 2021
  2. 1/3 rev-list-options.txt: fix rendering of bonus paragraphMartin Ågren, Feb 17, 2021
  3. 2/3 git.txt: fix monospace renderingMartin Ågren, Feb 17, 2021
  4. Chris TorekFeb 17, 2021
  5. Martin ÅgrenFeb 18, 2021
  6. Patrick SteinhardtFeb 18, 2021
  7. Martin ÅgrenFeb 18, 2021
  8. Junio C HamanoFeb 18, 2021
  9. Martin ÅgrenFeb 19, 2021
  10. 3/3 gitmailmap.txt: fix rendering of e-mail addressesMartin Ågren, Feb 17, 2021
  11. Ævar Arnfjörð BjarmasonFeb 18, 2021
  12. Junio C HamanoFeb 17, 2021

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.