{"thread":{"id":"63603","subject":"[PATCH 0/9] Doc git log","startedAt":"2025-06-08T09:09:50Z","lastAt":"2025-08-20T21:23:45Z","messageCount":50,"participants":["Jean-Noël Avila via GitGitGadget","Junio C Hamano","Jean-Noël AVILA","Kristoffer Haugsbakk","SZEDER Gábor","Jean-Noël Avila"],"isPatch":true,"patchVersion":1,"patchTotal":9},"messages":[{"id":"519912","messageId":"pull.1933.git.1749373787.gitgitgadget@gmail.com","threadId":"63603","inReplyTo":null,"subject":"[PATCH 0/9] Doc git log","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-06-08T09:09:37Z","receivedAt":"2025-06-08T09:09:50Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"This series converts the man page of git log to the synopsis format style.\nGit log is the second largest manpage after git config, which makes the\nchanges quite large.\n\nA special note about the log format description which required escaping the\nsynopsis processing of parentheses.\n\nJean-Noël Avila (9):\n doc: convert git-log to new documentation format\n doc: git-log convert rev-list-description to new doc format\n doc: git-log: convert line range options to new doc format\n doc: git-log: convert line range format to new doc format\n doc: git-log: convert rev list options to new doc format\n doc: git-log: convert pretty options to new doc format\n doc: git-log: convert pretty formats to new doc format\n doc: git-log: convert diff options to new doc format\n doc: git-log: convert log config to new doc format\n\n Documentation/asciidoc.conf.in | 2 +-\n Documentation/asciidoctor-extensions.rb.in | 4 +-\n Documentation/config/log.adoc | 45 +--\n Documentation/diff-options.adoc | 40 ++-\n Documentation/git-log.adoc | 83 ++---\n Documentation/line-range-format.adoc | 26 +-\n Documentation/line-range-options.adoc | 10 +-\n Documentation/pretty-formats.adoc | 283 +++++++--------\n Documentation/pretty-options.adoc | 71 ++--\n Documentation/rev-list-description.adoc | 6 +-\n Documentation/rev-list-options.adoc | 390 ++++++++++-----------\n 11 files changed, 490 insertions(+), 470 deletions(-)\n\n\nbase-commit: b32feae0f1b21faaf8e191e8d3314a32470a536b\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-1933%2Fjnavila%2Fdoc_git_log-v1\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1933/jnavila/doc_git_log-v1\nPull-Request: https://github.com/gitgitgadget/git/pull/1933\n-- \ngitgitgadget\n"},{"id":"519913","messageId":"1ce06a184817d0493f4e56725aeb8ed5ccae1ba4.1749373787.git.gitgitgadget@gmail.com","threadId":"63603","inReplyTo":"pull.1933.git.1749373787.gitgitgadget@gmail.com","subject":"[PATCH 1/9] doc: convert git-log to new documentation format","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-06-08T09:09:38Z","receivedAt":"2025-06-08T09:09:51Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= \n\n- Switch the synopsis to a synopsis block which will automatically\n format placeholders in italics and keywords in monospace\n- Use __ instead of in the description\n- Use `backticks` for keywords and more complex option\ndescriptions. The new rendering engine will apply synopsis rules to\nthese spans.\n\nSigned-off-by: Jean-Noël Avila \n---\n Documentation/git-log.adoc | 83 ++++++++++++++++++++------------------\n 1 file changed, 44 insertions(+), 39 deletions(-)\n\ndiff --git a/Documentation/git-log.adoc b/Documentation/git-log.adoc\nindex ae8a7e2d6389..654c3d397dff 100644\n--- a/Documentation/git-log.adoc\n+++ b/Documentation/git-log.adoc\n@@ -8,8 +8,8 @@ git-log - Show commit logs\n \n SYNOPSIS\n --------\n-[verse]\n-'git log' [] [] [[--] ...]\n+[synopsis]\n+git log [] [] [[--] ...]\n \n DESCRIPTION\n -----------\n@@ -27,27 +27,32 @@ each commit introduces are shown.\n OPTIONS\n -------\n \n---follow::\n+`--follow`::\n \tContinue listing the history of a file beyond renames\n \t(works only for a single file).\n \n---no-decorate::\n---decorate[=short|full|auto|no]::\n-\tPrint out the ref names of any commits that are shown. If 'short' is\n-\tspecified, the ref name prefixes 'refs/heads/', 'refs/tags/' and\n-\t'refs/remotes/' will not be printed. If 'full' is specified, the\n-\tfull ref name (including prefix) will be printed. If 'auto' is\n-\tspecified, then if the output is going to a terminal, the ref names\n-\tare shown as if 'short' were given, otherwise no ref names are\n-\tshown. The option `--decorate` is short-hand for `--decorate=short`.\n-\tDefault to configuration value of `log.decorate` if configured,\n-\totherwise, `auto`.\n-\n---decorate-refs=::\n---decorate-refs-exclude=::\n+`--no-decorate`::\n+`--decorate[=(short|full|auto|no)]`::\n+\tPrint out the ref names of any commits that are shown. Possible values\n+\tare:\n++\n+----\n+`short`;; the ref name prefixes `refs/heads/`, `refs/tags/` and\n+\t`refs/remotes/` are not printed.\n+`full`;; the full ref name (including prefix) is printed.\n+`auto`:: if the output is going to a terminal, the ref names\n+\tare shown as if `short` were given, otherwise no ref names are\n+\tshown.\n+----\n++\n+The option `--decorate` is short-hand for `--decorate=short`. Default to\n+configuration value of `log.decorate` if configured, otherwise, `auto`.\n+\n+`--decorate-refs=`::\n+`--decorate-refs-exclude=`::\n \tFor each candidate reference, do not use it for decoration if it\n-\tmatches any patterns given to `--decorate-refs-exclude` or if it\n-\tdoesn't match any of the patterns given to `--decorate-refs`. The\n+\tmatches any of __ given to `--decorate-refs-exclude` or if it\n+\tdoesn't match any of __ given to `--decorate-refs`. The\n \t`log.excludeDecoration` config option allows excluding refs from\n \tthe decorations, but an explicit `--decorate-refs` pattern will\n \toverride a match in `log.excludeDecoration`.\n@@ -56,51 +61,51 @@ If none of these options or config settings are given, then references are\n used as decoration if they match `HEAD`, `refs/heads/`, `refs/remotes/`,\n `refs/stash/`, or `refs/tags/`.\n \n---clear-decorations::\n+`--clear-decorations`::\n \tWhen specified, this option clears all previous `--decorate-refs`\n \tor `--decorate-refs-exclude` options and relaxes the default\n \tdecoration filter to include all references. This option is\n \tassumed if the config value `log.initialDecorationSet` is set to\n \t`all`.\n \n---source::\n+`--source`::\n \tPrint out the ref name given on the command line by which each\n \tcommit was reached.\n \n---[no-]mailmap::\n---[no-]use-mailmap::\n+`--[no-]mailmap`::\n+`--[no-]use-mailmap`::\n \tUse mailmap file to map author and committer names and email\n \taddresses to canonical real names and email addresses. See\n \tlinkgit:git-shortlog[1].\n \n---full-diff::\n+`--full-diff`::\n \tWithout this flag, `git log -p ...` shows commits that\n \ttouch the specified paths, and diffs about the same specified\n \tpaths. With this, the full diff is shown for commits that touch\n-\tthe specified paths; this means that \"...\" limits only\n+\tthe specified paths; this means that \"`...`\" limits only\n \tcommits, and doesn't limit diff for those commits.\n +\n Note that this affects all diff-based output types, e.g. those\n produced by `--stat`, etc.\n \n---log-size::\n-\tInclude a line ``log size '' in the output for each commit,\n-\twhere is the length of that commit's message in bytes.\n+`--log-size`::\n+\tInclude a line `log size ` in the output for each commit,\n+\twhere __ is the length of that commit's message in bytes.\n \tIntended to speed up tools that read log messages from `git log`\n \toutput by allowing them to allocate space in advance.\n \n include::line-range-options.adoc[]\n \n-::\n+__::\n \tShow only commits in the specified revision range. When no\n-\t is specified, it defaults to `HEAD` (i.e. the\n+\t__ is specified, it defaults to `HEAD` (i.e. the\n \twhole history leading to the current commit). `origin..HEAD`\n \tspecifies all the commits reachable from the current commit\n \t(i.e. `HEAD`), but not from `origin`. For a complete list of\n-\tways to spell , see the 'Specifying Ranges'\n+\tways to spell __, see the 'Specifying Ranges'\n \tsection of linkgit:gitrevisions[7].\n \n-[--] ...::\n+`[--] ...`::\n \tShow only commits that are enough to explain how the files\n \tthat match the specified paths came to be. See 'History\n \tSimplification' below for details and other simplification\n@@ -145,14 +150,14 @@ EXAMPLES\n \n `git log --since=\"2 weeks ago\" -- gitk`::\n \n-\tShow the changes during the last two weeks to the file 'gitk'.\n+\tShow the changes during the last two weeks to the file `gitk`.\n \tThe `--` is necessary to avoid confusion with the *branch* named\n-\t'gitk'\n+\t`gitk`\n \n `git log --name-status release..test`::\n \n-\tShow the commits that are in the \"test\" branch but not yet\n-\tin the \"release\" branch, along with the list of paths\n+\tShow the commits that are in the \"`test`\" branch but not yet\n+\tin the \"`release`\" branch, along with the list of paths\n \teach commit modifies.\n \n `git log --follow builtin/rev-list.c`::\n@@ -164,7 +169,7 @@ EXAMPLES\n `git log --branches --not --remotes=origin`::\n \n \tShows all commits that are in any of local branches but not in\n-\tany of remote-tracking branches for 'origin' (what you have that\n+\tany of remote-tracking branches for `origin` (what you have that\n \torigin doesn't).\n \n `git log master --not --remotes=*/master`::\n@@ -200,11 +205,11 @@ CONFIGURATION\n See linkgit:git-config[1] for core variables and linkgit:git-diff[1]\n for settings related to diff generation.\n \n-format.pretty::\n+`format.pretty`::\n \tDefault for the `--format` option. (See 'Pretty Formats' above.)\n \tDefaults to `medium`.\n \n-i18n.logOutputEncoding::\n+`i18n.logOutputEncoding`::\n \tEncoding to use when displaying logs. (See 'Discussion' above.)\n \tDefaults to the value of `i18n.commitEncoding` if set, and UTF-8\n \totherwise.\n-- \ngitgitgadget\n\n"},{"id":"519914","messageId":"ff22d0f1adf823ea3baf3ad3ddbf25add1187ce6.1749373787.git.gitgitgadget@gmail.com","threadId":"63603","inReplyTo":"pull.1933.git.1749373787.gitgitgadget@gmail.com","subject":"[PATCH 2/9] doc: git-log convert rev-list-description to new doc format","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-06-08T09:09:39Z","receivedAt":"2025-06-08T09:09:52Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= \n\nUse `backticks` for commit ranges. The new rendering engine will apply\nsynopsis rules to these spans.\n\nSigned-off-by: Jean-Noël Avila \n---\n Documentation/rev-list-description.adoc | 6 +++---\n 1 file changed, 3 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/rev-list-description.adoc b/Documentation/rev-list-description.adoc\nindex a9efa7fa2722..82c680e57013 100644\n--- a/Documentation/rev-list-description.adoc\n+++ b/Documentation/rev-list-description.adoc\n@@ -26,8 +26,8 @@ endif::git-log[]\n means \"list all the commits which are reachable from 'foo' or 'bar', but\n not from 'baz'\".\n \n-A special notation \"''..''\" can be used as a\n-short-hand for \"^'' ''\". For example, either of\n+A special notation \"`..`\" can be used as a\n+short-hand for \"`^ `\". For example, either of\n the following may be used interchangeably:\n \n ifdef::git-rev-list[]\n@@ -43,7 +43,7 @@ $ git log HEAD ^origin\n -----------------------------------------------------------------------\n endif::git-log[]\n \n-Another special notation is \"''...''\" which is useful\n+Another special notation is \"`...`\" which is useful\n for merges. The resulting set of commits is the symmetric difference\n between the two operands. The following two commands are equivalent:\n \n-- \ngitgitgadget\n\n"},{"id":"519915","messageId":"3992c1786ef3c87c8456f360e14c5b2d11b2622a.1749373787.git.gitgitgadget@gmail.com","threadId":"63603","inReplyTo":"pull.1933.git.1749373787.gitgitgadget@gmail.com","subject":"[PATCH 3/9] doc: git-log: convert line range options to new doc format","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-06-08T09:09:40Z","receivedAt":"2025-06-08T09:09:53Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= \n\n format placeholders in italics and keywords in monospace\n- Use __ instead of in the description\n- Use `backticks` for keywords and more complex option\ndescriptions. The new rendering engine will apply synopsis rules to\nthese spans.\n\nSigned-off-by: Jean-Noël Avila \n---\n Documentation/line-range-options.adoc | 10 +++++-----\n 1 file changed, 5 insertions(+), 5 deletions(-)\n\ndiff --git a/Documentation/line-range-options.adoc b/Documentation/line-range-options.adoc\nindex f275df3b69fa..c44ba05320f9 100644\n--- a/Documentation/line-range-options.adoc\n+++ b/Documentation/line-range-options.adoc\n@@ -1,12 +1,12 @@\n--L,:::\n--L::::\n+`-L,:`::\n+`-L::`::\n \n-\tTrace the evolution of the line range given by ',',\n-\tor by the function name regex '', within the ''. You may\n+\tTrace the evolution of the line range given by `,`,\n+\tor by the function name regex __, within the __. You may\n \tnot give any pathspec limiters. This is currently limited to\n \ta walk starting from a single revision, i.e., you may only\n \tgive zero or one positive revision arguments, and\n-\t'' and '' (or '') must exist in the starting revision.\n+\t__ and __ (or __) must exist in the starting revision.\n \tYou can specify this option more than once. Implies `--patch`.\n \tPatch output can be suppressed using `--no-patch`, but other diff formats\n \t(namely `--raw`, `--numstat`, `--shortstat`, `--dirstat`, `--summary`,\n-- \ngitgitgadget\n\n"},{"id":"519916","messageId":"d451d7f6c0aabfc92c6e6f07fb1fc537cf521926.1749373787.git.gitgitgadget@gmail.com","threadId":"63603","inReplyTo":"pull.1933.git.1749373787.gitgitgadget@gmail.com","subject":"[PATCH 4/9] doc: git-log: convert line range format to new doc format","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-06-08T09:09:41Z","receivedAt":"2025-06-08T09:09:53Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= \n\n- Use __ instead of in the description\n- Use `backticks` for keywords and more complex option\ndescriptions. The new rendering engine will apply synopsis rules to\nthese spans.\n\nSigned-off-by: Jean-Noël Avila \n---\n Documentation/line-range-format.adoc | 26 +++++++++++++-------------\n 1 file changed, 13 insertions(+), 13 deletions(-)\n\ndiff --git a/Documentation/line-range-format.adoc b/Documentation/line-range-format.adoc\nindex 9b51e9fb6614..3cc2a14544cf 100644\n--- a/Documentation/line-range-format.adoc\n+++ b/Documentation/line-range-format.adoc\n@@ -1,30 +1,30 @@\n-'' and '' can take one of these forms:\n+__ and __ can take one of these forms:\n \n-- number\n+- __\n +\n-If '' or '' is a number, it specifies an\n+If __ or __ is a number, it specifies an\n absolute line number (lines count from 1).\n +\n \n-- `/regex/`\n+- `//`\n +\n This form will use the first line matching the given\n-POSIX regex. If '' is a regex, it will search from the end of\n+POSIX __. If __ is a regex, it will search from the end of\n the previous `-L` range, if any, otherwise from the start of file.\n-If '' is `^/regex/`, it will search from the start of file.\n-If '' is a regex, it will search\n-starting at the line given by ''.\n+If __ is `^//`, it will search from the start of file.\n+If __ is a regex, it will search starting at the line given by\n+__.\n +\n \n-- +offset or -offset\n+- `+` or `-`\n +\n-This is only valid for '' and will specify a number\n-of lines before or after the line given by ''.\n+This is only valid for __ and will specify a number\n+of lines before or after the line given by __.\n \n +\n-If `:` is given in place of '' and '', it is a\n+If `:` is given in place of __ and __, it is a\n regular expression that denotes the range from the first funcname line\n-that matches '', up to the next funcname line. `:`\n+that matches __, up to the next funcname line. `:`\n searches from the end of the previous `-L` range, if any, otherwise\n from the start of file. `^:` searches from the start of\n file. The function names are determined in the same way as `git diff`\n-- \ngitgitgadget\n\n"},{"id":"519917","messageId":"5004a622c3f492dd1de8b2952ba24bf5e82f6f3c.1749373787.git.gitgitgadget@gmail.com","threadId":"63603","inReplyTo":"pull.1933.git.1749373787.gitgitgadget@gmail.com","subject":"[PATCH 6/9] doc: git-log: convert pretty options to new doc format","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-06-08T09:09:43Z","receivedAt":"2025-06-08T09:09:55Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= \n\n- Use __ instead of in the description\n- Use `backticks` for keywords and more complex option\ndescriptions. The new rendering engine will apply synopsis rules to\nthese spans.\n\nSigned-off-by: Jean-Noël Avila \n---\n Documentation/pretty-options.adoc | 71 ++++++++++++++++---------------\n 1 file changed, 36 insertions(+), 35 deletions(-)\n\ndiff --git a/Documentation/pretty-options.adoc b/Documentation/pretty-options.adoc\nindex 23888cd612c9..061e7b97f17a 100644\n--- a/Documentation/pretty-options.adoc\n+++ b/Documentation/pretty-options.adoc\n@@ -1,38 +1,38 @@\n---pretty[=]::\n---format=::\n+`--pretty[=]`::\n+`--format=`::\n \n \tPretty-print the contents of the commit logs in a given format,\n-\twhere '' can be one of 'oneline', 'short', 'medium',\n-\t'full', 'fuller', 'reference', 'email', 'raw', 'format:'\n-\tand 'tformat:'. When '' is none of the above,\n-\tand has '%placeholder' in it, it acts as if\n-\t'--pretty=tformat:' were given.\n+\twhere '' can be one of `oneline`, `short`, `medium`,\n+\t`full`, `fuller`, `reference`, `email`, `raw`, `format:`\n+\tand `tformat:`. When __ is none of the above,\n+\tand has `%` in it, it acts as if\n+\t`--pretty=tformat:` were given.\n +\n See the \"PRETTY FORMATS\" section for some additional details for each\n-format. When '=' part is omitted, it defaults to 'medium'.\n+format. When `=` part is omitted, it defaults to `medium.\n +\n-Note: you can specify the default pretty format in the repository\n+NOTE: you can specify the default pretty format in the repository\n configuration (see linkgit:git-config[1]).\n \n---abbrev-commit::\n+`--abbrev-commit`::\n \tInstead of showing the full 40-byte hexadecimal commit object\n \tname, show a prefix that names the object uniquely.\n-\t\"--abbrev=\" (which also modifies diff output, if it is displayed)\n+\t`--abbrev=` (which also modifies diff output, if it is displayed)\n \toption can be used to specify the minimum length of the prefix.\n +\n-This should make \"--pretty=oneline\" a whole lot more readable for\n+This should make `--pretty=oneline` a whole lot more readable for\n people using 80-column terminals.\n \n---no-abbrev-commit::\n+`--no-abbrev-commit`::\n \tShow the full 40-byte hexadecimal commit object name. This negates\n \t`--abbrev-commit`, either explicit or implied by other options such\n-\tas \"--oneline\". It also overrides the `log.abbrevCommit` variable.\n+\tas `--oneline`. It also overrides the `log.abbrevCommit` variable.\n \n---oneline::\n-\tThis is a shorthand for \"--pretty=oneline --abbrev-commit\"\n+`--oneline`::\n+\tThis is a shorthand for `--pretty=oneline --abbrev-commit`\n \tused together.\n \n---encoding=::\n+`--encoding=`::\n \tCommit objects record the character encoding used for the log message\n \tin their encoding header; this option can be used to tell the\n \tcommand to re-code the commit log message in the encoding\n@@ -44,22 +44,22 @@ people using 80-column terminals.\n \tto convert the commit, we will quietly output the original\n \tobject verbatim.\n \n---expand-tabs=::\n---expand-tabs::\n---no-expand-tabs::\n+`--expand-tabs=`::\n+`--expand-tabs`::\n+`--no-expand-tabs`::\n \tPerform a tab expansion (replace each tab with enough spaces\n-\tto fill to the next display column that is a multiple of '')\n+\tto fill to the next display column that is a multiple of __)\n \tin the log message before showing it in the output.\n \t`--expand-tabs` is a short-hand for `--expand-tabs=8`, and\n \t`--no-expand-tabs` is a short-hand for `--expand-tabs=0`,\n \twhich disables tab expansion.\n +\n By default, tabs are expanded in pretty formats that indent the log\n-message by 4 spaces (i.e. 'medium', which is the default, 'full',\n-and 'fuller').\n+message by 4 spaces (i.e. `medium`, which is the default, `full`,\n+and `fuller`).\n \n ifndef::git-rev-list[]\n---notes[=]::\n+`--notes[=]`::\n \tShow the notes (see linkgit:git-notes[1]) that annotate the\n \tcommit, when showing the commit log message. This is the default\n \tfor `git log`, `git show` and `git whatchanged` commands when\n@@ -75,28 +75,29 @@ to display. The ref can specify the full refname when it begins\n with `refs/notes/`; when it begins with `notes/`, `refs/` and otherwise\n `refs/notes/` is prefixed to form the full name of the ref.\n +\n-Multiple --notes options can be combined to control which notes are\n-being displayed. Examples: \"--notes=foo\" will show only notes from\n-\"refs/notes/foo\"; \"--notes=foo --notes\" will show both notes from\n+Multiple `--notes` options can be combined to control which notes are\n+being displayed. Examples: \"`--notes=foo`\" will show only notes from\n+`refs/notes/foo`; \"`--notes=foo --notes`\" will show both notes from\n \"refs/notes/foo\" and from the default notes ref(s).\n \n---no-notes::\n+`--no-notes`::\n \tDo not show notes. This negates the above `--notes` option, by\n \tresetting the list of notes refs from which notes are shown.\n \tOptions are parsed in the order given on the command line, so e.g.\n-\t\"--notes --notes=foo --no-notes --notes=bar\" will only show notes\n-\tfrom \"refs/notes/bar\".\n+\t\"`--notes --notes=foo --no-notes --notes=bar`\" will only show notes\n+\tfrom `refs/notes/bar`.\n \n---show-notes-by-default::\n+`--show-notes-by-default`::\n \tShow the default notes unless options for displaying specific\n \tnotes are given.\n \n---show-notes[=]::\n---[no-]standard-notes::\n-\tThese options are deprecated. Use the above --notes/--no-notes\n+`--show-notes[=]`::\n+`--standard-notes`::\n+`--no-standard-notes`::\n+\tThese options are deprecated. Use the above `--notes`/`--no-notes`\n \toptions instead.\n endif::git-rev-list[]\n \n---show-signature::\n+`--show-signature`::\n \tCheck the validity of a signed commit object by passing the signature\n \tto `gpg --verify` and show the output.\n-- \ngitgitgadget\n\n"},{"id":"519919","messageId":"71d9a37410265a8295f8516421135ee372c8ca7e.1749373787.git.gitgitgadget@gmail.com","threadId":"63603","inReplyTo":"pull.1933.git.1749373787.gitgitgadget@gmail.com","subject":"[PATCH 5/9] doc: git-log: convert rev list options to new doc format","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-06-08T09:09:42Z","receivedAt":"2025-06-08T09:09:55Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= \n\n- Fix some malformed synopis of options\n- Use __ instead of in the description\n- Use `backticks` for keywords and more complex option\ndescriptions. The new rendering engine will apply synopsis rules to\nthese spans.\n- Add the '%' sign to the characters of keywords.\n\nSigned-off-by: Jean-Noël Avila \n---\n Documentation/asciidoc.conf.in | 2 +-\n Documentation/asciidoctor-extensions.rb.in | 4 +-\n Documentation/rev-list-options.adoc | 390 ++++++++++-----------\n 3 files changed, 198 insertions(+), 198 deletions(-)\n\ndiff --git a/Documentation/asciidoc.conf.in b/Documentation/asciidoc.conf.in\nindex 9d9139306e6f..ff9ea0a29445 100644\n--- a/Documentation/asciidoc.conf.in\n+++ b/Documentation/asciidoc.conf.in\n@@ -43,7 +43,7 @@ ifdef::doctype-book[]\n endif::doctype-book[]\n \n [literal-inlinemacro]\n-{eval:re.sub(r'(<[-a-zA-Z0-9.]+>)', r'\\1', re.sub(r'([\\[\\s|()>]|^|\\]|>)(\\.?([-a-zA-Z0-9:+=~@\\\\\\*\\/_^\\$]+\\.?)+|,)',r'\\1\\2', re.sub(r'(\\.\\.\\.?)([^\\]$.])', r'\\1\\2', macros.passthroughs[int(attrs['passtext'][1:-1])] if attrs['passtext'][1:-1].isnumeric() else attrs['passtext'][1:-1])))}\n+{eval:re.sub(r'(<[-a-zA-Z0-9.]+>)', r'\\1', re.sub(r'([\\[\\s|()>]|^|\\]|>)(\\.?([-a-zA-Z0-9:+=~@\\\\\\*\\/_^\\$%]+\\.?)+|,)',r'\\1\\2', re.sub(r'(\\.\\.\\.?)([^\\]$.])', r'\\1\\2', macros.passthroughs[int(attrs['passtext'][1:-1])] if attrs['passtext'][1:-1].isnumeric() else attrs['passtext'][1:-1])))}\n \n endif::backend-docbook[]\n \ndiff --git a/Documentation/asciidoctor-extensions.rb.in b/Documentation/asciidoctor-extensions.rb.in\nindex 8b7b16134967..fe64a62d9683 100644\n--- a/Documentation/asciidoctor-extensions.rb.in\n+++ b/Documentation/asciidoctor-extensions.rb.in\n@@ -73,7 +73,7 @@ module Git\n elsif type == :monospaced\n node.text.gsub(/(\\.\\.\\.?)([^\\]$\\.])/, '\\1\\2')\n .gsub(/^\\.\\.\\.?$/, '\\0')\n- .gsub(%r{([\\[\\s|()>.]|^|\\]|>)(\\.?([-a-zA-Z0-9:+=~@/_^\\$\\\\\\*]+\\.{0,2})+|,)}, '\\1\\2')\n+ .gsub(%r{([\\[\\s|()>.]|^|\\]|>)(\\.?([-a-zA-Z0-9:+=~@/_^\\$\\\\\\*%]+\\.{0,2})+|,)}, '\\1\\2')\n .gsub(/(<[-a-zA-Z0-9.]+>)/, '\\1')\n else\n open, close, supports_phrase = QUOTE_TAGS[type]\n@@ -102,7 +102,7 @@ module Git\n if node.type == :monospaced\n node.text.gsub(/(\\.\\.\\.?)([^\\]$.])/, '\\1\\2')\n .gsub(/^\\.\\.\\.?$/, '\\0')\n- .gsub(%r{([\\[\\s|()>.]|^|\\]|>)(\\.?([-a-zA-Z0-9:+=~@,/_^\\$\\\\\\*]+\\.{0,2})+)}, '\\1\\2')\n+ .gsub(%r{([\\[\\s|()>.]|^|\\]|>)(\\.?([-a-zA-Z0-9:+=~@,/_^\\$\\\\\\*%]+\\.{0,2})+)}, '\\1\\2')\n .gsub(/(<[-a-zA-Z0-9.]+>)/, '\\1')\n \n else\ndiff --git a/Documentation/rev-list-options.adoc b/Documentation/rev-list-options.adoc\nindex d38875efdada..e4214035815d 100644\n--- a/Documentation/rev-list-options.adoc\n+++ b/Documentation/rev-list-options.adoc\n@@ -6,60 +6,60 @@ special notations explained in the description, additional commit\n limiting may be applied.\n \n Using more options generally further limits the output (e.g.\n-`--since=` limits to commits newer than ``, and using it\n+`--since=` limits to commits newer than __, and using it\n with `--grep=` further limits to commits whose log message\n-has a line that matches ``), unless otherwise noted.\n+has a line that matches __), unless otherwise noted.\n \n Note that these are applied before commit\n ordering and formatting options, such as `--reverse`.\n \n--::\n--n ::\n---max-count=::\n-\tLimit the number of commits to output.\n+`-`::\n+`-n `::\n+`--max-count=`::\n+\tLimit the output to __ commits.\n \n---skip=::\n-\tSkip 'number' commits before starting to show the commit output.\n+`--skip=`::\n+\tSkip __ commits before starting to show the commit output.\n \n---since=::\n---after=::\n-\tShow commits more recent than a specific date.\n+`--since=`::\n+`--after=`::\n+\tShow commits more recent than __.\n \n---since-as-filter=::\n-\tShow all commits more recent than a specific date. This visits\n+`--since-as-filter=`::\n+\tShow all commits more recent than __. This visits\n \tall commits in the range, rather than stopping at the first commit which\n-\tis older than a specific date.\n+\tis older than __.\n \n---until=::\n---before=::\n-\tShow commits older than a specific date.\n+`--until=`::\n+`--before=`::\n+\tShow commits older than __.\n \n ifdef::git-rev-list[]\n---max-age=::\n---min-age=::\n+`--max-age=`::\n+`--min-age=`::\n \tLimit the commits output to specified time range.\n endif::git-rev-list[]\n \n---author=::\n---committer=::\n+`--author=`::\n+`--committer=`::\n \tLimit the commits output to ones with author/committer\n-\theader lines that match the specified pattern (regular\n-\texpression). With more than one `--author=`,\n-\tcommits whose author matches any of the given patterns are\n+\theader lines that match the __ regular\n+\texpression. With more than one `--author=`,\n+\tcommits whose author matches any of the __ are\n \tchosen (similarly for multiple `--committer=`).\n \n---grep-reflog=::\n+`--grep-reflog=`::\n \tLimit the commits output to ones with reflog entries that\n-\tmatch the specified pattern (regular expression). With\n+\tmatch the __ regular expression. With\n \tmore than one `--grep-reflog`, commits whose reflog message\n \tmatches any of the given patterns are chosen. It is an\n \terror to use this option unless `--walk-reflogs` is in use.\n \n---grep=::\n+`--grep=`::\n \tLimit the commits output to ones with a log message that\n-\tmatches the specified pattern (regular expression). With\n+\tmatches the __ regular expression. With\n \tmore than one `--grep=`, commits whose message\n-\tmatches any of the given patterns are chosen (but see\n+\tmatches any of the __ are chosen (but see\n \t`--all-match`).\n ifndef::git-rev-list[]\n +\n@@ -67,35 +67,35 @@ When `--notes` is in effect, the message from the notes is\n matched as if it were part of the log message.\n endif::git-rev-list[]\n \n---all-match::\n+`--all-match`::\n \tLimit the commits output to ones that match all given `--grep`,\n \tinstead of ones that match at least one.\n \n---invert-grep::\n+`--invert-grep`::\n \tLimit the commits output to ones with a log message that do not\n-\tmatch the pattern specified with `--grep=`.\n+\tmatch the __ specified with `--grep=`.\n \n--i::\n---regexp-ignore-case::\n+`-i`::\n+`--regexp-ignore-case`::\n \tMatch the regular expression limiting patterns without regard to letter\n \tcase.\n \n---basic-regexp::\n+`--basic-regexp`::\n \tConsider the limiting patterns to be basic regular expressions;\n \tthis is the default.\n \n--E::\n---extended-regexp::\n+`-E`::\n+`--extended-regexp`::\n \tConsider the limiting patterns to be extended regular expressions\n \tinstead of the default basic regular expressions.\n \n--F::\n---fixed-strings::\n+`-F`::\n+`--fixed-strings`::\n \tConsider the limiting patterns to be fixed strings (don't interpret\n \tpattern as a regular expression).\n \n--P::\n---perl-regexp::\n+`-P`::\n+`--perl-regexp`::\n \tConsider the limiting patterns to be Perl-compatible regular\n \texpressions.\n +\n@@ -103,20 +103,20 @@ Support for these types of regular expressions is an optional\n compile-time dependency. If Git wasn't compiled with support for them\n providing this option will cause it to die.\n \n---remove-empty::\n+`--remove-empty`::\n \tStop when a given path disappears from the tree.\n \n---merges::\n+`--merges`::\n \tPrint only merge commits. This is exactly the same as `--min-parents=2`.\n \n---no-merges::\n+`--no-merges`::\n \tDo not print commits with more than one parent. This is\n \texactly the same as `--max-parents=1`.\n \n---min-parents=::\n---max-parents=::\n---no-min-parents::\n---no-max-parents::\n+`--min-parents=`::\n+`--max-parents=`::\n+`--no-min-parents`::\n+`--no-max-parents`::\n \tShow only commits which have at least (or at most) that many parent\n \tcommits. In particular, `--max-parents=1` is the same as `--no-merges`,\n \t`--min-parents=2` is the same as `--merges`. `--max-parents=0`\n@@ -126,7 +126,7 @@ providing this option will cause it to die.\n again. Equivalent forms are `--min-parents=0` (any commit has 0 or more\n parents) and `--max-parents=-1` (negative numbers denote no upper limit).\n \n---first-parent::\n+`--first-parent`::\n \tWhen finding commits to include, follow only the first\n \tparent commit upon seeing a merge commit. This option\n \tcan give a better overview when viewing the evolution of\n@@ -141,14 +141,14 @@ This option also changes default diff format for merge commits\n to `first-parent`, see `--diff-merges=first-parent` for details.\n endif::git-log[]\n \n---exclude-first-parent-only::\n+`--exclude-first-parent-only`::\n \tWhen finding commits to exclude (with a '{caret}'), follow only\n \tthe first parent commit upon seeing a merge commit.\n \tThis can be used to find the set of changes in a topic branch\n \tfrom the point where it diverged from the remote branch, given\n \tthat arbitrary merges can be valid topic branch changes.\n \n---not::\n+`--not`::\n \tReverses the meaning of the '{caret}' prefix (or lack thereof)\n \tfor all following revision specifiers, up to the next `--not`.\n \tWhen used on the command line before --stdin, the revisions passed\n@@ -156,37 +156,37 @@ endif::git-log[]\n \tvia standard input, the revisions passed on the command line will\n \tnot be affected by it.\n \n---all::\n+`--all`::\n \tPretend as if all the refs in `refs/`, along with `HEAD`, are\n-\tlisted on the command line as ''.\n+\tlisted on the command line as __.\n \n---branches[=]::\n+`--branches[=]`::\n \tPretend as if all the refs in `refs/heads` are listed\n-\ton the command line as ''. If '' is given, limit\n-\tbranches to ones matching given shell glob. If pattern lacks '?',\n+\ton the command line as __. If __ is given, limit\n+\tbranches to ones matching given shell glob. If __ lacks '?',\n \t'{asterisk}', or '[', '/{asterisk}' at the end is implied.\n \n---tags[=]::\n+`--tags[=]`::\n \tPretend as if all the refs in `refs/tags` are listed\n-\ton the command line as ''. If '' is given, limit\n+\ton the command line as __. If __ is given, limit\n \ttags to ones matching given shell glob. If pattern lacks '?', '{asterisk}',\n \tor '[', '/{asterisk}' at the end is implied.\n \n---remotes[=]::\n+`--remotes[=]`::\n \tPretend as if all the refs in `refs/remotes` are listed\n-\ton the command line as ''. If '' is given, limit\n+\ton the command line as __. If __ is given, limit\n \tremote-tracking branches to ones matching given shell glob.\n \tIf pattern lacks '?', '{asterisk}', or '[', '/{asterisk}' at the end is implied.\n \n---glob=::\n-\tPretend as if all the refs matching shell glob ''\n-\tare listed on the command line as ''. Leading 'refs/',\n+`--glob=`::\n+\tPretend as if all the refs matching shell glob __\n+\tare listed on the command line as __. Leading 'refs/',\n \tis automatically prepended if missing. If pattern lacks '?', '{asterisk}',\n \tor '[', '/{asterisk}' at the end is implied.\n \n---exclude=::\n+`--exclude=`::\n \n-\tDo not include refs matching '' that the next `--all`,\n+\tDo not include refs matching __ that the next `--all`,\n \t`--branches`, `--tags`, `--remotes`, or `--glob` would otherwise\n \tconsider. Repetitions of this option accumulate exclusion patterns\n \tup to the next `--all`, `--branches`, `--tags`, `--remotes`, or\n@@ -199,7 +199,7 @@ respectively, and they must begin with `refs/` when applied to `--glob`\n or `--all`. If a trailing '/{asterisk}' is intended, it must be given\n explicitly.\n \n---exclude-hidden=[fetch|receive|uploadpack]::\n+`--exclude-hidden=(fetch|receive|uploadpack)`::\n \tDo not include refs that would be hidden by `git-fetch`,\n \t`git-receive-pack` or `git-upload-pack` by consulting the appropriate\n \t`fetch.hideRefs`, `receive.hideRefs` or `uploadpack.hideRefs`\n@@ -207,11 +207,11 @@ explicitly.\n \tlinkgit:git-config[1]). This option affects the next pseudo-ref option\n \t`--all` or `--glob` and is cleared after processing them.\n \n---reflog::\n+`--reflog`::\n \tPretend as if all objects mentioned by reflogs are listed on the\n-\tcommand line as ``.\n+\tcommand line as __.\n \n---alternate-refs::\n+`--alternate-refs`::\n \tPretend as if all objects mentioned as ref tips of alternate\n \trepositories were listed on the command line. An alternate\n \trepository is any repository whose object directory is specified\n@@ -219,7 +219,7 @@ explicitly.\n \tbe modified by `core.alternateRefsCommand`, etc. See\n \tlinkgit:git-config[1].\n \n---single-worktree::\n+`--single-worktree`::\n \tBy default, all working trees will be examined by the\n \tfollowing options when there are more than one (see\n \tlinkgit:git-worktree[1]): `--all`, `--reflog` and\n@@ -227,19 +227,19 @@ explicitly.\n \tThis option forces them to examine the current working tree\n \tonly.\n \n---ignore-missing::\n+`--ignore-missing`::\n \tUpon seeing an invalid object name in the input, pretend as if\n \tthe bad input was not given.\n \n ifndef::git-rev-list[]\n---bisect::\n+`--bisect`::\n \tPretend as if the bad bisection ref `refs/bisect/bad`\n \twas listed and as if it was followed by `--not` and the good\n \tbisection refs `refs/bisect/good-*` on the command\n \tline.\n endif::git-rev-list[]\n \n---stdin::\n+`--stdin`::\n \tIn addition to getting arguments from the command line, read\n \tthem from standard input as well. This accepts commits and\n \tpseudo-options like `--all` and `--glob=`. When a `--` separator\n@@ -249,15 +249,15 @@ endif::git-rev-list[]\n \tinfluence any subsequent command line arguments.\n \n ifdef::git-rev-list[]\n---quiet::\n+`--quiet`::\n \tDon't print anything to standard output. This form\n \tis primarily meant to allow the caller to\n \ttest the exit status to see if a range of objects is fully\n \tconnected (or not). It is faster than redirecting stdout\n \tto `/dev/null` as the output does not have to be formatted.\n \n---disk-usage::\n---disk-usage=human::\n+`--disk-usage`::\n+`--disk-usage=human`::\n \tSuppress normal output; instead, print the sum of the bytes used\n \tfor on-disk storage by the selected commits or objects. This is\n \tequivalent to piping the output into `git cat-file\n@@ -269,11 +269,11 @@ ifdef::git-rev-list[]\n \tin human-readable string(e.g. 12.24 Kib, 3.50 Mib).\n endif::git-rev-list[]\n \n---cherry-mark::\n+`--cherry-mark`::\n \tLike `--cherry-pick` (see below) but mark equivalent commits\n \twith `=` rather than omitting them, and inequivalent ones with `+`.\n \n---cherry-pick::\n+`--cherry-pick`::\n \tOmit any commit that introduces the same change as\n \tanother commit on the ``other side'' when the set of\n \tcommits are limited with symmetric difference.\n@@ -286,8 +286,8 @@ cherry-picked from the other branch (for example, ``3rd on b'' may be\n cherry-picked from branch A). With this option, such pairs of commits are\n excluded from the output.\n \n---left-only::\n---right-only::\n+`--left-only`::\n+`--right-only`::\n \tList only commits on the respective side of a symmetric difference,\n \ti.e. only those which would be marked `<` resp. `>` by\n \t`--left-right`.\n@@ -298,20 +298,20 @@ commits from `B` which are in `A` or are patch-equivalent to a commit in\n More precisely, `--cherry-pick --right-only --no-merges` gives the exact\n list.\n \n---cherry::\n+`--cherry`::\n \tA synonym for `--right-only --cherry-mark --no-merges`; useful to\n \tlimit the output to the commits on our side and mark those that\n \thave been applied to the other side of a forked history with\n \t`git log --cherry upstream...mybranch`, similar to\n \t`git cherry upstream mybranch`.\n \n--g::\n---walk-reflogs::\n+`-g`::\n+`--walk-reflogs`::\n \tInstead of walking the commit ancestry chain, walk\n \treflog entries from the most recent one to older ones.\n \tWhen this option is used you cannot specify commits to\n-\texclude (that is, '{caret}commit', 'commit1..commit2',\n-\tand 'commit1\\...commit2' notations cannot be used).\n+\texclude (that is, `^`, `..`,\n+\tand `...` notations cannot be used).\n +\n With `--pretty` format other than `oneline` and `reference` (for obvious reasons),\n this causes the output to have two extra lines of information\n@@ -340,29 +340,29 @@ See also linkgit:git-reflog[1].\n +\n Under `--pretty=reference`, this information will not be shown at all.\n \n---merge::\n+`--merge`::\n \tShow commits touching conflicted paths in the range `HEAD...`,\n \twhere `` is the first existing pseudoref in `MERGE_HEAD`,\n \t`CHERRY_PICK_HEAD`, `REVERT_HEAD` or `REBASE_HEAD`. Only works\n \twhen the index has unmerged entries. This option can be used to show\n \trelevant commits when resolving conflicts from a 3-way merge.\n \n---boundary::\n+`--boundary`::\n \tOutput excluded boundary commits. Boundary commits are\n \tprefixed with `-`.\n \n ifdef::git-rev-list[]\n---use-bitmap-index::\n+`--use-bitmap-index`::\n \n \tTry to speed up the traversal using the pack bitmap index (if\n \tone is available). Note that when traversing with `--objects`,\n \ttrees and blobs will not have their associated path printed.\n \n---progress=
::\n+`--progress=
`::\n \tShow progress reports on stderr as objects are considered. The\n \t`
` text will be printed with each progress update.\n \n--z::\n+`-z`::\n \tInstead of being newline-delimited, each outputted object and its\n \taccompanying metadata is delimited using NUL bytes. Output is printed\n \tin the following form:\n@@ -397,56 +397,56 @@ is how to do it, as there are various strategies to simplify the history.\n \n The following options select the commits to be shown:\n \n-::\n+``::\n \tCommits modifying the given are selected.\n \n---simplify-by-decoration::\n+`--simplify-by-decoration`::\n \tCommits that are referred by some branch or tag are selected.\n \n Note that extra commits can be shown to give a meaningful history.\n \n The following options affect the way the simplification is performed:\n \n-Default mode::\n+`Default mode`::\n \tSimplifies the history to the simplest history explaining the\n \tfinal state of the tree. Simplest because it prunes some side\n \tbranches if the end result is the same (i.e. merging branches\n \twith the same content)\n \n---show-pulls::\n+`--show-pulls`::\n \tInclude all commits from the default mode, but also any merge\n \tcommits that are not TREESAME to the first parent but are\n \tTREESAME to a later parent. This mode is helpful for showing\n \tthe merge commits that \"first introduced\" a change to a branch.\n \n---full-history::\n+`--full-history`::\n \tSame as the default mode, but does not prune some history.\n \n---dense::\n+`--dense`::\n \tOnly the selected commits are shown, plus some to have a\n \tmeaningful history.\n \n---sparse::\n+`--sparse`::\n \tAll commits in the simplified history are shown.\n \n---simplify-merges::\n+`--simplify-merges`::\n \tAdditional option to `--full-history` to remove some needless\n \tmerges from the resulting history, as there are no selected\n \tcommits contributing to this merge.\n \n---ancestry-path[=]::\n-\tWhen given a range of commits to display (e.g. 'commit1..commit2'\n-\tor 'commit2 {caret}commit1'), and a commit in that range,\n+`--ancestry-path[=]`::\n+\tWhen given a range of commits to display (e.g. `..`\n+\tor ` ^`), and a commit __ in that range,\n \tonly display commits in that range\n-\tthat are ancestors of , descendants of , or\n-\t itself. If no commit is specified, use 'commit1' (the\n-\texcluded part of the range) as . Can be passed multiple\n+\tthat are ancestors of __, descendants of __, or\n+\t__ itself. If no commit is specified, use __ (the\n+\texcluded part of the range) as __. Can be passed multiple\n \ttimes; if so, a commit is included if it is any of the commits\n \tgiven or if it is an ancestor or descendant of one of them.\n \n A more detailed explanation follows.\n \n-Suppose you specified `foo` as the . We shall call commits\n+Suppose you specified `foo` as the __. We shall call commits\n that modify `foo` !TREESAME, and the rest TREESAME. (In a diff\n filtered for `foo`, they look different and equal, respectively.)\n \n@@ -466,22 +466,22 @@ The horizontal line of history A---Q is taken to be the first parent of\n each merge. The commits are:\n \n * `I` is the initial commit, in which `foo` exists with contents\n- ``asdf'', and a file `quux` exists with contents ``quux''. Initial\n+ `asdf`, and a file `quux` exists with contents `quux`. Initial\n commits are compared to an empty tree, so `I` is !TREESAME.\n \n-* In `A`, `foo` contains just ``foo''.\n+* In `A`, `foo` contains just `foo`.\n \n * `B` contains the same change as `A`. Its merge `M` is trivial and\n hence TREESAME to all parents.\n \n-* `C` does not change `foo`, but its merge `N` changes it to ``foobar'',\n+* `C` does not change `foo`, but its merge `N` changes it to `foobar`,\n so it is not TREESAME to any parent.\n \n-* `D` sets `foo` to ``baz''. Its merge `O` combines the strings from\n- `N` and `D` to ``foobarbaz''; i.e., it is not TREESAME to any parent.\n+* `D` sets `foo` to `baz`. Its merge `O` combines the strings from\n+ `N` and `D` to `foobarbaz`; i.e., it is not TREESAME to any parent.\n \n-* `E` changes `quux` to ``xyzzy'', and its merge `P` combines the\n- strings to ``quux xyzzy''. `P` is TREESAME to `O`, but not to `E`.\n+* `E` changes `quux` to `xyzzy`, and its merge `P` combines the\n+ strings to `quux xyzzy`. `P` is TREESAME to `O`, but not to `E`.\n \n * `X` is an independent root commit that added a new file `side`, and `Y`\n modified it. `Y` is TREESAME to `X`. Its merge `Q` added `side` to `P`, and\n@@ -517,7 +517,7 @@ Parent/child relations are only visible with `--parents`, but that does\n not affect the commits selected in default mode, so we have shown the\n parent lines.\n \n---full-history without parent rewriting::\n+`--full-history` without parent rewriting::\n \tThis mode differs from the default in one point: always follow\n \tall parents of a merge, even if it is TREESAME to one of them.\n \tEven if more than one side of the merge has commits that are\n@@ -536,7 +536,7 @@ Note that without parent rewriting, it is not really possible to talk\n about the parent/child relationships between the commits, so we show\n them disconnected.\n \n---full-history with parent rewriting::\n+`--full-history` with parent rewriting::\n \tOrdinary commits are only included if they are !TREESAME\n \t(though this can be changed, see `--sparse` below).\n +\n@@ -560,18 +560,18 @@ rewritten to contain `E`'s parent `I`. The same happened for `C` and\n In addition to the above settings, you can change whether TREESAME\n affects inclusion:\n \n---dense::\n+`--dense`::\n \tCommits that are walked are included if they are not TREESAME\n \tto any parent.\n \n---sparse::\n+`--sparse`::\n \tAll commits that are walked are included.\n +\n Note that without `--full-history`, this still simplifies merges: if\n one of the parents is TREESAME, we follow only that one, so the other\n sides of the merge are never walked.\n \n---simplify-merges::\n+`--simplify-merges`::\n \tFirst, build a history graph in the same way that\n \t`--full-history` with parent rewriting does (see above).\n +\n@@ -618,9 +618,9 @@ Note the major differences in `N`, `P`, and `Q` over `--full-history`:\n \n There is another simplification mode available:\n \n---ancestry-path[=]::\n+`--ancestry-path[=]`::\n \tLimit the displayed commits to those which are an ancestor of\n-\t, or which are a descendant of , or are \n+\t__, or which are a descendant of __, or are __\n \titself.\n +\n As an example use case, consider the following commit history:\n@@ -636,15 +636,15 @@ As an example use case, consider the following commit history:\n A regular 'D..M' computes the set of commits that are ancestors of `M`,\n but excludes the ones that are ancestors of `D`. This is useful to see\n what happened to the history leading to `M` since `D`, in the sense\n-that ``what does `M` have that did not exist in `D`''. The result in this\n+that \"what does `M` have that did not exist in `D`\". The result in this\n example would be all the commits, except `A` and `B` (and `D` itself,\n of course).\n +\n When we want to find out what commits in `M` are contaminated with the\n bug introduced by `D` and need fixing, however, we might want to view\n-only the subset of 'D..M' that are actually descendants of `D`, i.e.\n+only the subset of `D..M` that are actually descendants of `D`, i.e.\n excluding `C` and `K`. This is exactly what the `--ancestry-path`\n-option does. Applied to the 'D..M' range, it results in:\n+option does. Applied to the `D..M` range, it results in:\n +\n -----------------------------------------------------------------------\n \t\tE-------F\n@@ -655,7 +655,7 @@ option does. Applied to the 'D..M' range, it results in:\n -----------------------------------------------------------------------\n +\n We can also use `--ancestry-path=D` instead of `--ancestry-path` which\n-means the same thing when applied to the 'D..M' range but is just more\n+means the same thing when applied to the `D..M` range but is just more\n explicit.\n +\n If we instead are interested in a given topic within this range, and all\n@@ -770,7 +770,7 @@ into the important branch. This commit may have information about why\n the change `X` came to override the changes from `A` and `B` in its\n commit message.\n \n---show-pulls::\n+`--show-pulls`::\n \tIn addition to the commits shown in the default history, show\n \teach merge commit that is not TREESAME to its first parent but\n \tis TREESAME to a later parent.\n@@ -819,7 +819,7 @@ ifdef::git-rev-list[]\n Bisection Helpers\n ~~~~~~~~~~~~~~~~~\n \n---bisect::\n+`--bisect`::\n \tLimit output to the one commit object which is roughly halfway between\n \tincluded and excluded commits. Note that the bad bisection ref\n \t`refs/bisect/bad` is added to the included commits (if it\n@@ -843,7 +843,7 @@ introduces a regression is thus reduced to a binary search: repeatedly\n generate and test new 'midpoint's until the commit chain is of length\n one.\n \n---bisect-vars::\n+`--bisect-vars`::\n \tThis calculates the same as `--bisect`, except that refs in\n \t`refs/bisect/` are not used, and except that this outputs\n \ttext ready to be eval'ed by the shell. These lines will assign the\n@@ -855,7 +855,7 @@ one.\n \t`bisect_bad`, and the number of commits we are bisecting right now to\n \t`bisect_all`.\n \n---bisect-all::\n+`--bisect-all`::\n \tThis outputs all the commit objects between the included and excluded\n \tcommits, ordered by their distance to the included and excluded\n \tcommits. Refs in `refs/bisect/` are not used. The farthest\n@@ -878,15 +878,15 @@ Commit Ordering\n \n By default, the commits are shown in reverse chronological order.\n \n---date-order::\n+`--date-order`::\n \tShow no parents before all of its children are shown, but\n \totherwise show commits in the commit timestamp order.\n \n---author-date-order::\n+`--author-date-order`::\n \tShow no parents before all of its children are shown, but\n \totherwise show commits in the author timestamp order.\n \n---topo-order::\n+`--topo-order`::\n \tShow no parents before all of its children are shown, and\n \tavoid showing commits on multiple lines of history\n \tintermixed.\n@@ -910,8 +910,8 @@ With `--topo-order`, they would show 8 6 5 3 7 4 2 1 (or 8 7 4 2 6 5\n avoid showing the commits from two parallel development track mixed\n together.\n \n---reverse::\n-\tOutput the commits chosen to be shown (see Commit Limiting\n+`--reverse`::\n+\tOutput the commits chosen to be shown (see 'Commit Limiting'\n \tsection above) in reverse order. Cannot be combined with\n \t`--walk-reflogs`.\n endif::git-shortlog[]\n@@ -923,39 +923,39 @@ Object Traversal\n These options are mostly targeted for packing of Git repositories.\n \n ifdef::git-rev-list[]\n---objects::\n+`--objects`::\n \tPrint the object IDs of any object referenced by the listed\n-\tcommits. `--objects foo ^bar` thus means ``send me\n+\tcommits. `--objects foo ^bar` thus means \"send me\n \tall object IDs which I need to download if I have the commit\n-\tobject _bar_ but not _foo_''. See also `--object-names` below.\n+\tobject `bar` but not `foo`\". See also `--object-names` below.\n \n---in-commit-order::\n+`--in-commit-order`::\n \tPrint tree and blob ids in order of the commits. The tree\n \tand blob ids are printed after they are first referenced\n \tby a commit.\n \n---objects-edge::\n+`--objects-edge`::\n \tSimilar to `--objects`, but also print the IDs of excluded\n-\tcommits prefixed with a ``-'' character. This is used by\n+\tcommits prefixed with a \"`-`\" character. This is used by\n \tlinkgit:git-pack-objects[1] to build a ``thin'' pack, which records\n \tobjects in deltified form based on objects contained in these\n \texcluded commits to reduce network traffic.\n \n---objects-edge-aggressive::\n+`--objects-edge-aggressive`::\n \tSimilar to `--objects-edge`, but it tries harder to find excluded\n \tcommits at the cost of increased time. This is used instead of\n \t`--objects-edge` to build ``thin'' packs for shallow repositories.\n \n---indexed-objects::\n+`--indexed-objects`::\n \tPretend as if all trees and blobs used by the index are listed\n \ton the command line. Note that you probably want to use\n \t`--objects`, too.\n \n---unpacked::\n+`--unpacked`::\n \tOnly useful with `--objects`; print the object IDs that are not\n \tin packs.\n \n---object-names::\n+`--object-names`::\n \tOnly useful with `--objects`; print the names of the object IDs\n \tthat are found. This is the default behavior. Note that the\n \t\"name\" of each object is ambiguous, and mostly intended as a\n@@ -964,52 +964,52 @@ ifdef::git-rev-list[]\n \tto remove newlines; and if an object would appear multiple times\n \twith different names, only one name is shown.\n \n---no-object-names::\n+`--no-object-names`::\n \tOnly useful with `--objects`; does not print the names of the object\n \tIDs that are found. This inverts `--object-names`. This flag allows\n \tthe output to be more easily parsed by commands such as\n \tlinkgit:git-cat-file[1].\n \n---filter=::\n+`--filter=`::\n \tOnly useful with one of the `--objects*`; omits objects (usually\n-\tblobs) from the list of printed objects. The ''\n+\tblobs) from the list of printed objects. The __\n \tmay be one of the following:\n +\n-The form '--filter=blob:none' omits all blobs.\n+The form `--filter=blob:none` omits all blobs.\n +\n-The form '--filter=blob:limit=[kmg]' omits blobs of size at least n\n-bytes or units. n may be zero. The suffixes k, m, and g can be used\n-to name units in KiB, MiB, or GiB. For example, 'blob:limit=1k'\n+The form `--filter=blob:limit=[kmg]` omits blobs of size at least __\n+bytes or units. __ may be zero. The suffixes `k`, `m`, and `g` can be used\n+to name units in KiB, MiB, or GiB. For example, `blob:limit=1k`\n is the same as 'blob:limit=1024'.\n +\n-The form '--filter=object:type=(tag|commit|tree|blob)' omits all objects\n+The form `--filter=object:type=(tag|commit|tree|blob)` omits all objects\n which are not of the requested type.\n +\n-The form '--filter=sparse:oid=' uses a sparse-checkout\n-specification contained in the blob (or blob-expression) ''\n+The form `--filter=sparse:oid=` uses a sparse-checkout\n+specification contained in the blob (or blob-expression) __\n to omit blobs that would not be required for a sparse checkout on\n the requested refs.\n +\n-The form '--filter=tree:' omits all blobs and trees whose depth\n-from the root tree is >= (minimum depth if an object is located\n-at multiple depths in the commits traversed). =0 will not include\n+The form `--filter=tree:` omits all blobs and trees whose depth\n+from the root tree is >= __ (minimum depth if an object is located\n+at multiple depths in the commits traversed). __=0 will not include\n any trees or blobs unless included explicitly in the command-line (or\n-standard input when --stdin is used). =1 will include only the\n+standard input when `--stdin` is used). __=1 will include only the\n tree and blobs which are referenced directly by a commit reachable from\n- or an explicitly-given object. =2 is like =1\n+__ or an explicitly-given object. __=2 is like =1\n while also including trees and blobs one more level removed from an\n explicitly-given commit or tree.\n +\n-Note that the form '--filter=sparse:path=' that wants to read\n+Note that the form `--filter=sparse:path=` that wants to read\n from an arbitrary path on the filesystem has been dropped for security\n reasons.\n +\n-Multiple '--filter=' flags can be specified to combine filters. Only\n+Multiple `--filter=` flags can be specified to combine filters. Only\n objects which are accepted by every filter are included.\n +\n-The form '--filter=combine:++...' can also be\n+The form `--filter=combine:++...` can also be\n used to combined several filters, but this is harder than just repeating\n-the '--filter' flag and is usually not necessary. Filters are joined by\n+the `--filter` flag and is usually not necessary. Filters are joined by\n '{plus}' and individual filters are %-encoded (i.e. URL-encoded).\n Besides the '{plus}' and '%' characters, the following characters are\n reserved and also must be encoded: `~!@#$^&*()[]{}\\;\",<>?`+'`+\n@@ -1017,52 +1017,52 @@ as well as all characters with ASCII code <= `0x20`, which includes\n space and newline.\n +\n Other arbitrary characters can also be encoded. For instance,\n-'combine:tree:3+blob:none' and 'combine:tree%3A3+blob%3Anone' are\n+`combine:tree:3+blob:none` and `combine:tree%3A3+blob%3Anone` are\n equivalent.\n \n---no-filter::\n+`--no-filter`::\n \tTurn off any previous `--filter=` argument.\n \n---filter-provided-objects::\n+`--filter-provided-objects`::\n \tFilter the list of explicitly provided objects, which would otherwise\n \talways be printed even if they did not match any of the filters. Only\n \tuseful with `--filter=`.\n \n---filter-print-omitted::\n+`--filter-print-omitted`::\n \tOnly useful with `--filter=`; prints a list of the objects omitted\n \tby the filter. Object IDs are prefixed with a ``~'' character.\n \n---missing=::\n+`--missing=`::\n \tA debug option to help with future \"partial clone\" development.\n \tThis option specifies how missing objects are handled.\n +\n-The form '--missing=error' requests that rev-list stop with an error if\n+The form `--missing=error` requests that rev-list stop with an error if\n a missing object is encountered. This is the default action.\n +\n-The form '--missing=allow-any' will allow object traversal to continue\n+The form `--missing=allow-any` will allow object traversal to continue\n if a missing object is encountered. Missing objects will silently be\n omitted from the results.\n +\n-The form '--missing=allow-promisor' is like 'allow-any', but will only\n+The form `--missing=allow-promisor` is like `allow-any`, but will only\n allow object traversal to continue for EXPECTED promisor missing objects.\n Unexpected missing objects will raise an error.\n +\n-The form '--missing=print' is like 'allow-any', but will also print a\n+The form `--missing=print` is like `allow-any`, but will also print a\n list of the missing objects. Object IDs are prefixed with a ``?'' character.\n +\n-The form '--missing=print-info' is like 'print', but will also print additional\n+The form `--missing=print-info` is like `print`, but will also print additional\n information about the missing object inferred from its containing object. The\n information is all printed on the same line with the missing object ID in the\n form: `? [=]...`. The `=` pairs containing\n-additional information are separated from each other by a SP. The value is\n-encoded in a token specific fashion, but SP or LF contained in value are always\n+additional information are separated from each other by a _SP_. The value is\n+encoded in a token specific fashion, but _SP_ or _LF_ contained in value are always\n expected to be represented in such a way that the resulting encoded value does\n not have either of these two problematic bytes. Each `=` may be\n one of the following:\n +\n --\n * The `path=` shows the path of the missing object inferred from a\n- containing object. A path containing SP or special characters is enclosed in\n+ containing object. A path containing _SP_ or special characters is enclosed in\n double-quotes in the C style as needed.\n +\n * The `type=` shows the type of the missing object inferred from a\n@@ -1073,7 +1073,7 @@ If some tips passed to the traversal are missing, they will be\n considered as missing too, and the traversal will ignore them. In case\n we cannot get their Object ID though, an error will be raised.\n \n---exclude-promisor-objects::\n+`--exclude-promisor-objects`::\n \t(For internal use only.) Prefilter object traversal at\n \tpromisor boundary. This is used with partial clone. This is\n \tstronger than `--missing=allow-promisor` because it limits the\n@@ -1081,7 +1081,7 @@ we cannot get their Object ID though, an error will be raised.\n \tobjects.\n endif::git-rev-list[]\n \n---no-walk[=(sorted|unsorted)]::\n+`--no-walk[=(sorted|unsorted)]`::\n \tOnly show the given commits, but do not traverse their ancestors.\n \tThis has no effect if a range is specified. If the argument\n \t`unsorted` is given, the commits are shown in the order they were\n@@ -1090,7 +1090,7 @@ endif::git-rev-list[]\n \tby commit time.\n \tCannot be combined with `--graph`.\n \n---do-walk::\n+`--do-walk`::\n \tOverrides a previous `--no-walk`.\n endif::git-shortlog[]\n \n@@ -1106,10 +1106,10 @@ endif::git-rev-list[]\n \n include::pretty-options.adoc[]\n \n---relative-date::\n+`--relative-date`::\n \tSynonym for `--date=relative`.\n \n---date=::\n+`--date=`::\n \tOnly takes effect for dates shown in human-readable format, such\n \tas when using `--pretty`. `log.date` config variable sets a default\n \tvalue for the log command's `--date` option. By default, dates\n@@ -1159,12 +1159,12 @@ omitted.\n 1970). As with `--raw`, this is always in UTC and therefore `-local`\n has no effect.\n \n-`--date=format:...` feeds the format `...` to your system `strftime`,\n-except for %s, %z, and %Z, which are handled internally.\n+`--date=format:` feeds the __ to your system `strftime`,\n+except for `%s`, `%z`, and `%Z`, which are handled internally.\n Use `--date=format:%c` to show the date in your system locale's\n-preferred format. See the `strftime` manual for a complete list of\n+preferred format. See the `strftime`(3) manual for a complete list of\n format placeholders. When using `-local`, the correct syntax is\n-`--date=format-local:...`.\n+`--date=format-local:`.\n \n `--date=default` is the default format, and is based on ctime(3)\n output. It shows a single line with three-letter day of the week,\n@@ -1174,33 +1174,33 @@ the local time zone is used, e.g. `Thu Jan 1 00:00:00 1970 +0000`.\n --\n \n ifdef::git-rev-list[]\n---header::\n+`--header`::\n \tPrint the contents of the commit in raw-format; each record is\n \tseparated with a NUL character.\n \n---no-commit-header::\n+`--no-commit-header`::\n \tSuppress the header line containing \"commit\" and the object ID printed before\n \tthe specified format. This has no effect on the built-in formats; only custom\n \tformats are affected.\n \n---commit-header::\n+`--commit-header`::\n \tOverrides a previous `--no-commit-header`.\n endif::git-rev-list[]\n \n---parents::\n+`--parents`::\n \tPrint also the parents of the commit (in the form \"commit parent...\").\n \tAlso enables parent rewriting, see 'History Simplification' above.\n \n---children::\n+`--children`::\n \tPrint also the children of the commit (in the form \"commit child...\").\n \tAlso enables parent rewriting, see 'History Simplification' above.\n \n ifdef::git-rev-list[]\n---timestamp::\n+`--timestamp`::\n \tPrint the raw commit timestamp.\n endif::git-rev-list[]\n \n---left-right::\n+`--left-right`::\n \tMark which side of a symmetric difference a commit is reachable from.\n \tCommits from the left side are prefixed with `<` and those from\n \tthe right with `>`. If combined with `--boundary`, those\n@@ -1229,7 +1229,7 @@ you would get an output like this:\n \t-xxxxxxx... 1st on a\n -----------------------------------------------------------------------\n \n---graph::\n+`--graph`::\n \tDraw a text-based graphical representation of the commit history\n \ton the left hand side of the output. This may cause extra lines\n \tto be printed in between commits, in order for the graph history\n@@ -1241,15 +1241,15 @@ This enables parent rewriting, see 'History Simplification' above.\n This implies the `--topo-order` option by default, but the\n `--date-order` option may also be specified.\n \n---show-linear-break[=]::\n-\tWhen --graph is not used, all history branches are flattened\n+`--show-linear-break[=]`::\n+\tWhen `--graph` is not used, all history branches are flattened\n \twhich can make it hard to see that the two consecutive commits\n \tdo not belong to a linear branch. This option puts a barrier\n-\tin between them in that case. If `` is specified, it\n+\tin between them in that case. If __ is specified, it\n \tis the string that will be shown instead of the default one.\n \n ifdef::git-rev-list[]\n---count::\n+`--count`::\n \tPrint a number stating how many commits would have been\n \tlisted, and suppress all other output. When used together\n \twith `--left-right`, instead print the counts for left and\n-- \ngitgitgadget\n\n"},{"id":"519918","messageId":"9f9ce432bd6e50b9bbf1e16e2f55dbd730f72514.1749373787.git.gitgitgadget@gmail.com","threadId":"63603","inReplyTo":"pull.1933.git.1749373787.gitgitgadget@gmail.com","subject":"[PATCH 8/9] doc: git-log: convert diff options to new doc format","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-06-08T09:09:45Z","receivedAt":"2025-06-08T09:09:56Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= \n\n- Use `backticks` for keywords and more complex option\ndescriptions. The new rendering engine will apply synopsis rules to\nthese spans.\n- In description lists, put each option on its own line, to make them more\nsearchable and enable automatic translation of the options.\n\nSigned-off-by: Jean-Noël Avila \n---\n Documentation/diff-options.adoc | 40 +++++++++++++++++++--------------\n 1 file changed, 23 insertions(+), 17 deletions(-)\n\ndiff --git a/Documentation/diff-options.adoc b/Documentation/diff-options.adoc\nindex 640eb6e7db58..f3a35d81411f 100644\n--- a/Documentation/diff-options.adoc\n+++ b/Documentation/diff-options.adoc\n@@ -37,32 +37,32 @@ endif::git-diff[]\n endif::git-format-patch[]\n \n ifdef::git-log[]\n--m::\n+`-m`::\n \tShow diffs for merge commits in the default format. This is\n \tsimilar to `--diff-merges=on`, except `-m` will\n \tproduce no output unless `-p` is given as well.\n \n--c::\n+`-c`::\n \tProduce combined diff output for merge commits.\n \tShortcut for `--diff-merges=combined -p`.\n \n---cc::\n+`--cc`::\n \tProduce dense combined diff output for merge commits.\n \tShortcut for `--diff-merges=dense-combined -p`.\n \n---dd::\n+`--dd`::\n \tProduce diff with respect to first parent for both merge and\n \tregular commits.\n \tShortcut for `--diff-merges=first-parent -p`.\n \n---remerge-diff::\n+`--remerge-diff`::\n \tProduce remerge-diff output for merge commits.\n \tShortcut for `--diff-merges=remerge -p`.\n \n---no-diff-merges::\n+`--no-diff-merges`::\n \tSynonym for `--diff-merges=off`.\n \n---diff-merges=::\n+`--diff-merges=`::\n \tSpecify diff format to be used for merge commits. Default is\n \t{diff-merges-default} unless `--first-parent` is in use, in\n \twhich case `first-parent` is the default.\n@@ -70,48 +70,54 @@ ifdef::git-log[]\n The following formats are supported:\n +\n --\n-off, none::\n+`off`::\n+`none`::\n \tDisable output of diffs for merge commits. Useful to override\n \timplied value.\n \n-on, m::\n+`on`::\n+`m`::\n \tMake diff output for merge commits to be shown in the default\n \tformat. The default format can be changed using\n \t`log.diffMerges` configuration variable, whose default value\n \tis `separate`.\n \n-first-parent, 1::\n+`first-parent`::\n+`1`::\n \tShow full diff with respect to first parent. This is the same\n \tformat as `--patch` produces for non-merge commits.\n \n-separate::\n+`separate`::\n \tShow full diff with respect to each of parents.\n \tSeparate log entry and diff is generated for each parent.\n \n-combined, c::\n+`combined`::\n+`c`::\n \tShow differences from each of the parents to the merge\n \tresult simultaneously instead of showing pairwise diff between\n \ta parent and the result one at a time. Furthermore, it lists\n \tonly files which were modified from all parents.\n \n-dense-combined, cc::\n+`dense-combined`::\n+`cc`::\n \tFurther compress output produced by `--diff-merges=combined`\n \tby omitting uninteresting hunks whose contents in the parents\n \thave only two variants and the merge result picks one of them\n \twithout modification.\n \n-remerge, r::\n-\tRemerge two-parent merge commits to create a temporary tree\n+`remerge`::\n+`r`:: Remerge two-parent merge commits to create a temporary tree\n \tobject--potentially containing files with conflict markers\n \tand such. A diff is then shown between that temporary tree\n \tand the actual merge commit.\n+--\n +\n The output emitted when this option is used is subject to change, and\n so is its interaction with other options (unless explicitly\n documented).\n---\n \n---combined-all-paths::\n+\n+`--combined-all-paths`::\n \tCause combined diffs (used for merge commits) to\n \tlist the name of the file from all parents. It thus only has\n \teffect when `--diff-merges=[dense-]combined` is in use, and\n-- \ngitgitgadget\n\n"},{"id":"519920","messageId":"d54e297567ac8f3009daa8fdf3de158338b2b700.1749373787.git.gitgitgadget@gmail.com","threadId":"63603","inReplyTo":"pull.1933.git.1749373787.gitgitgadget@gmail.com","subject":"[PATCH 7/9] doc: git-log: convert pretty formats to new doc format","fromName":"Jean-Noël Avila via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2025-06-08T09:09:44Z","receivedAt":"2025-06-08T09:09:56Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= \n\n- Use __ instead of in the description\n- Use `backticks` for keywords and more complex option\ndescriptions. The new rendering engine will apply synopsis rules to\nthese spans.\n\nFor all the formats in the form of %(foo), the formatting needs to be\nheavier because we not want the parentheses to be rendered as syntax\nelements,but as keywords, i.e. we need to circumvent the syntax highlighting\nof synopsis. In this particular case, this requires the heavy escaping of\nthe parts that contain parentheses with ++.\n\nSigned-off-by: Jean-Noël Avila \n---\n Documentation/pretty-formats.adoc | 283 +++++++++++++++---------------\n 1 file changed, 143 insertions(+), 140 deletions(-)\n\ndiff --git a/Documentation/pretty-formats.adoc b/Documentation/pretty-formats.adoc\nindex 07475de8c337..9ed0417fc811 100644\n--- a/Documentation/pretty-formats.adoc\n+++ b/Documentation/pretty-formats.adoc\n@@ -2,11 +2,11 @@ PRETTY FORMATS\n --------------\n \n If the commit is a merge, and if the pretty-format\n-is not 'oneline', 'email' or 'raw', an additional line is\n-inserted before the 'Author:' line. This line begins with\n+is not `oneline`, `email` or `raw`, an additional line is\n+inserted before the `Author:` line. This line begins with\n \"Merge: \" and the hashes of ancestral commits are printed,\n separated by spaces. Note that the listed commits may not\n-necessarily be the list of the *direct* parent commits if you\n+necessarily be the list of the 'direct' parent commits if you\n have limited your view of history: for example, if you are\n only interested in changes related to a certain directory or\n file.\n@@ -14,24 +14,24 @@ file.\n There are several built-in formats, and you can define\n additional formats by setting a pretty.\n config option to either another format name, or a\n-'format:' string, as described below (see\n+`format:` string, as described below (see\n linkgit:git-config[1]). Here are the details of the\n built-in formats:\n \n-* 'oneline'\n+* `oneline`\n \n \t \n +\n This is designed to be as compact as possible.\n \n-* 'short'\n+* `short`\n \n \t commit \n \t Author: \n \n \t \n \n-* 'medium'\n+* `medium`\n \n \t commit \n \t Author: \n@@ -41,7 +41,7 @@ This is designed to be as compact as possible.\n \n \t \n \n-* 'full'\n+* `full`\n \n \t commit \n \t Author: \n@@ -51,7 +51,7 @@ This is designed to be as compact as possible.\n \n \t \n \n-* 'fuller'\n+* `fuller`\n \n \t commit \n \t Author: \n@@ -63,18 +63,18 @@ This is designed to be as compact as possible.\n \n \t \n \n-* 'reference'\n+* `reference`\n \n \t (, )\n +\n This format is used to refer to another commit in a commit message and\n-is the same as `--pretty='format:%C(auto)%h (%s, %ad)'`. By default,\n+is the same as ++--pretty=\\'format:%C(auto)%h (%s, %ad)'++. By default,\n the date is formatted with `--date=short` unless another `--date` option\n is explicitly specified. As with any `format:` with format\n placeholders, its output is not affected by other options like\n `--decorate` and `--walk-reflogs`.\n \n-* 'email'\n+* `email`\n \n \t From \n \t From: \n@@ -83,30 +83,30 @@ placeholders, its output is not affected by other options like\n \n \t \n \n-* 'mboxrd'\n+* `mboxrd`\n +\n-Like 'email', but lines in the commit message starting with \"From \"\n+Like `email`, but lines in the commit message starting with \"From \"\n (preceded by zero or more \">\") are quoted with \">\" so they aren't\n confused as starting a new commit.\n \n-* 'raw'\n+* `raw`\n +\n-The 'raw' format shows the entire commit exactly as\n+The `raw` format shows the entire commit exactly as\n stored in the commit object. Notably, the hashes are\n-displayed in full, regardless of whether --abbrev or\n---no-abbrev are used, and 'parents' information show the\n+displayed in full, regardless of whether `--abbrev` or\n+`--no-abbrev` are used, and 'parents' information show the\n true parent commits, without taking grafts or history\n simplification into account. Note that this format affects the way\n commits are displayed, but not the way the diff is shown e.g. with\n `git log --raw`. To get full object names in a raw diff format,\n use `--no-abbrev`.\n \n-* 'format:'\n+* `format:`\n +\n-The 'format:' format allows you to specify which information\n+The `format:` format allows you to specify which information\n you want to show. It works a little bit like printf format,\n-with the notable exception that you get a newline with '%n'\n-instead of '\\n'.\n+with the notable exception that you get a newline with `%n`\n+instead of `\\n`.\n +\n E.g, 'format:\"The author of %h was %an, %ar%nThe title was >>%s<<%n\"'\n would show something like this:\n@@ -120,158 +120,161 @@ The title was >>t4119: test autocomputing -p for traditional diff input.<<\n The placeholders are:\n \n - Placeholders that expand to a single literal character:\n-'%n':: newline\n-'%%':: a raw '%'\n-'%x00':: '%x' followed by two hexadecimal digits is replaced with a\n+++%n++:: newline\n+++%%++:: a raw ++%++\n+++%x00++:: ++%x++ followed by two hexadecimal digits is replaced with a\n \t byte with the hexadecimal digits' value (we will call this\n \t \"literal formatting code\" in the rest of this document).\n \n - Placeholders that affect formatting of later placeholders:\n-'%Cred':: switch color to red\n-'%Cgreen':: switch color to green\n-'%Cblue':: switch color to blue\n-'%Creset':: reset color\n-'%C(...)':: color specification, as described under Values in the\n+++%Cred++:: switch color to red\n+++%Cgreen++:: switch color to green\n+++%Cblue++:: switch color to blue\n+++%Creset++:: reset color\n+++%C(++__++)++:: color specification, as described under Values in the\n \t \"CONFIGURATION FILE\" section of linkgit:git-config[1]. By\n \t default, colors are shown only when enabled for log output\n \t (by `color.diff`, `color.ui`, or `--color`, and respecting\n \t the `auto` settings of the former if we are going to a\n-\t terminal). `%C(auto,...)` is accepted as a historical\n-\t synonym for the default (e.g., `%C(auto,red)`). Specifying\n-\t `%C(always,...)` will show the colors even when color is\n+\t terminal). ++%C(auto,++__++)++ is accepted as a historical\n+\t synonym for the default (e.g., ++%C(auto,red)++). Specifying\n+\t ++%C(always,++__++)++ will show the colors even when color is\n \t not otherwise enabled (though consider just using\n-\t `--color=always` to enable color for the whole output,\n+\t `--color=always` to enable color for the whole output,\n \t including this format and anything else git might color).\n-\t `auto` alone (i.e. `%C(auto)`) will turn on auto coloring\n+\t `auto` alone (i.e. ++%C(auto)++) will turn on auto coloring\n \t on the next placeholders until the color is switched\n \t again.\n-'%m':: left (`<`), right (`>`) or boundary (`-`) mark\n-'%w([[,[,]]])':: switch line wrapping, like the -w option of\n+++%m++:: left (`<`), right (`>`) or boundary (`-`) mark\n+++%w(++`[[,[,]]]`++)++:: switch line wrapping, like the `-w` option of\n \t\t\t linkgit:git-shortlog[1].\n-'%<( [,trunc|ltrunc|mtrunc])':: make the next placeholder take at\n+++%<(++`[,(trunc|ltrunc|mtrunc)]`++)++:: make the next placeholder take at\n \t\t\t\t least N column widths, padding spaces on\n \t\t\t\t the right if necessary. Optionally\n-\t\t\t\t truncate (with ellipsis '..') at the left (ltrunc) `..ft`,\n+\t\t\t\t truncate (with ellipsis `..`) at the left (ltrunc) `..ft`,\n \t\t\t\t the middle (mtrunc) `mi..le`, or the end\n \t\t\t\t (trunc) `rig..`, if the output is longer than\n-\t\t\t\t N columns.\n+\t\t\t\t __ columns.\n \t\t\t\t Note 1: that truncating\n-\t\t\t\t only works correctly with N >= 2.\n-\t\t\t\t Note 2: spaces around the N and M (see below)\n+\t\t\t\t only works correctly with __ >= 2.\n+\t\t\t\t Note 2: spaces around the __ and __ (see below)\n \t\t\t\t values are optional.\n \t\t\t\t Note 3: Emojis and other wide characters\n \t\t\t\t will take two display columns, which may\n \t\t\t\t over-run column boundaries.\n \t\t\t\t Note 4: decomposed character combining marks\n \t\t\t\t may be misplaced at padding boundaries.\n-'%<|( )':: make the next placeholder take at least until Mth\n+++%<|(++__ ++)++:: make the next placeholder take at least until __ th\n \t display column, padding spaces on the right if necessary.\n-\t Use negative M values for column positions measured\n+\t Use negative __ values for column positions measured\n \t from the right hand edge of the terminal window.\n-'%>( )', '%>|( )':: similar to '%<( )', '%<|( )' respectively,\n+++%>(++__++)++::\n+++%>|(++__++)++:: similar to ++%<(++__++)++, ++%<|(++__++)++ respectively,\n \t\t\tbut padding spaces on the left\n-'%>>( )', '%>>|( )':: similar to '%>( )', '%>|( )'\n+++%>>(++__++)++::\n+++%>>|(++__++)++:: similar to ++%>(++__++)++, ++%>|(++__++)++\n \t\t\t respectively, except that if the next\n \t\t\t placeholder takes more spaces than given and\n \t\t\t there are spaces on its left, use those\n \t\t\t spaces\n-'%><( )', '%><|( )':: similar to '%<( )', '%<|( )'\n+++%><(++__++)++::\n+++%><|(++__++)++:: similar to ++%<(++__++)++, ++%<|(++__++)++\n \t\t\t respectively, but padding both sides\n \t\t\t (i.e. the text is centered)\n \n - Placeholders that expand to information extracted from the commit:\n-'%H':: commit hash\n-'%h':: abbreviated commit hash\n-'%T':: tree hash\n-'%t':: abbreviated tree hash\n-'%P':: parent hashes\n-'%p':: abbreviated parent hashes\n-'%an':: author name\n-'%aN':: author name (respecting .mailmap, see linkgit:git-shortlog[1]\n++%H+:: commit hash\n++%h+:: abbreviated commit hash\n++%T+:: tree hash\n++%t+:: abbreviated tree hash\n++%P+:: parent hashes\n++%p+:: abbreviated parent hashes\n++%an+:: author name\n++%aN+:: author name (respecting .mailmap, see linkgit:git-shortlog[1]\n \tor linkgit:git-blame[1])\n-'%ae':: author email\n-'%aE':: author email (respecting .mailmap, see linkgit:git-shortlog[1]\n++%ae+:: author email\n++%aE+:: author email (respecting .mailmap, see linkgit:git-shortlog[1]\n \tor linkgit:git-blame[1])\n-'%al':: author email local-part (the part before the '@' sign)\n-'%aL':: author local-part (see '%al') respecting .mailmap, see\n++%al+:: author email local-part (the part before the `@` sign)\n++%aL+:: author local-part (see +%al+) respecting .mailmap, see\n \tlinkgit:git-shortlog[1] or linkgit:git-blame[1])\n-'%ad':: author date (format respects --date= option)\n-'%aD':: author date, RFC2822 style\n-'%ar':: author date, relative\n-'%at':: author date, UNIX timestamp\n-'%ai':: author date, ISO 8601-like format\n-'%aI':: author date, strict ISO 8601 format\n-'%as':: author date, short format (`YYYY-MM-DD`)\n-'%ah':: author date, human style (like the `--date=human` option of\n++%ad+:: author date (format respects --date= option)\n++%aD+:: author date, RFC2822 style\n++%ar+:: author date, relative\n++%at+:: author date, UNIX timestamp\n++%ai+:: author date, ISO 8601-like format\n++%aI+:: author date, strict ISO 8601 format\n++%as+:: author date, short format (`YYYY-MM-DD`)\n++%ah+:: author date, human style (like the `--date=human` option of\n \tlinkgit:git-rev-list[1])\n-'%cn':: committer name\n-'%cN':: committer name (respecting .mailmap, see\n++%cn+:: committer name\n++%cN+:: committer name (respecting .mailmap, see\n \tlinkgit:git-shortlog[1] or linkgit:git-blame[1])\n-'%ce':: committer email\n-'%cE':: committer email (respecting .mailmap, see\n++%ce+:: committer email\n++%cE+:: committer email (respecting .mailmap, see\n \tlinkgit:git-shortlog[1] or linkgit:git-blame[1])\n-'%cl':: committer email local-part (the part before the '@' sign)\n-'%cL':: committer local-part (see '%cl') respecting .mailmap, see\n++%cl+:: committer email local-part (the part before the `@` sign)\n++%cL+:: committer local-part (see +%cl+) respecting .mailmap, see\n \tlinkgit:git-shortlog[1] or linkgit:git-blame[1])\n-'%cd':: committer date (format respects --date= option)\n-'%cD':: committer date, RFC2822 style\n-'%cr':: committer date, relative\n-'%ct':: committer date, UNIX timestamp\n-'%ci':: committer date, ISO 8601-like format\n-'%cI':: committer date, strict ISO 8601 format\n-'%cs':: committer date, short format (`YYYY-MM-DD`)\n-'%ch':: committer date, human style (like the `--date=human` option of\n++%cd+:: committer date (format respects --date= option)\n++%cD+:: committer date, RFC2822 style\n++%cr+:: committer date, relative\n++%ct+:: committer date, UNIX timestamp\n++%ci+:: committer date, ISO 8601-like format\n++%cI+:: committer date, strict ISO 8601 format\n++%cs+:: committer date, short format (`YYYY-MM-DD`)\n++%ch+:: committer date, human style (like the `--date=human` option of\n \tlinkgit:git-rev-list[1])\n-'%d':: ref names, like the --decorate option of linkgit:git-log[1]\n-'%D':: ref names without the \" (\", \")\" wrapping.\n-'%(decorate[:])'::\n++%d+:: ref names, like the --decorate option of linkgit:git-log[1]\n++%D+:: ref names without the \" (\", \")\" wrapping.\n+++%(decorate++`[: