{"thread":{"id":"64732","subject":"[PATCH] doc: git-blame: convert blame to new doc format","startedAt":"2026-01-05T23:02:44Z","lastAt":"2026-01-11T18:24:28Z","messageCount":9,"participants":["Michael Lyons","Jean-Noël AVILA","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"533091","messageId":"20260105230220.519303-1-git@michael.lyo.nz","threadId":"64732","inReplyTo":null,"subject":"[PATCH] doc: git-blame: convert blame to new doc format","fromName":"Michael Lyons","fromEmail":"git@michael.lyo.nz","sentAt":"2026-01-05T23:02:17Z","receivedAt":"2026-01-05T23:02:44Z","isPatch":true,"sender":{"key":"git@michael.lyo.nz","avatar":null},"body":"- Use _<placeholder>_ instead of <placeholder> in the description\n- Use _underscores_ around sample commits, ranges, and math involving\nor associated with <placeholders>\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: Michael Lyons <git@michael.lyo.nz>\n---\n Documentation/blame-options.adoc | 100 +++++++++++++++----------------\n Documentation/git-blame.adoc     |  60 +++++++++----------\n 2 files changed, 80 insertions(+), 80 deletions(-)\n\ndiff --git a/Documentation/blame-options.adoc b/Documentation/blame-options.adoc\nindex 1fb948fc76..1f5b6ec57d 100644\n--- a/Documentation/blame-options.adoc\n+++ b/Documentation/blame-options.adoc\n@@ -1,105 +1,105 @@\n--b::\n+`-b`::\n \tShow blank SHA-1 for boundary commits.  This can also\n \tbe controlled via the `blame.blankBoundary` config option.\n \n---root::\n+`--root`::\n \tDo not treat root commits as boundaries.  This can also be\n \tcontrolled via the `blame.showRoot` config option.\n \n---show-stats::\n+`--show-stats`::\n \tInclude additional statistics at the end of blame output.\n \n--L <start>,<end>::\n--L :<funcname>::\n-\tAnnotate only the line range given by '<start>,<end>',\n-\tor by the function name regex '<funcname>'.\n+`-L <start>,<end>`::\n+`-L :<funcname>`::\n+\tAnnotate only the line range given by _<start>,<end>_,\n+\tor by the function name regex _<funcname>_.\n \tMay be specified multiple times. Overlapping ranges are allowed.\n +\n-'<start>' and '<end>' are optional. `-L <start>` or `-L <start>,` spans from\n-'<start>' to end of file. `-L ,<end>` spans from start of file to '<end>'.\n+_<start>_ and _<end>_ are optional. `-L <start>` or `-L <start>,` spans from\n+_<start>_ to end of file. `-L ,<end>` spans from start of file to _<end>_.\n +\n include::line-range-format.adoc[]\n \n--l::\n+`-l`::\n \tShow long rev (Default: off).\n \n--t::\n+`-t`::\n \tShow raw timestamp (Default: off).\n \n--S <revs-file>::\n-\tUse revisions from revs-file instead of calling linkgit:git-rev-list[1].\n+`-S <revs-file>`::\n+\tUse revisions from _revs-file_ instead of calling linkgit:git-rev-list[1].\n \n---reverse <rev>..<rev>::\n+`--reverse <rev>..<rev>`::\n \tWalk history forward instead of backward. Instead of showing\n \tthe revision in which a line appeared, this shows the last\n \trevision in which a line has existed. This requires a range of\n-\trevision like START..END where the path to blame exists in\n-\tSTART.  `git blame --reverse START` is taken as `git blame\n+\trevision like _START..END_ where the path to blame exists in\n+\t_START_.  `git blame --reverse START` is taken as `git blame\n \t--reverse START..HEAD` for convenience.\n \n---first-parent::\n+`--first-parent`::\n \tFollow only the first parent commit upon seeing a merge\n \tcommit. This option can be used to determine when a line\n \twas introduced to a particular integration branch, rather\n \tthan when it was introduced to the history overall.\n \n--p::\n---porcelain::\n+`-p`::\n+`--porcelain`::\n \tShow in a format designed for machine consumption.\n \n---line-porcelain::\n+`--line-porcelain`::\n \tShow the porcelain format, but output commit information for\n \teach line, not just the first time a commit is referenced.\n-\tImplies --porcelain.\n+\tImplies `--porcelain`.\n \n---incremental::\n+`--incremental`::\n \tShow the result incrementally in a format designed for\n \tmachine consumption.\n \n---encoding=<encoding>::\n+`--encoding=<encoding>`::\n \tSpecifies the encoding used to output author names\n \tand commit summaries. Setting it to `none` makes blame\n \toutput unconverted data. For more information see the\n \tdiscussion about encoding in the linkgit:git-log[1]\n \tmanual page.\n \n---contents <file>::\n-\tAnnotate using the contents from the named file, starting from <rev>\n-\tif it is specified, and HEAD otherwise. You may specify '-' to make\n+`--contents <file>`::\n+\tAnnotate using the contents from the named file, starting from _<rev>_\n+\tif it is specified, and `HEAD` otherwise. You may specify `-` to make\n \tthe command read from the standard input for the file contents.\n \n---date <format>::\n-\tSpecifies the format used to output dates. If --date is not\n-\tprovided, the value of the blame.date config variable is\n-\tused. If the blame.date config variable is also not set, the\n+`--date <format>`::\n+\tSpecifies the format used to output dates. If `--date` is not\n+\tprovided, the value of the `blame.date` config variable is\n+\tused. If the `blame.date` config variable is also not set, the\n \tiso format is used. For supported values, see the discussion\n-\tof the --date option at linkgit:git-log[1].\n+\tof the `--date` option at linkgit:git-log[1].\n \n---progress::\n---no-progress::\n+`--progress`::\n+`--no-progress`::\n \tProgress status is reported on the standard error stream\n \tby default when it is attached to a terminal. This flag\n \tenables progress reporting even if not attached to a\n \tterminal. Can't use `--progress` together with `--porcelain`\n \tor `--incremental`.\n \n--M[<num>]::\n+`-M[<num>]`::\n \tDetect moved or copied lines within a file. When a commit\n \tmoves or copies a block of lines (e.g. the original file\n-\thas A and then B, and the commit changes it to B and then\n-\tA), the traditional 'blame' algorithm notices only half of\n+\thas _A_ and then _B_, and the commit changes it to _B_ and then\n+\t_A_), the traditional `blame` algorithm notices only half of\n \tthe movement and typically blames the lines that were moved\n-\tup (i.e. B) to the parent and assigns blame to the lines that\n-\twere moved down (i.e. A) to the child commit.  With this\n+\tup (i.e. _B_) to the parent and assigns blame to the lines that\n+\twere moved down (i.e. _A_) to the child commit.  With this\n \toption, both groups of lines are blamed on the parent by\n \trunning extra passes of inspection.\n +\n-<num> is optional but it is the lower bound on the number of\n+_<num>_ is optional, but it is the lower bound on the number of\n alphanumeric characters that Git must detect as moving/copying\n within a file for it to associate those lines with the parent\n commit. The default value is 20.\n \n--C[<num>]::\n+`-C[<num>]`::\n \tIn addition to `-M`, detect lines moved or copied from other\n \tfiles that were modified in the same commit.  This is\n \tuseful when you reorganize your program and move code\n@@ -109,14 +109,14 @@ commit. The default value is 20.\n \toption is given three times, the command additionally\n \tlooks for copies from other files in any commit.\n +\n-<num> is optional but it is the lower bound on the number of\n+_<num>_ is optional, but it is the lower bound on the number of\n alphanumeric characters that Git must detect as moving/copying\n between files for it to associate those lines with the parent\n commit. And the default value is 40. If there are more than one\n-`-C` options given, the <num> argument of the last `-C` will\n+`-C` options given, the _<num>_ argument of the last `-C` will\n take effect.\n \n---ignore-rev <rev>::\n+`--ignore-rev <rev>`::\n \tIgnore changes made by the revision when assigning blame, as if the\n \tchange never happened.  Lines that were changed or added by an ignored\n \tcommit will be blamed on the previous commit that changed that line or\n@@ -126,26 +126,26 @@ take effect.\n \tanother commit will be marked with a `?` in the blame output.  If the\n \t`blame.markUnblamableLines` config option is set, then those lines touched\n \tby an ignored commit that we could not attribute to another revision are\n-\tmarked with a '*'. In the porcelain modes, we print 'ignored' and\n-\t'unblamable' on a newline respectively.\n+\tmarked with a `*`. In the porcelain modes, we print _ignored_ and\n+\t_unblamable_ on a newline respectively.\n \n---ignore-revs-file <file>::\n-\tIgnore revisions listed in `file`, which must be in the same format as an\n+`--ignore-revs-file <file>`::\n+\tIgnore revisions listed in _<file>_, which must be in the same format as an\n \t`fsck.skipList`.  This option may be repeated, and these files will be\n \tprocessed after any files specified with the `blame.ignoreRevsFile` config\n \toption.  An empty file name, `\"\"`, will clear the list of revs from\n \tpreviously processed files.\n \n---color-lines::\n+`--color-lines`::\n \tColor line annotations in the default format differently if they come from\n \tthe same commit as the preceding line. This makes it easier to distinguish\n \tcode blocks introduced by different commits. The color defaults to cyan and\n \tcan be adjusted using the `color.blame.repeatedLines` config option.\n \n---color-by-age::\n+`--color-by-age`::\n \tColor line annotations depending on the age of the line in the default format.\n \tThe `color.blame.highlightRecent` config option controls what color is used for\n \teach range of age.\n \n--h::\n+`-h`::\n \tShow help message.\ndiff --git a/Documentation/git-blame.adoc b/Documentation/git-blame.adoc\nindex adcbb6f5dc..7dc93f90b2 100644\n--- a/Documentation/git-blame.adoc\n+++ b/Documentation/git-blame.adoc\n@@ -7,12 +7,12 @@ git-blame - Show what revision and author last modified each line of a file\n \n SYNOPSIS\n --------\n-[verse]\n-'git blame' [-c] [-b] [-l] [--root] [-t] [-f] [-n] [-s] [-e] [-p] [-w] [--incremental]\n-\t    [-L <range>] [-S <revs-file>] [-M] [-C] [-C] [-C] [--since=<date>]\n-\t    [--ignore-rev <rev>] [--ignore-revs-file <file>]\n-\t    [--color-lines] [--color-by-age] [--progress] [--abbrev=<n>]\n-\t    [ --contents <file> ] [<rev> | --reverse <rev>..<rev>] [--] <file>\n+[synopsis]\n+git blame [-c] [-b] [-l] [--root] [-t] [-f] [-n] [-s] [-e] [-p] [-w] [--incremental]\n+\t  [-L <range>] [-S <revs-file>] [-M] [-C] [-C] [-C] [--since=<date>]\n+\t  [--ignore-rev <rev>] [--ignore-revs-file <file>]\n+\t  [--color-lines] [--color-by-age] [--progress] [--abbrev=<n>]\n+\t  [ --contents <file> ] [<rev> | --reverse <rev>..<rev>] [--] <file>\n \n DESCRIPTION\n -----------\n@@ -30,7 +30,7 @@ lines that were copied and pasted from another file, etc., see the\n `-C` and `-M` options.\n \n The report does not tell you anything about lines which have been deleted or\n-replaced; you need to use a tool such as 'git diff' or the \"pickaxe\"\n+replaced; you need to use a tool such as `git diff` or the \"pickaxe\"\n interface briefly mentioned in the following paragraph.\n \n Apart from supporting file annotation, Git also supports searching the\n@@ -50,47 +50,47 @@ OPTIONS\n -------\n include::blame-options.adoc[]\n \n--c::\n+`-c`::\n \tUse the same output mode as linkgit:git-annotate[1] (Default: off).\n \n---score-debug::\n+`--score-debug`::\n \tInclude debugging information related to the movement of\n \tlines between files (see `-C`) and lines moved within a\n \tfile (see `-M`).  The first number listed is the score.\n \tThis is the number of alphanumeric characters detected\n \tas having been moved between or within files.  This must be above\n-\ta certain threshold for 'git blame' to consider those lines\n+\ta certain threshold for `git blame` to consider those lines\n \tof code to have been moved.\n \n--f::\n---show-name::\n+`-f`::\n+`--show-name`::\n \tShow the filename in the original commit.  By default\n \tthe filename is shown if there is any line that came from a\n \tfile with a different name, due to rename detection.\n \n--n::\n---show-number::\n+`-n`::\n+`--show-number`::\n \tShow the line number in the original commit (Default: off).\n \n--s::\n+`-s`::\n \tSuppress the author name and timestamp from the output.\n \n--e::\n---show-email::\n+`-e`::\n+`--show-email`::\n \tShow the author email instead of the author name (Default: off).\n \tThis can also be controlled via the `blame.showEmail` config\n \toption.\n \n--w::\n+`-w`::\n \tIgnore whitespace when comparing the parent's version and\n \tthe child's to find where the lines came from.\n \n include::diff-algorithm-option.adoc[]\n \n---abbrev=<n>::\n-\tInstead of using the default 7+1 hexadecimal digits as the\n-\tabbreviated object name, use <m>+1 digits, where <m> is at\n-\tleast <n> but ensures the commit object names are unique.\n+`--abbrev=<n>`::\n+\tInstead of using the default _7+1_ hexadecimal digits as the\n+\tabbreviated object name, use _<m>+1_ digits, where _<m>_ is at\n+\tleast _<n>_ but ensures the commit object names are unique.\n \tNote that 1 column\n \tis used for a caret to mark the boundary commit.\n \n@@ -124,21 +124,21 @@ header at the minimum has the first line which has:\n This header line is followed by the following information\n at least once for each commit:\n \n-- the author name (\"author\"), email (\"author-mail\"), time\n-  (\"author-time\"), and time zone (\"author-tz\"); similarly\n+- the author name (`author`), email (`author-mail`), time\n+  (`author-time`), and time zone (`author-tz`); similarly\n   for committer.\n - the filename in the commit that the line is attributed to.\n-- the first line of the commit log message (\"summary\").\n+- the first line of the commit log message (`summary`).\n \n The contents of the actual line are output after the above\n-header, prefixed by a TAB. This is to allow adding more\n+header, prefixed by a _TAB_. This is to allow adding more\n header elements later.\n \n The porcelain format generally suppresses commit information that has\n already been seen. For example, two lines that are blamed to the same\n commit will both be shown, but the details for that commit will be shown\n only once. Information which is specific to individual lines will not be\n-grouped together, like revs to be marked 'ignored' or 'unblamable'. This\n+grouped together, like revs to be marked _ignored_ or _unblamable_. This\n is more efficient, but may require more state be kept by the reader. The\n `--line-porcelain` option can be used to output full commit information\n for each line, allowing simpler (but less efficient) usage like:\n@@ -152,7 +152,7 @@ for each line, allowing simpler (but less efficient) usage like:\n SPECIFYING RANGES\n -----------------\n \n-Unlike 'git blame' and 'git annotate' in older versions of git, the extent\n+Unlike `git blame` and `git annotate` in older versions of git, the extent\n of the annotation can be limited to both line ranges and revision\n ranges. The `-L` option, which limits annotation to a range of lines, may be\n specified multiple times.\n@@ -173,7 +173,7 @@ which limits the annotation to the body of the `hello` subroutine.\n \n When you are not interested in changes older than version\n v2.6.18, or changes older than 3 weeks, you can use revision\n-range specifiers similar to 'git rev-list':\n+range specifiers similar to `git rev-list`:\n \n \tgit blame v2.6.18.. -- foo\n \tgit blame --since=3.weeks -- foo\n@@ -232,7 +232,7 @@ parser (which should be quite natural for most scripting languages).\n +\n [NOTE]\n For people who do parsing: to make it more robust, just ignore any\n-lines between the first and last one (\"<sha1>\" and \"filename\" lines)\n+lines between the first and last one (_<sha1>_ and _filename_ lines)\n where you do not recognize the tag words (or care about that particular\n one) at the beginning of the \"extended information\" lines. That way, if\n there is ever added information (like the commit encoding or extended\n-- \n2.47.3\n\n"},{"id":"533156","messageId":"7894506.EvYhyI6sBW@piment-oiseau","threadId":"64732","inReplyTo":"20260105230220.519303-1-git@michael.lyo.nz","subject":"Re: [PATCH] doc: git-blame: convert blame to new doc format","fromName":"Jean-Noël AVILA","fromEmail":"avila.jn@gmail.com","sentAt":"2026-01-06T18:57:27Z","receivedAt":"2026-01-06T18:57:37Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"On Tuesday, 6 January 2026 00:02:17 CET Michael Lyons wrote:\n> - Use _<placeholder>_ instead of <placeholder> in the description\n> - Use _underscores_ around sample commits, ranges, and math involving\n> or associated with <placeholders>\n> - Use `backticks` for keywords and more complex option\n> descriptions. The new rendering engine will apply synopsis rules to\n> these spans.\n> \n> Signed-off-by: Michael Lyons <git@michael.lyo.nz>\n\nThanks for helping out.\n\n> ---\n>  Documentation/blame-options.adoc | 100 +++++++++++++++----------------\n>  Documentation/git-blame.adoc     |  60 +++++++++----------\n>  2 files changed, 80 insertions(+), 80 deletions(-)\n> \n> diff --git a/Documentation/blame-options.adoc b/Documentation/blame-\noptions.adoc\n> index 1fb948fc76..1f5b6ec57d 100644\n> --- a/Documentation/blame-options.adoc\n> +++ b/Documentation/blame-options.adoc\n> @@ -1,105 +1,105 @@\n> --b::\n> +`-b`::\n>  \tShow blank SHA-1 for boundary commits.  This can also\n>  \tbe controlled via the `blame.blankBoundary` config option.\n> \n> ---root::\n> +`--root`::\n>  \tDo not treat root commits as boundaries.  This can also be\n>  \tcontrolled via the `blame.showRoot` config option.\n> \n> ---show-stats::\n> +`--show-stats`::\n>  \tInclude additional statistics at the end of blame output.\n> \n> --L <start>,<end>::\n> --L :<funcname>::\n> -\tAnnotate only the line range given by '<start>,<end>',\n> -\tor by the function name regex '<funcname>'.\n> +`-L <start>,<end>`::\n> +`-L :<funcname>`::\n> +\tAnnotate only the line range given by _<start>,<end>_,\n\nIt would be better to use backticks, so that the comma is formatted as a \nkeyword: `<start>,<end>`\n\n> +\tor by the function name regex _<funcname>_.\n>  \tMay be specified multiple times. Overlapping ranges are allowed.\n>  +\n> -'<start>' and '<end>' are optional. `-L <start>` or `-L <start>,` spans \nfrom\n> -'<start>' to end of file. `-L ,<end>` spans from start of file to '<end>'.\n> +_<start>_ and _<end>_ are optional. `-L <start>` or `-L <start>,` spans \nfrom\n> +_<start>_ to end of file. `-L ,<end>` spans from start of file to _<end>_.\n>  +\n>  include::line-range-format.adoc[]\n> \n> --l::\n> +`-l`::\n>  \tShow long rev (Default: off).\n> \n> --t::\n> +`-t`::\n>  \tShow raw timestamp (Default: off).\n> \n> --S <revs-file>::\n> -\tUse revisions from revs-file instead of calling linkgit:git-rev-\nlist[1].\n> +`-S <revs-file>`::\n> +\tUse revisions from _revs-file_ instead of calling linkgit:git-rev-\nlist[1].\n\nPlaceholders keep their brackets: _<rev-file>_ in prose.\n\n> \n> ---reverse <rev>..<rev>::\n> +`--reverse <rev>..<rev>`::\n\nHere, I would differentiate the names of the two placeholders, <start>..<end> \nas used below.\n\n>  \tWalk history forward instead of backward. Instead of showing\n>  \tthe revision in which a line appeared, this shows the last\n>  \trevision in which a line has existed. This requires a range of\n> -\trevision like START..END where the path to blame exists in\n> -\tSTART.  `git blame --reverse START` is taken as `git blame\n> +\trevision like _START..END_ where the path to blame exists in\n> +\t_START_.  `git blame --reverse START` is taken as `git blame\n>  \t--reverse START..HEAD` for convenience.\n\nHere, let's transition to the <placeholder> format: <start>..<end> and so on.\n\n> \n> ---first-parent::\n> +`--first-parent`::\n>  \tFollow only the first parent commit upon seeing a merge\n>  \tcommit. This option can be used to determine when a line\n>  \twas introduced to a particular integration branch, rather\n>  \tthan when it was introduced to the history overall.\n> \n> --p::\n> ---porcelain::\n> +`-p`::\n> +`--porcelain`::\n>  \tShow in a format designed for machine consumption.\n> \n> ---line-porcelain::\n> +`--line-porcelain`::\n>  \tShow the porcelain format, but output commit information for\n>  \teach line, not just the first time a commit is referenced.\n> -\tImplies --porcelain.\n> +\tImplies `--porcelain`.\n> \n> ---incremental::\n> +`--incremental`::\n>  \tShow the result incrementally in a format designed for\n>  \tmachine consumption.\n> \n> ---encoding=<encoding>::\n> +`--encoding=<encoding>`::\n>  \tSpecifies the encoding used to output author names\n\nDuring the conversion, I take the opportunity to change also the mood of the \ndescription to imperative: \"Specify ...\"\n\n>  \tand commit summaries. Setting it to `none` makes blame\n>  \toutput unconverted data. For more information see the\n>  \tdiscussion about encoding in the linkgit:git-log[1]\n>  \tmanual page.\n> \n> ---contents <file>::\n> -\tAnnotate using the contents from the named file, starting from <rev>\n> -\tif it is specified, and HEAD otherwise. You may specify '-' to make\n> +`--contents <file>`::\n> +\tAnnotate using the contents from the named file, starting from \n_<rev>_\n\nHere, to lighten a bit the style and create visual internal references, we \ncould make a \"placeholder pun\":\n\nAnnotate using the contents from _<file>_, ...\n\n> +\tif it is specified, and `HEAD` otherwise. You may specify `-` to \nmake\n>  \tthe command read from the standard input for the file contents.\n> \n> ---date <format>::\n> -\tSpecifies the format used to output dates. If --date is not\n> -\tprovided, the value of the blame.date config variable is\n> -\tused. If the blame.date config variable is also not set, the\n> +`--date <format>`::\n> +\tSpecifies the format used to output dates. If `--date` is not\n\nImperative mood.\n\n> +\tprovided, the value of the `blame.date` config variable is\n> +\tused. If the `blame.date` config variable is also not set, the\n>  \tiso format is used. For supported values, see the discussion\n> -\tof the --date option at linkgit:git-log[1].\n> +\tof the `--date` option at linkgit:git-log[1].\n> \n> ---progress::\n> ---no-progress::\n> +`--progress`::\n> +`--no-progress`::\n>  \tProgress status is reported on the standard error stream\n>  \tby default when it is attached to a terminal. This flag\n>  \tenables progress reporting even if not attached to a\n>  \tterminal. Can't use `--progress` together with `--porcelain`\n>  \tor `--incremental`.\n\nHere maybe swap the first two sentences, remove the \"This flags\" and convert \nto imperative mood. The first sentence is a bit redundant.\n\nAs a general rule, I tend to reorder/reword the paragraph to describe the \neffect in the first sentence of the description with an imperative mood. \n\n> \n> --M[<num>]::\n> +`-M[<num>]`::\n>  \tDetect moved or copied lines within a file. When a commit\n>  \tmoves or copies a block of lines (e.g. the original file\n> -\thas A and then B, and the commit changes it to B and then\n> -\tA), the traditional 'blame' algorithm notices only half of\n> +\thas _A_ and then _B_, and the commit changes it to _B_ and then\n> +\t_A_), the traditional `blame` algorithm notices only half of\n>  \tthe movement and typically blames the lines that were moved\n> -\tup (i.e. B) to the parent and assigns blame to the lines that\n> -\twere moved down (i.e. A) to the child commit.  With this\n> +\tup (i.e. _B_) to the parent and assigns blame to the lines that\n> +\twere moved down (i.e. _A_) to the child commit.  With this\n>  \toption, both groups of lines are blamed on the parent by\n>  \trunning extra passes of inspection.\n>  +\n> -<num> is optional but it is the lower bound on the number of\n> +_<num>_ is optional, but it is the lower bound on the number of\n>  alphanumeric characters that Git must detect as moving/copying\n>  within a file for it to associate those lines with the parent\n>  commit. The default value is 20.\n> \n> --C[<num>]::\n> +`-C[<num>]`::\n>  \tIn addition to `-M`, detect lines moved or copied from other\n>  \tfiles that were modified in the same commit.  This is\n>  \tuseful when you reorganize your program and move code\n> @@ -109,14 +109,14 @@ commit. The default value is 20.\n>  \toption is given three times, the command additionally\n>  \tlooks for copies from other files in any commit.\n>  +\n> -<num> is optional but it is the lower bound on the number of\n> +_<num>_ is optional, but it is the lower bound on the number of\n>  alphanumeric characters that Git must detect as moving/copying\n>  between files for it to associate those lines with the parent\n>  commit. And the default value is 40. If there are more than one\n> -`-C` options given, the <num> argument of the last `-C` will\n> +`-C` options given, the _<num>_ argument of the last `-C` will\n>  take effect.\n> \n> ---ignore-rev <rev>::\n> +`--ignore-rev <rev>`::\n>  \tIgnore changes made by the revision when assigning blame, as if the\n>  \tchange never happened.  Lines that were changed or added by an \nignored\n>  \tcommit will be blamed on the previous commit that changed that line \nor\n> @@ -126,26 +126,26 @@ take effect.\n>  \tanother commit will be marked with a `?` in the blame output.  If \nthe\n>  \t`blame.markUnblamableLines` config option is set, then those lines \ntouched\n>  \tby an ignored commit that we could not attribute to another revision \nare\n> -\tmarked with a '*'. In the porcelain modes, we print 'ignored' and\n> -\t'unblamable' on a newline respectively.\n> +\tmarked with a `*`. In the porcelain modes, we print _ignored_ and\n> +\t_unblamable_ on a newline respectively.\n> \n\nIf the words are printed \"verbatim\", then the format is backticked: `ignored` \nand `unblamable`.\n\n\n> ---ignore-revs-file <file>::\n> -\tIgnore revisions listed in `file`, which must be in the same format \nas an\n> +`--ignore-revs-file <file>`::\n> +\tIgnore revisions listed in _<file>_, which must be in the same \nformat as an\n>  \t`fsck.skipList`.  This option may be repeated, and these files will \nbe\n>  \tprocessed after any files specified with the `blame.ignoreRevsFile` \nconfig\n>  \toption.  An empty file name, `\"\"`, will clear the list of revs from\n>  \tpreviously processed files.\n> \n> ---color-lines::\n> +`--color-lines`::\n>  \tColor line annotations in the default format differently if they \ncome from\n>  \tthe same commit as the preceding line. This makes it easier to \ndistinguish\n>  \tcode blocks introduced by different commits. The color defaults to \ncyan and\n>  \tcan be adjusted using the `color.blame.repeatedLines` config option.\n> \n> ---color-by-age::\n> +`--color-by-age`::\n>  \tColor line annotations depending on the age of the line in the \ndefault format.\n>  \tThe `color.blame.highlightRecent` config option controls what color \nis used for\n>  \teach range of age.\n> \n> --h::\n> +`-h`::\n>  \tShow help message.\n\nThis diff is quite large. If there are no other reasons to split the patch \naccording to some semantic reason, then please split file by file.\n\n\n> diff --git a/Documentation/git-blame.adoc b/Documentation/git-blame.adoc\n> index adcbb6f5dc..7dc93f90b2 100644\n> --- a/Documentation/git-blame.adoc\n> +++ b/Documentation/git-blame.adoc\n> @@ -7,12 +7,12 @@ git-blame - Show what revision and author last modified \neach line\n> of a file\n> \n>  SYNOPSIS\n>  --------\n> -[verse]\n> -'git blame' [-c] [-b] [-l] [--root] [-t] [-f] [-n] [-s] [-e] [-p] [-w]\n> [--incremental] -\t    [-L <range>] [-S <revs-file>] [-M] [-C] [-C] [-C]\n> [--since=<date>]\n> -\t    [--ignore-rev <rev>] [--ignore-revs-file <file>]\n> -\t    [--color-lines] [--color-by-age] [--progress] [--abbrev=<n>]\n> -\t    [ --contents <file> ] [<rev> | --reverse <rev>..<rev>] [--] \n<file>\n> +[synopsis]\n> +git blame [-c] [-b] [-l] [--root] [-t] [-f] [-n] [-s] [-e] [-p] [-w]\n> [--incremental] +\t  [-L <range>] [-S <revs-file>] [-M] [-C] [-C] [-C]\n> [--since=<date>]\n> +\t  [--ignore-rev <rev>] [--ignore-revs-file <file>]\n> +\t  [--color-lines] [--color-by-age] [--progress] [--abbrev=<n>]\n> +\t  [ --contents <file> ] [<rev> | --reverse <rev>..<rev>] [--] <file>\n> \n>  DESCRIPTION\n>  -----------\n> @@ -30,7 +30,7 @@ lines that were copied and pasted from another file, etc., \nsee\n> the `-C` and `-M` options.\n> \n>  The report does not tell you anything about lines which have been deleted \nor\n> -replaced; you need to use a tool such as 'git diff' or the \"pickaxe\"\n> +replaced; you need to use a tool such as `git diff` or the \"pickaxe\"\n>  interface briefly mentioned in the following paragraph.\n> \n>  Apart from supporting file annotation, Git also supports searching the\n> @@ -50,47 +50,47 @@ OPTIONS\n>  -------\n>  include::blame-options.adoc[]\n> \n> --c::\n> +`-c`::\n>  \tUse the same output mode as linkgit:git-annotate[1] (Default: off).\n> \n> ---score-debug::\n> +`--score-debug`::\n>  \tInclude debugging information related to the movement of\n>  \tlines between files (see `-C`) and lines moved within a\n>  \tfile (see `-M`).  The first number listed is the score.\n>  \tThis is the number of alphanumeric characters detected\n>  \tas having been moved between or within files.  This must be above\n> -\ta certain threshold for 'git blame' to consider those lines\n> +\ta certain threshold for `git blame` to consider those lines\n>  \tof code to have been moved.\n> \n> --f::\n> ---show-name::\n> +`-f`::\n> +`--show-name`::\n>  \tShow the filename in the original commit.  By default\n>  \tthe filename is shown if there is any line that came from a\n>  \tfile with a different name, due to rename detection.\n> \n> --n::\n> ---show-number::\n> +`-n`::\n> +`--show-number`::\n>  \tShow the line number in the original commit (Default: off).\n> \n> --s::\n> +`-s`::\n>  \tSuppress the author name and timestamp from the output.\n> \n> --e::\n> ---show-email::\n> +`-e`::\n> +`--show-email`::\n>  \tShow the author email instead of the author name (Default: off).\n>  \tThis can also be controlled via the `blame.showEmail` config\n>  \toption.\n> \n> --w::\n> +`-w`::\n>  \tIgnore whitespace when comparing the parent's version and\n>  \tthe child's to find where the lines came from.\n> \n>  include::diff-algorithm-option.adoc[]\n> \n> ---abbrev=<n>::\n> -\tInstead of using the default 7+1 hexadecimal digits as the\n> -\tabbreviated object name, use <m>+1 digits, where <m> is at\n> -\tleast <n> but ensures the commit object names are unique.\n> +`--abbrev=<n>`::\n> +\tInstead of using the default _7+1_ hexadecimal digits as the\n> +\tabbreviated object name, use _<m>+1_ digits, where _<m>_ is at\n> +\tleast _<n>_ but ensures the commit object names are unique.\n>  \tNote that 1 column\n>  \tis used for a caret to mark the boundary commit.\n> \n> @@ -124,21 +124,21 @@ header at the minimum has the first line which has:\n>  This header line is followed by the following information\n>  at least once for each commit:\n> \n> -- the author name (\"author\"), email (\"author-mail\"), time\n> -  (\"author-time\"), and time zone (\"author-tz\"); similarly\n> +- the author name (`author`), email (`author-mail`), time\n> +  (`author-time`), and time zone (`author-tz`); similarly\n>    for committer.\n>  - the filename in the commit that the line is attributed to.\n> -- the first line of the commit log message (\"summary\").\n> +- the first line of the commit log message (`summary`).\n> \n>  The contents of the actual line are output after the above\n> -header, prefixed by a TAB. This is to allow adding more\n> +header, prefixed by a _TAB_. This is to allow adding more\n>  header elements later.\n> \n>  The porcelain format generally suppresses commit information that has\n>  already been seen. For example, two lines that are blamed to the same\n>  commit will both be shown, but the details for that commit will be shown\n>  only once. Information which is specific to individual lines will not be\n> -grouped together, like revs to be marked 'ignored' or 'unblamable'. This\n> +grouped together, like revs to be marked _ignored_ or _unblamable_. This\n\nHere, I would backtick instead.\n\n>  is more efficient, but may require more state be kept by the reader. The\n>  `--line-porcelain` option can be used to output full commit information\n>  for each line, allowing simpler (but less efficient) usage like:\n> @@ -152,7 +152,7 @@ for each line, allowing simpler (but less efficient) \nusage\n> like: SPECIFYING RANGES\n>  -----------------\n> \n> -Unlike 'git blame' and 'git annotate' in older versions of git, the extent\n> +Unlike `git blame` and `git annotate` in older versions of git, the extent\n>  of the annotation can be limited to both line ranges and revision\n>  ranges. The `-L` option, which limits annotation to a range of lines, may \nbe\n>  specified multiple times.\n> @@ -173,7 +173,7 @@ which limits the annotation to the body of the `hello`\n> subroutine.\n> \n>  When you are not interested in changes older than version\n>  v2.6.18, or changes older than 3 weeks, you can use revision\n> -range specifiers similar to 'git rev-list':\n> +range specifiers similar to `git rev-list`:\n> \n>  \tgit blame v2.6.18.. -- foo\n>  \tgit blame --since=3.weeks -- foo\n> @@ -232,7 +232,7 @@ parser (which should be quite natural for most scripting\n\nI noted in the section \"INCREMENTAL OUTPUT\" that there are some descriptions \nof line output that adhere to the synopsis style. In such case, we can apply \nthe style for better uniformity:\n\ndiff --git a/Documentation/git-blame.adoc b/Documentation/git-blame.adoc\nindex adcbb6f5dc..390c3d1361 100644\n--- a/Documentation/git-blame.adoc\n+++ b/Documentation/git-blame.adoc\n@@ -212,8 +212,9 @@ does not contain the actual lines from the file that is \nbeing\n annotated.\n \n . Each blame entry always starts with a line of:\n-\n-       <40-byte-hex-sha1> <sourceline> <resultline> <num-lines>\n++\n+[synopsis]\n+<40-byte-hex-sha1> <sourceline> <resultline> <num-lines>\n +\n Line numbers count from 1.\n \n@@ -224,8 +225,9 @@ Line numbers count from 1.\n \n . Unlike the Porcelain format, the filename information is always\n   given and terminates the entry:\n-\n-       \"filename\" <whitespace-quoted-filename-goes-here>\n++\n+[synopsis]\n+filename <whitespace-quoted-filename-goes-here>\n +\n and thus it is really quite easy to parse for some line- and word-oriented\n parser (which should be quite natural for most scripting languages).\n\n\n\n\n> languages). +\n>  [NOTE]\n>  For people who do parsing: to make it more robust, just ignore any\n> -lines between the first and last one (\"<sha1>\" and \"filename\" lines)\n> +lines between the first and last one (_<sha1>_ and _filename_ lines)\n\n_<sha1> does not appear anywhere; I guess they referred to _<40-byte-hex-\nsha1>_\nfilename is a keyword which appears in the line above: `filename`\n\n>  where you do not recognize the tag words (or care about that particular\n>  one) at the beginning of the \"extended information\" lines. That way, if\n>  there is ever added information (like the commit encoding or extended\n\nThat's very good for a first try. Now, I hope that you will be ok to review my \npatches :-)\n\nJN\n\n\n"},{"id":"533162","messageId":"9123496.T7Z3S40VBb@debian-mbp","threadId":"64732","inReplyTo":"7894506.EvYhyI6sBW@piment-oiseau","subject":"Re: [PATCH] doc: git-blame: convert blame to new doc format","fromName":"Michael Lyons","fromEmail":"git@michael.lyo.nz","sentAt":"2026-01-06T21:16:02Z","receivedAt":"2026-01-06T21:16:09Z","isPatch":true,"sender":{"key":"git@michael.lyo.nz","avatar":null},"body":"On Tuesday, January 6, 2026 1:57:27 PM Eastern Standard Time you wrote:\n> Thanks for helping out.\n\nGlad to!\n\n> > --L <start>,<end>::\n> > --L :<funcname>::\n> > -\tAnnotate only the line range given by '<start>,<end>',\n> > -\tor by the function name regex '<funcname>'.\n> > +`-L <start>,<end>`::\n> > +`-L :<funcname>`::\n> > +\tAnnotate only the line range given by _<start>,<end>_,\n> \n> It would be better to use backticks, so that the comma is formatted as a\n> keyword: `<start>,<end>`\n\nOkay. I changed them back and forth a couple times before the first submission. \nI have a question about this further down...\n\n> > \n> > --S <revs-file>::\n> > -\tUse revisions from revs-file instead of calling linkgit:git-rev-\n> > +`-S <revs-file>`::\n> > +\tUse revisions from _revs-file_ instead of calling linkgit:git-rev-\n> \n> Placeholders keep their brackets: _<rev-file>_ in prose.\n\nSmart.\n\n> > ---reverse <rev>..<rev>::\n> > +`--reverse <rev>..<rev>`::\n> Here, I would differentiate the names of the two placeholders,\n> <start>..<end> as used below.\n> \n> >  \tWalk history forward instead of backward. Instead of showing\n> >  \tthe revision in which a line appeared, this shows the last\n> >  \trevision in which a line has existed. This requires a range of\n> > \n> > -\trevision like START..END where the path to blame exists in\n> > -\tSTART.  `git blame --reverse START` is taken as `git blame\n> > +\trevision like _START..END_ where the path to blame exists in\n> > +\t_START_.  `git blame --reverse START` is taken as `git blame\n> > \n> >  \t--reverse START..HEAD` for convenience.\n> \n> Here, let's transition to the <placeholder> format: <start>..<end> and so\n> on.\n\nThis is the continuation of my question on `<start>,<end>`: Do these also go \nto backticks or keep the underscores? My impulse is backticks, but let me \nknow: `<start>..<end>` or _<start>..<end>_?\n\nThe start/end change from rev/rev makes sense.\n\n> > ---progress::\n> > ---no-progress::\n> > +`--progress`::\n> > \n> > +`--no-progress`::\n> >  \tProgress status is reported on the standard error stream\n> >  \tby default when it is attached to a terminal. This flag\n> >  \tenables progress reporting even if not attached to a\n> >  \tterminal. Can't use `--progress` together with `--porcelain`\n> >  \tor `--incremental`.\n> \n> Here maybe swap the first two sentences, remove the \"This flags\" and convert\n> to imperative mood. The first sentence is a bit redundant.\n> \n> As a general rule, I tend to reorder/reword the paragraph to describe the\n> effect in the first sentence of the description with an imperative mood.\n\nNew commit will reword a couple things here. Fingers crossed. :)\n\n> > -\tmarked with a '*'. In the porcelain modes, we print 'ignored' and\n> > -\t'unblamable' on a newline respectively.\n> > +\tmarked with a `*`. In the porcelain modes, we print _ignored_ and\n> > +\t_unblamable_ on a newline respectively.\n> \n> If the words are printed \"verbatim\", then the format is backticked:\n> `ignored` and `unblamable`.\n\nAnother one where I had backticks originally and switched them. I'm not super-\nfamiliar with the porcelain parts.\n\n> This diff is quite large. If there are no other reasons to split the patch\n> according to some semantic reason, then please split file by file.\n\nOkay. Next try will just be blame-options for now.\n\n> \n> That's very good for a first try. Now, I hope that you will be ok to review\n> my patches :-)\n\nThat's very kind. I'll probably need a couple more rounds before my changes \npass inspection, let alone be declared competent to review yours. :)\n\nFor the purposes of re-submission, should I be doing something with scissors \non this thread, or make a new thread?\n\nThanks again for the help!\nML\n\n\n"},{"id":"533239","messageId":"2395053.ElGaqSPkdT@piment-oiseau","threadId":"64732","inReplyTo":"9123496.T7Z3S40VBb@debian-mbp","subject":"Re: [PATCH] doc: git-blame: convert blame to new doc format","fromName":"Jean-Noël AVILA","fromEmail":"jn.avila@free.fr","sentAt":"2026-01-07T18:44:51Z","receivedAt":"2026-01-07T18:45:03Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"On Tuesday, 6 January 2026 22:16:02 CET Michael Lyons wrote:\n> > Here, let's transition to the <placeholder> format: <start>..<end> and so\n> > on.\n> \n> This is the continuation of my question on `<start>,<end>`: Do these also go\n> to backticks or keep the underscores? My impulse is backticks, but let me\n> know: `<start>..<end>` or _<start>..<end>_?\n> \n> The start/end change from rev/rev makes sense.\n\n\nDefinitely backticks here, because this is a complex synopsis span.\n\n\n> \n> > > -\tmarked with a '*'. In the porcelain modes, we print 'ignored' and\n> > > -\t'unblamable' on a newline respectively.\n> > > +\tmarked with a `*`. In the porcelain modes, we print _ignored_ and\n> > > +\t_unblamable_ on a newline respectively.\n> > \n> > If the words are printed \"verbatim\", then the format is backticked:\n> > `ignored` and `unblamable`.\n> \n> Another one where I had backticks originally and switched them. I'm not \nsuper-\n> familiar with the porcelain parts.\n> \n> > This diff is quite large. If there are no other reasons to split the patch\n> > according to some semantic reason, then please split file by file.\n> \n> Okay. Next try will just be blame-options for now.\n\nYou can push two commits in this series.\n\n> \n> > That's very good for a first try. Now, I hope that you will be ok to \nreview\n> > my patches :-)\n> \n> That's very kind. I'll probably need a couple more rounds before my changes\n> pass inspection, let alone be declared competent to review yours. :)\n> \n> For the purposes of re-submission, should I be doing something with scissors\n> on this thread, or make a new thread?\n\nUsually, the reworked series is pushed with v2 as reply to the first mail of \nthe first submission, using for instance:\n\ngit send-email '--in-reply-to=<20260105230220.519303-1-git@michael.lyo.nz>' \nv2-*.patch\n\nJN\n\n\n"},{"id":"533286","messageId":"20260108153039.658217-1-git@michael.lyo.nz","threadId":"64732","inReplyTo":"20260105230220.519303-1-git@michael.lyo.nz","subject":"[PATCH v2 0/2] doc: git-blame: convert blame to new doc format","fromName":"Michael Lyons","fromEmail":"git@michael.lyo.nz","sentAt":"2026-01-08T15:30:19Z","receivedAt":"2026-01-08T15:30:59Z","isPatch":true,"sender":{"key":"git@michael.lyo.nz","avatar":null},"body":"Split and updated with JN's suggestions.\n\nI tweaked the `--progress` documentation a bit more than requested. It was\nhard to write grammatical English that didn't imply something incorrect.\n\nMichael Lyons (2):\n  doc: blame-options: convert to new doc format\n  doc: git-blame: convert to new doc format\n\n Documentation/blame-options.adoc | 120 +++++++++++++++----------------\n Documentation/git-blame.adoc     |  72 ++++++++++---------\n 2 files changed, 97 insertions(+), 95 deletions(-)\n\n-- \n2.47.3\n\n"},{"id":"533287","messageId":"20260108153039.658217-2-git@michael.lyo.nz","threadId":"64732","inReplyTo":"20260108153039.658217-1-git@michael.lyo.nz","subject":"[PATCH v2 1/2] doc: blame-options: convert to new doc format","fromName":"Michael Lyons","fromEmail":"git@michael.lyo.nz","sentAt":"2026-01-08T15:30:20Z","receivedAt":"2026-01-08T15:31:01Z","isPatch":true,"sender":{"key":"git@michael.lyo.nz","avatar":null},"body":"- Use _<placeholder>_ instead of <placeholder> in the description\n- Modify some samples to use <placeholders>\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: Michael Lyons <git@michael.lyo.nz>\n---\n Documentation/blame-options.adoc | 120 +++++++++++++++----------------\n 1 file changed, 60 insertions(+), 60 deletions(-)\n\ndiff --git a/Documentation/blame-options.adoc b/Documentation/blame-options.adoc\nindex 1fb948fc76..1ae1222b6b 100644\n--- a/Documentation/blame-options.adoc\n+++ b/Documentation/blame-options.adoc\n@@ -1,105 +1,105 @@\n--b::\n+`-b`::\n \tShow blank SHA-1 for boundary commits.  This can also\n \tbe controlled via the `blame.blankBoundary` config option.\n \n---root::\n+`--root`::\n \tDo not treat root commits as boundaries.  This can also be\n \tcontrolled via the `blame.showRoot` config option.\n \n---show-stats::\n+`--show-stats`::\n \tInclude additional statistics at the end of blame output.\n \n--L <start>,<end>::\n--L :<funcname>::\n-\tAnnotate only the line range given by '<start>,<end>',\n-\tor by the function name regex '<funcname>'.\n+`-L <start>,<end>`::\n+`-L :<funcname>`::\n+\tAnnotate only the line range given by `<start>,<end>`,\n+\tor by the function name regex _<funcname>_.\n \tMay be specified multiple times. Overlapping ranges are allowed.\n +\n-'<start>' and '<end>' are optional. `-L <start>` or `-L <start>,` spans from\n-'<start>' to end of file. `-L ,<end>` spans from start of file to '<end>'.\n+_<start>_ and _<end>_ are optional. `-L <start>` or `-L <start>,` spans from\n+_<start>_ to end of file. `-L ,<end>` spans from start of file to _<end>_.\n +\n include::line-range-format.adoc[]\n \n--l::\n+`-l`::\n \tShow long rev (Default: off).\n \n--t::\n+`-t`::\n \tShow raw timestamp (Default: off).\n \n--S <revs-file>::\n-\tUse revisions from revs-file instead of calling linkgit:git-rev-list[1].\n+`-S <revs-file>`::\n+\tUse revisions from _<revs-file>_ instead of calling\n+\tlinkgit:git-rev-list[1].\n \n---reverse <rev>..<rev>::\n+`--reverse <start>..<end>`::\n \tWalk history forward instead of backward. Instead of showing\n \tthe revision in which a line appeared, this shows the last\n \trevision in which a line has existed. This requires a range of\n-\trevision like START..END where the path to blame exists in\n-\tSTART.  `git blame --reverse START` is taken as `git blame\n-\t--reverse START..HEAD` for convenience.\n+\trevision like `<start>..<end>` where the path to blame exists in\n+\t_<start>_.  `git blame --reverse <start>` is taken as `git blame\n+\t--reverse <start>..HEAD` for convenience.\n \n---first-parent::\n+`--first-parent`::\n \tFollow only the first parent commit upon seeing a merge\n \tcommit. This option can be used to determine when a line\n \twas introduced to a particular integration branch, rather\n \tthan when it was introduced to the history overall.\n \n--p::\n---porcelain::\n+`-p`::\n+`--porcelain`::\n \tShow in a format designed for machine consumption.\n \n---line-porcelain::\n+`--line-porcelain`::\n \tShow the porcelain format, but output commit information for\n \teach line, not just the first time a commit is referenced.\n-\tImplies --porcelain.\n+\tImplies `--porcelain`.\n \n---incremental::\n+`--incremental`::\n \tShow the result incrementally in a format designed for\n \tmachine consumption.\n \n---encoding=<encoding>::\n-\tSpecifies the encoding used to output author names\n+`--encoding=<encoding>`::\n+\tSpecify the encoding used to output author names\n \tand commit summaries. Setting it to `none` makes blame\n \toutput unconverted data. For more information see the\n \tdiscussion about encoding in the linkgit:git-log[1]\n \tmanual page.\n \n---contents <file>::\n-\tAnnotate using the contents from the named file, starting from <rev>\n-\tif it is specified, and HEAD otherwise. You may specify '-' to make\n+`--contents <file>`::\n+\tAnnotate using the contents from _<file>_, starting from _<rev>_\n+\tif it is specified, and `HEAD` otherwise. You may specify `-` to make\n \tthe command read from the standard input for the file contents.\n \n---date <format>::\n-\tSpecifies the format used to output dates. If --date is not\n-\tprovided, the value of the blame.date config variable is\n-\tused. If the blame.date config variable is also not set, the\n+`--date <format>`::\n+\tSpecify the format used to output dates. If `--date` is not\n+\tprovided, the value of the `blame.date` config variable is\n+\tused. If the `blame.date` config variable is also not set, the\n \tiso format is used. For supported values, see the discussion\n-\tof the --date option at linkgit:git-log[1].\n+\tof the `--date` option at linkgit:git-log[1].\n \n---progress::\n---no-progress::\n-\tProgress status is reported on the standard error stream\n-\tby default when it is attached to a terminal. This flag\n-\tenables progress reporting even if not attached to a\n-\tterminal. Can't use `--progress` together with `--porcelain`\n-\tor `--incremental`.\n+`--progress`::\n+`--no-progress`::\n+\tEnable progress reporting on the standard error stream even if\n+\tnot attached to a terminal. By default, progress status is\n+\treported only when it is attached. You can't use `--progress`\n+\ttogether with `--porcelain` or `--incremental`.\n \n--M[<num>]::\n+`-M[<num>]`::\n \tDetect moved or copied lines within a file. When a commit\n \tmoves or copies a block of lines (e.g. the original file\n-\thas A and then B, and the commit changes it to B and then\n-\tA), the traditional 'blame' algorithm notices only half of\n+\thas _A_ and then _B_, and the commit changes it to _B_ and then\n+\t_A_), the traditional `blame` algorithm notices only half of\n \tthe movement and typically blames the lines that were moved\n-\tup (i.e. B) to the parent and assigns blame to the lines that\n-\twere moved down (i.e. A) to the child commit.  With this\n+\tup (i.e. _B_) to the parent and assigns blame to the lines that\n+\twere moved down (i.e. _A_) to the child commit.  With this\n \toption, both groups of lines are blamed on the parent by\n \trunning extra passes of inspection.\n +\n-<num> is optional but it is the lower bound on the number of\n+_<num>_ is optional, but it is the lower bound on the number of\n alphanumeric characters that Git must detect as moving/copying\n within a file for it to associate those lines with the parent\n commit. The default value is 20.\n \n--C[<num>]::\n+`-C[<num>]`::\n \tIn addition to `-M`, detect lines moved or copied from other\n \tfiles that were modified in the same commit.  This is\n \tuseful when you reorganize your program and move code\n@@ -109,14 +109,14 @@ commit. The default value is 20.\n \toption is given three times, the command additionally\n \tlooks for copies from other files in any commit.\n +\n-<num> is optional but it is the lower bound on the number of\n+_<num>_ is optional, but it is the lower bound on the number of\n alphanumeric characters that Git must detect as moving/copying\n between files for it to associate those lines with the parent\n commit. And the default value is 40. If there are more than one\n-`-C` options given, the <num> argument of the last `-C` will\n+`-C` options given, the _<num>_ argument of the last `-C` will\n take effect.\n \n---ignore-rev <rev>::\n+`--ignore-rev <rev>`::\n \tIgnore changes made by the revision when assigning blame, as if the\n \tchange never happened.  Lines that were changed or added by an ignored\n \tcommit will be blamed on the previous commit that changed that line or\n@@ -126,26 +126,26 @@ take effect.\n \tanother commit will be marked with a `?` in the blame output.  If the\n \t`blame.markUnblamableLines` config option is set, then those lines touched\n \tby an ignored commit that we could not attribute to another revision are\n-\tmarked with a '*'. In the porcelain modes, we print 'ignored' and\n-\t'unblamable' on a newline respectively.\n+\tmarked with a `*`. In the porcelain modes, we print `ignored` and\n+\t`unblamable` on a newline respectively.\n \n---ignore-revs-file <file>::\n-\tIgnore revisions listed in `file`, which must be in the same format as an\n+`--ignore-revs-file <file>`::\n+\tIgnore revisions listed in _<file>_, which must be in the same format as an\n \t`fsck.skipList`.  This option may be repeated, and these files will be\n \tprocessed after any files specified with the `blame.ignoreRevsFile` config\n \toption.  An empty file name, `\"\"`, will clear the list of revs from\n \tpreviously processed files.\n \n---color-lines::\n+`--color-lines`::\n \tColor line annotations in the default format differently if they come from\n \tthe same commit as the preceding line. This makes it easier to distinguish\n \tcode blocks introduced by different commits. The color defaults to cyan and\n \tcan be adjusted using the `color.blame.repeatedLines` config option.\n \n---color-by-age::\n-\tColor line annotations depending on the age of the line in the default format.\n-\tThe `color.blame.highlightRecent` config option controls what color is used for\n-\teach range of age.\n+`--color-by-age`::\n+\tColor line annotations depending on the age of the line in\n+\tthe default format.  The `color.blame.highlightRecent` config\n+\toption controls what color is used for each range of age.\n \n--h::\n+`-h`::\n \tShow help message.\n-- \n2.47.3\n\n"},{"id":"533288","messageId":"20260108153039.658217-3-git@michael.lyo.nz","threadId":"64732","inReplyTo":"20260108153039.658217-1-git@michael.lyo.nz","subject":"[PATCH v2 2/2] doc: git-blame: convert to new doc format","fromName":"Michael Lyons","fromEmail":"git@michael.lyo.nz","sentAt":"2026-01-08T15:30:21Z","receivedAt":"2026-01-08T15:31:01Z","isPatch":true,"sender":{"key":"git@michael.lyo.nz","avatar":null},"body":"- Use _<placeholder>_ instead of <placeholder> in the description\n- Use _underscores_ around math associated with <placeholders>\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: Michael Lyons <git@michael.lyo.nz>\n---\n Documentation/git-blame.adoc | 72 ++++++++++++++++++------------------\n 1 file changed, 37 insertions(+), 35 deletions(-)\n\ndiff --git a/Documentation/git-blame.adoc b/Documentation/git-blame.adoc\nindex adcbb6f5dc..8808009e87 100644\n--- a/Documentation/git-blame.adoc\n+++ b/Documentation/git-blame.adoc\n@@ -7,12 +7,12 @@ git-blame - Show what revision and author last modified each line of a file\n \n SYNOPSIS\n --------\n-[verse]\n-'git blame' [-c] [-b] [-l] [--root] [-t] [-f] [-n] [-s] [-e] [-p] [-w] [--incremental]\n-\t    [-L <range>] [-S <revs-file>] [-M] [-C] [-C] [-C] [--since=<date>]\n-\t    [--ignore-rev <rev>] [--ignore-revs-file <file>]\n-\t    [--color-lines] [--color-by-age] [--progress] [--abbrev=<n>]\n-\t    [ --contents <file> ] [<rev> | --reverse <rev>..<rev>] [--] <file>\n+[synopsis]\n+git blame [-c] [-b] [-l] [--root] [-t] [-f] [-n] [-s] [-e] [-p] [-w] [--incremental]\n+\t  [-L <range>] [-S <revs-file>] [-M] [-C] [-C] [-C] [--since=<date>]\n+\t  [--ignore-rev <rev>] [--ignore-revs-file <file>]\n+\t  [--color-lines] [--color-by-age] [--progress] [--abbrev=<n>]\n+\t  [ --contents <file> ] [<rev> | --reverse <rev>..<rev>] [--] <file>\n \n DESCRIPTION\n -----------\n@@ -30,7 +30,7 @@ lines that were copied and pasted from another file, etc., see the\n `-C` and `-M` options.\n \n The report does not tell you anything about lines which have been deleted or\n-replaced; you need to use a tool such as 'git diff' or the \"pickaxe\"\n+replaced; you need to use a tool such as `git diff` or the \"pickaxe\"\n interface briefly mentioned in the following paragraph.\n \n Apart from supporting file annotation, Git also supports searching the\n@@ -50,47 +50,47 @@ OPTIONS\n -------\n include::blame-options.adoc[]\n \n--c::\n+`-c`::\n \tUse the same output mode as linkgit:git-annotate[1] (Default: off).\n \n---score-debug::\n+`--score-debug`::\n \tInclude debugging information related to the movement of\n \tlines between files (see `-C`) and lines moved within a\n \tfile (see `-M`).  The first number listed is the score.\n \tThis is the number of alphanumeric characters detected\n \tas having been moved between or within files.  This must be above\n-\ta certain threshold for 'git blame' to consider those lines\n+\ta certain threshold for `git blame` to consider those lines\n \tof code to have been moved.\n \n--f::\n---show-name::\n+`-f`::\n+`--show-name`::\n \tShow the filename in the original commit.  By default\n \tthe filename is shown if there is any line that came from a\n \tfile with a different name, due to rename detection.\n \n--n::\n---show-number::\n+`-n`::\n+`--show-number`::\n \tShow the line number in the original commit (Default: off).\n \n--s::\n+`-s`::\n \tSuppress the author name and timestamp from the output.\n \n--e::\n---show-email::\n+`-e`::\n+`--show-email`::\n \tShow the author email instead of the author name (Default: off).\n \tThis can also be controlled via the `blame.showEmail` config\n \toption.\n \n--w::\n+`-w`::\n \tIgnore whitespace when comparing the parent's version and\n \tthe child's to find where the lines came from.\n \n include::diff-algorithm-option.adoc[]\n \n---abbrev=<n>::\n-\tInstead of using the default 7+1 hexadecimal digits as the\n-\tabbreviated object name, use <m>+1 digits, where <m> is at\n-\tleast <n> but ensures the commit object names are unique.\n+`--abbrev=<n>`::\n+\tInstead of using the default _7+1_ hexadecimal digits as the\n+\tabbreviated object name, use _<m>+1_ digits, where _<m>_ is at\n+\tleast _<n>_ but ensures the commit object names are unique.\n \tNote that 1 column\n \tis used for a caret to mark the boundary commit.\n \n@@ -124,21 +124,21 @@ header at the minimum has the first line which has:\n This header line is followed by the following information\n at least once for each commit:\n \n-- the author name (\"author\"), email (\"author-mail\"), time\n-  (\"author-time\"), and time zone (\"author-tz\"); similarly\n+- the author name (`author`), email (`author-mail`), time\n+  (`author-time`), and time zone (`author-tz`); similarly\n   for committer.\n - the filename in the commit that the line is attributed to.\n-- the first line of the commit log message (\"summary\").\n+- the first line of the commit log message (`summary`).\n \n The contents of the actual line are output after the above\n-header, prefixed by a TAB. This is to allow adding more\n+header, prefixed by a _TAB_. This is to allow adding more\n header elements later.\n \n The porcelain format generally suppresses commit information that has\n already been seen. For example, two lines that are blamed to the same\n commit will both be shown, but the details for that commit will be shown\n only once. Information which is specific to individual lines will not be\n-grouped together, like revs to be marked 'ignored' or 'unblamable'. This\n+grouped together, like revs to be marked `ignored` or `unblamable`. This\n is more efficient, but may require more state be kept by the reader. The\n `--line-porcelain` option can be used to output full commit information\n for each line, allowing simpler (but less efficient) usage like:\n@@ -152,7 +152,7 @@ for each line, allowing simpler (but less efficient) usage like:\n SPECIFYING RANGES\n -----------------\n \n-Unlike 'git blame' and 'git annotate' in older versions of git, the extent\n+Unlike `git blame` and `git annotate` in older versions of git, the extent\n of the annotation can be limited to both line ranges and revision\n ranges. The `-L` option, which limits annotation to a range of lines, may be\n specified multiple times.\n@@ -173,7 +173,7 @@ which limits the annotation to the body of the `hello` subroutine.\n \n When you are not interested in changes older than version\n v2.6.18, or changes older than 3 weeks, you can use revision\n-range specifiers similar to 'git rev-list':\n+range specifiers similar to `git rev-list`:\n \n \tgit blame v2.6.18.. -- foo\n \tgit blame --since=3.weeks -- foo\n@@ -212,8 +212,9 @@ does not contain the actual lines from the file that is being\n annotated.\n \n . Each blame entry always starts with a line of:\n-\n-\t<40-byte-hex-sha1> <sourceline> <resultline> <num-lines>\n++\n+[synopsis]\n+<40-byte-hex-sha1> <sourceline> <resultline> <num-lines>\n +\n Line numbers count from 1.\n \n@@ -224,16 +225,17 @@ Line numbers count from 1.\n \n . Unlike the Porcelain format, the filename information is always\n   given and terminates the entry:\n-\n-\t\"filename\" <whitespace-quoted-filename-goes-here>\n++\n+[synopsis]\n+filename <whitespace-quoted-filename-goes-here>\n +\n and thus it is really quite easy to parse for some line- and word-oriented\n parser (which should be quite natural for most scripting languages).\n +\n [NOTE]\n For people who do parsing: to make it more robust, just ignore any\n-lines between the first and last one (\"<sha1>\" and \"filename\" lines)\n-where you do not recognize the tag words (or care about that particular\n+lines between the first and last one (_<40-byte-hex-sha1>_ and `filename`\n+lines) where you do not recognize the tag words (or care about that particular\n one) at the beginning of the \"extended information\" lines. That way, if\n there is ever added information (like the commit encoding or extended\n commit commentary), a blame viewer will not care.\n-- \n2.47.3\n\n"},{"id":"533302","messageId":"2813520.mvXUDI8C0e@piment-oiseau","threadId":"64732","inReplyTo":"20260108153039.658217-1-git@michael.lyo.nz","subject":"Re: [PATCH v2 0/2] doc: git-blame: convert blame to new doc format","fromName":"Jean-Noël AVILA","fromEmail":"jn.avila@free.fr","sentAt":"2026-01-08T18:24:21Z","receivedAt":"2026-01-08T18:24:30Z","isPatch":true,"sender":{"key":"jn.avila@free.fr","avatar":"https://avatars.githubusercontent.com/u/156172?v=4"},"body":"On Thursday, 8 January 2026 16:30:19 CET Michael Lyons wrote:\n> Split and updated with JN's suggestions.\n> \n> I tweaked the `--progress` documentation a bit more than requested. It was\n> hard to write grammatical English that didn't imply something incorrect.\n> \n> Michael Lyons (2):\n>   doc: blame-options: convert to new doc format\n>   doc: git-blame: convert to new doc format\n> \n>  Documentation/blame-options.adoc | 120 +++++++++++++++----------------\n>  Documentation/git-blame.adoc     |  72 ++++++++++---------\n>  2 files changed, 97 insertions(+), 95 deletions(-)\n\nLGTM\n\nThanks!\n\n\n"},{"id":"533535","messageId":"xmqq1pjwqa79.fsf@gitster.g","threadId":"64732","inReplyTo":"2813520.mvXUDI8C0e@piment-oiseau","subject":"Re: [PATCH v2 0/2] doc: git-blame: convert blame to new doc format","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2026-01-11T18:24:26Z","receivedAt":"2026-01-11T18:24:28Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Jean-Noël AVILA <jn.avila@free.fr> writes:\n\n> On Thursday, 8 January 2026 16:30:19 CET Michael Lyons wrote:\n>> Split and updated with JN's suggestions.\n>> \n>> I tweaked the `--progress` documentation a bit more than requested. It was\n>> hard to write grammatical English that didn't imply something incorrect.\n>> \n>> Michael Lyons (2):\n>>   doc: blame-options: convert to new doc format\n>>   doc: git-blame: convert to new doc format\n>> \n>>  Documentation/blame-options.adoc | 120 +++++++++++++++----------------\n>>  Documentation/git-blame.adoc     |  72 ++++++++++---------\n>>  2 files changed, 97 insertions(+), 95 deletions(-)\n>\n> LGTM\n>\n> Thanks!\n\nThanks, both.\n"}]}