doc: convert another batch of files to synopsis style
cover doc: convert another batch of files to synopsis style
This time, 4 new conversions:
* git-grep
* git-am
* git-apply
* git-imap-send
This batch was an opportunity to test AI-helped conversion.
Jean-Noël Avila (5):
doc: convert git-bisect to synopsis style
doc: convert git-grep synopsis and options to new style
doc: convert git-am synopsis and options to new style
doc: convert git-apply synopsis and options to new style
doc: convert git-imap-send synopsis and options to new style
Documentation/asciidoc.conf.in | 6 + Documentation/config/am.adoc | 6 +- Documentation/config/apply.adoc | 17 +- Documentation/config/grep.adoc | 36 ++-- Documentation/config/imap.adoc | 30 +-- Documentation/format-patch-caveats.adoc | 2 +- .../format-patch-end-of-commit-message.adoc | 4 +- Documentation/git-am.adoc | 132 ++++++------ Documentation/git-apply.adoc | 125 +++++------ Documentation/git-bisect.adoc | 80 +++---- Documentation/git-grep.adoc | 196 +++++++++--------- Documentation/git-imap-send.adoc | 24 +-- 12 files changed, 337 insertions(+), 321 deletions(-)
base-commit: 59ff4886a579f4bc91e976fe18590b9ae02c7a08
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-2117%2Fjnavila%2Fbisect-synopsis-style-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-2117/jnavila/bisect-synopsis-style-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/2117
Signature · 1 line
gitgitgadget
PATCH 1/5 doc: convert git-bisect to synopsis style
From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <[email protected]>
Convert Documentation/git-bisect.adoc to the modern synopsis style.
- Replace [verse] with [synopsis] in the SYNOPSIS block
- Remove single quotes around command names in the synopsis
- Use backticks for inline commands, options, refs, and special values
- Apply [synopsis] attribute to in-body command-form code blocks
- Format OPTIONS entries with backtick-quoted terms and direct
- Add synopsis-style formatting to listing blocks
- Format man page references as command(N)
--- Documentation/asciidoc.conf.in | 6 +++ Documentation/git-bisect.adoc | 80 ++++++++++++++++++---------------- 2 files changed, 48 insertions(+), 38 deletions(-)
Documentation/asciidoc.conf.in +6 -0
@@ -84,6 +84,9 @@ ifdef::doctype-manpage[] [blockdef-open] synopsis-style=template="verseparagraph",filter="sed 's!…\\(\\]\\|$\\)!<phrase>\\0</phrase>!g;s!\\([\\[ |()]\\|^\\|\\]\\|>\\)\\([-=a-zA-Z0-9:+@,\\/_^\\$.\\\\\\*]\\+\\|…\\)!\\1<literal>\\2</literal>!g;s!<[-a-zA-Z0-9.]\\+>!<emphasis>\\0</emphasis>!g'" +[blockdef-listing] +synopsis-style=template="verseparagraph",filter="sed 's!…\\(\\]\\|$\\)!<phrase>\\0</phrase>!g;s!\\([\\[ |()]\\|^\\|\\]\\|>\\)\\([-=a-zA-Z0-9:+@,\\/_^\\$.\\\\\\*]\\+\\|…\\)!\\1<literal>\\2</literal>!g;s!<[-a-zA-Z0-9.]\\+>!<emphasis>\\0</emphasis>!g'" + [paradef-default] synopsis-style=template="verseparagraph",filter="sed 's!…\\(\\]\\|$\\)!<phrase>\\0</phrase>!g;s!\\([\\[ |()]\\|^\\|\\]\\|>\\)\\([-=a-zA-Z0-9:+@,\\/_^\\$.\\\\\\*]\\+\\|…\\)!\\1<literal>\\2</literal>!g;s!<[-a-zA-Z0-9.]\\+>!<emphasis>\\0</emphasis>!g'" endif::doctype-manpage[]
@@ -93,6 +96,9 @@ ifdef::backend-xhtml11[] [blockdef-open] synopsis-style=template="verseparagraph",filter="sed 's!…\\(\\]\\|$\\)!<span>\\0</span>!g;s!\\([\\[ |()]\\|^\\|\\]\\|>\\)\\([-=a-zA-Z0-9:+@,\\/_^\\$.\\\\\\*]\\+\\|…\\)!\\1<code>\\2</code>!g;s!<[-a-zA-Z0-9.]\\+>!<em>\\0</em>!g'" +[blockdef-listing] +synopsis-style=template="verseparagraph",filter="sed 's!…\\(\\]\\|$\\)!<span>\\0</span>!g;s!\\([\\[ |()]\\|^\\|\\]\\|>\\)\\([-=a-zA-Z0-9:+@,\\/_^\\$.\\\\\\*]\\+\\|…\\)!\\1<code>\\2</code>!g;s!<[-a-zA-Z0-9.]\\+>!<em>\\0</em>!g'" + [paradef-default] synopsis-style=template="verseparagraph",filter="sed 's!…\\(\\]\\|$\\)!<span>\\0</span>!g;s!\\([\\[ |()]\\|^\\|\\]\\|>\\)\\([-=a-zA-Z0-9:+@,\\/_^\\$.\\\\\\*]\\+\\|…\\)!\\1<code>\\2</code>!g;s!<[-a-zA-Z0-9.]\\+>!<em>\\0</em>!g'" endif::backend-xhtml11[]
Documentation/git-bisect.adoc +42 -38
188 lines not on this page · raw message
Signature · 1 line
gitgitgadget
PATCH 2/5 doc: convert git-grep synopsis and options to new style
In reply to Jean-Noël Avila via GitGitGadgetFrom: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <[email protected]>
Convert git-grep.adoc from [verse]/single-quote style to the modern synopsis-block style:
- Replace [verse] with [synopsis] in SYNOPSIS block
- Change 'git grep' to git grep (no single quotes)
- Backtick-quote all OPTIONS terms
- Convert inline man page refs: grep(1) -> grep(1)
- Convert inline command refs: 'git diff' -> git diff
- Convert prose placeholders: <file> -> _<file>_
--- Documentation/config/grep.adoc | 36 +++--- Documentation/git-grep.adoc | 196 ++++++++++++++++----------------- 2 files changed, 116 insertions(+), 116 deletions(-)
Documentation/config/grep.adoc +18 -18
@@ -1,28 +1,28 @@ -grep.lineNumber:: - If set to true, enable `-n` option by default. +`grep.lineNumber`:: + If set to `true`, enable `-n` option by default. -grep.column:: - If set to true, enable the `--column` option by default. +`grep.column`:: + If set to `true`, enable the `--column` option by default. -grep.patternType:: - Set the default matching behavior. Using a value of 'basic', 'extended', - 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`, +`grep.patternType`:: + Set the default matching behavior. Using a value of `basic`, `extended`, + `fixed`, or `perl` will enable the `--basic-regexp`, `--extended-regexp`, `--fixed-strings`, or `--perl-regexp` option accordingly, while the - value 'default' will use the `grep.extendedRegexp` option to choose - between 'basic' and 'extended'. + value `default` will use the `grep.extendedRegexp` option to choose + between `basic` and `extended`. -grep.extendedRegexp:: - If set to true, enable `--extended-regexp` option by default. This +`grep.extendedRegexp`:: + If set to `true`, enable `--extended-regexp` option by default. This option is ignored when the `grep.patternType` option is set to a value - other than 'default'. + other than `default`. -grep.threads:: +`grep.threads`:: Number of grep worker threads to use. If unset (or set to 0), Git will use as many threads as the number of logical cores available. -grep.fullName:: - If set to true, enable `--full-name` option by default. +`grep.fullName`:: + If set to `true`, enable `--full-name` option by default. -grep.fallbackToNoIndex:: - If set to true, fall back to `git grep --no-index` if `git grep` - is executed outside of a git repository. Defaults to false. +`grep.fallbackToNoIndex`:: + If set to `true`, fall back to `git grep --no-index` if `git grep` + is executed outside of a git repository. Defaults to `false`.
Documentation/git-grep.adoc +98 -98
376 lines not on this page · raw message
Signature · 1 line
gitgitgadget
PATCH 3/5 doc: convert git-am synopsis and options to new style
In reply to Jean-Noël Avila via GitGitGadgetFrom: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <[email protected]>
Convert git-am from [verse]/single-quote style to the modern synopsis-block style:
- Replace [verse] with [synopsis] in SYNOPSIS block
- Backtick-quote all OPTIONS terms
- Convert inline man page refs
- Convert inline command refs
- Convert prose placeholders:
--- Documentation/config/am.adoc | 6 +- Documentation/format-patch-caveats.adoc | 2 +- .../format-patch-end-of-commit-message.adoc | 4 +- Documentation/git-am.adoc | 132 +++++++++--------- 4 files changed, 72 insertions(+), 72 deletions(-)
Documentation/config/am.adoc +3 -3
@@ -1,11 +1,11 @@ -am.keepcr:: +`am.keepcr`:: If true, linkgit:git-am[1] will call linkgit:git-mailsplit[1] for patches in mbox format with parameter `--keep-cr`. In this case linkgit:git-mailsplit[1] will not remove `\r` from lines ending with `\r\n`. Can be overridden by giving `--no-keep-cr` from the command line. -am.threeWay:: +`am.threeWay`:: By default, linkgit:git-am[1] will fail if the patch does not apply cleanly. When set to true, this setting tells linkgit:git-am[1] to fall back on 3-way merge if the patch
@@ -13,7 +13,7 @@ am.threeWay:: have those blobs available locally (equivalent to giving the `--3way` option from the command line). Defaults to `false`. -am.messageId:: +`am.messageId`:: Add a `Message-ID` trailer based on the email header to the commit when using linkgit:git-am[1] (see linkgit:git-interpret-trailers[1]). See also the `--message-id`
Documentation/format-patch-caveats.adoc +1 -1
@@ -28,6 +28,6 @@ repositories. This goes to show that this behavior does not only impact email workflows. Given these limitations, one might be tempted to use a general-purpose -utility like patch(1) instead. However, patch(1) will not only look for +utility like `patch`(1) instead. However, `patch`(1) will not only look for unindented diffs (like linkgit:git-am[1]) but will try to apply indented diffs as well.
Documentation/format-patch-end-of-commit-message.adoc +2 -2
@@ -1,8 +1,8 @@ Any line that is of the form: * three-dashes and end-of-line, or -* a line that begins with "diff -", or -* a line that begins with "Index: " +* a line that begins with `diff -`, or +* a line that begins with `Index: ` is taken as the beginning of a patch, and the commit log message is terminated before the first occurrence of such a line.
Documentation/git-am.adoc +66 -66
284 lines not on this page · raw message
Signature · 1 line
gitgitgadget
PATCH 4/5 doc: convert git-apply synopsis and options to new style
In reply to Jean-Noël Avila via GitGitGadgetFrom: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <[email protected]>
Convert git-apply from [verse]/single-quote style to the modern synopsis-block style:
- Replace [verse] with [synopsis] in SYNOPSIS block
- Backtick-quote all OPTIONS terms and config keys in config/apply.adoc
- Convert single-quoted inline commands ('git apply', 'diff', etc.)
- Wrap standalone placeholders in underscores (<n>, <root>, <action>)
- Backtick-quote *.rej and GNU patch tool references
--- Documentation/config/apply.adoc | 17 +++-- Documentation/git-apply.adoc | 125 ++++++++++++++++---------------- 2 files changed, 74 insertions(+), 68 deletions(-)
Documentation/config/apply.adoc +11 -6
@@ -1,11 +1,16 @@ -apply.ignoreWhitespace:: - When set to 'change', tells 'git apply' to ignore changes in +`apply.ignoreWhitespace`:: + When set to `change`, tells `git apply` to ignore changes in whitespace, in the same way as the `--ignore-space-change` option. - When set to one of: no, none, never, false, it tells 'git apply' to + When set to one of: `no`, `none`, `never`, `false`, it tells `git apply` to respect all whitespace differences. +ifndef::git-apply[] See linkgit:git-apply[1]. +endif::git-apply[] -apply.whitespace:: - Tells 'git apply' how to handle whitespace, in the same way - as the `--whitespace` option. See linkgit:git-apply[1]. +`apply.whitespace`:: + Tells `git apply` how to handle whitespace, in the same way + as the `--whitespace` option. +ifndef::git-apply[] + See linkgit:git-apply[1]. +endif::git-apply[]
Documentation/git-apply.adoc +63 -62
292 lines not on this page · raw message
Signature · 1 line
gitgitgadget
PATCH 5/5 doc: convert git-imap-send synopsis and options to new style
In reply to Jean-Noël Avila via GitGitGadgetFrom: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <[email protected]>
Convert git-imap-send from [verse]/single-quote style to the modern synopsis-block style:
- Replace [verse] with [synopsis] in SYNOPSIS block
- Backtick-quote all OPTIONS terms
- Backtick-quote all config keys in config/imap.adoc
- Backtick-quote bare config key references in prose
--- Documentation/config/imap.adoc | 30 +++++++++++++++--------------- Documentation/git-imap-send.adoc | 24 ++++++++++++------------ 2 files changed, 27 insertions(+), 27 deletions(-)
Documentation/config/imap.adoc +15 -15
@@ -1,44 +1,44 @@ -imap.folder:: +`imap.folder`:: The folder to drop the mails into, which is typically the Drafts folder. For example: `INBOX.Drafts`, `INBOX/Drafts` or `[Gmail]/Drafts`. The IMAP folder to interact with MUST be specified; the value of this configuration variable is used as the fallback default value when the `--folder` option is not given. -imap.tunnel:: +`imap.tunnel`:: Command used to set up a tunnel to the IMAP server through which commands will be piped instead of using a direct network connection - to the server. Required when imap.host is not set. + to the server. Required when `imap.host` is not set. -imap.host:: +`imap.host`:: A URL identifying the server. Use an `imap://` prefix for non-secure connections and an `imaps://` prefix for secure connections. - Ignored when imap.tunnel is set, but required otherwise. + Ignored when `imap.tunnel` is set, but required otherwise. -imap.user:: +`imap.user`:: The username to use when logging in to the server. -imap.pass:: +`imap.pass`:: The password to use when logging in to the server. -imap.port:: +`imap.port`:: An integer port number to connect to on the server. - Defaults to 143 for imap:// hosts and 993 for imaps:// hosts. - Ignored when imap.tunnel is set. + Defaults to 143 for `imap://` hosts and 993 for `imaps://` hosts. + Ignored when `imap.tunnel` is set. -imap.sslverify:: +`imap.sslverify`:: A boolean to enable/disable verification of the server certificate used by the SSL/TLS connection. Default is `true`. Ignored when - imap.tunnel is set. + `imap.tunnel` is set. -imap.preformattedHTML:: +`imap.preformattedHTML`:: A boolean to enable/disable the use of html encoding when sending - a patch. An html encoded patch will be bracketed with <pre> + a patch. An html encoded patch will be bracketed with `<pre>` and have a content type of text/html. Ironically, enabling this option causes Thunderbird to send the patch as a plain/text, format=fixed email. Default is `false`. -imap.authMethod:: +`imap.authMethod`:: Specify the authentication method for authenticating with the IMAP server. If Git was built with the NO_CURL option, or if your curl version is older than 7.34.0, or if you're running git-imap-send with the `--no-curl`
Documentation/git-imap-send.adoc +12 -12
@@ -8,9 +8,9 @@ git-imap-send - Send a collection of patches from stdin to an IMAP folder SYNOPSIS -------- -[verse] -'git imap-send' [-v] [-q] [--[no-]curl] [(--folder|-f) <folder>] -'git imap-send' --list +[synopsis] +git imap-send [-v] [-q] [--[no-]curl] [(--folder|-f) <folder>] +git imap-send --list DESCRIPTION
@@ -32,30 +32,30 @@ $ git format-patch --signoff --stdout --attach origin | git imap-send OPTIONS ------- --v:: ---verbose:: +`-v`:: +`--verbose`:: Be verbose. --q:: ---quiet:: +`-q`:: +`--quiet`:: Be quiet. --f <folder>:: ---folder=<folder>:: +`-f <folder>`:: +`--folder=<folder>`:: Specify the folder in which the emails have to saved. For example: `--folder=[Gmail]/Drafts` or `-f INBOX/Drafts`. ---curl:: +`--curl`:: Use libcurl to communicate with the IMAP server, unless tunneling into it. Ignored if Git was built without the USE_CURL_FOR_IMAP_SEND option set. ---no-curl:: +`--no-curl`:: Talk to the IMAP server using git's own IMAP routines instead of using libcurl. Ignored if Git was built with the NO_OPENSSL option set. ---list:: +`--list`:: Run the IMAP LIST command to output a list of all the folders present. CONFIGURATION
Signature · 1 line
gitgitgadget
Re: [PATCH 1/5] doc: convert git-bisect to synopsis style
In reply to Jean-Noël Avila via GitGitGadgetQuoted 5 lines · Jean-Noël Avila via GitGitGadget
From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <[email protected]>
Convert
Documentation/git-bisect.adocto the modern synopsis style.- Replace [verse] with [synopsis] in the SYNOPSIS block
This was expected.
Quoted 3 lines
- Remove single quotes around command names in the synopsis
- Use backticks for inline commands, options, refs, and special values
- Apply [synopsis] attribute to in-body command-form code blocks
This is very much unexpected. I think everybody thought [synopsis] was invented to be used for the SYNOPSIS section at the beginning of each manual page, and ...
Documentation/git-bisect.adoc git-bisect - Use binary search to find the commit that introduced a bug · line 24
Quoted 12 lines
SYNOPSIS
--------
-[verse]
-'git bisect' start [--term-(bad|new)=<term-new> --term-(good|old)=<term-old>]Documentation/git-bisect.adoc +4
-2- [--no-checkout] [--first-parent] [<bad> [<good>...]] [--] [<pathspec>...] -'git bisect' help +[synopsis] +git bisect start [--term-(bad|new)=<term-new> --term-(good|old)=<term-old>] + [--no-checkout] [--first-parent] [<bad> [<good>...]] [--] [<pathspec>...] +git bisect help
... a change like this is very much expected and understandable, but new appearances of [synonsis] in places like:
Quoted 4 lines
+[synopsis]
------------------------------------------------$ git bisect reset <commit> ------------------------------------------------
and
Quoted 4 lines
+[synopsis]
------------------------------------------------
git bisect old [<rev>]
------------------------------------------------
were a bit surprising and confusing. They are not exactly command syntax definitions (which is the SYNOPSIS section is about), but examples of usage. The one with '$' command line prompt feels particularly confusing, as the prompt is not something that the end-user gives, unlike what we write in the synopsis section.
Other than that, this is quite exciting.
Re: [PATCH 1/5] doc: convert git-bisect to synopsis style
Quoted 12 lines · Junio C Hamano
Quoted 4 lines
+[synopsis]
------------------------------------------------$ git bisect reset <commit> ------------------------------------------------and
Quoted 4 lines
+[synopsis]
------------------------------------------------
git bisect old [<rev>]
------------------------------------------------
Quoted 7 lines
were a bit surprising and confusing. They are not exactly command syntax definitions (which is the SYNOPSIS section is about), but examples of usage. The one with '$' command line prompt feels particularly confusing, as the prompt is not something that the end-user gives, unlike what we write in the synopsis section.
Other than that, this is quite exciting.
Well, my local test with asciidoctor did not barf, but it seems that the documentation pipeline run in GitHub Actions CI is unhappy.
https://github.com/git/git/actions/runs/26008649802/job/76444895183#step:4:4846
I do not know what the differences among the three environments (counting your development environment---only one of which fails) are offhand.
Re: [PATCH 1/5] doc: convert git-bisect to synopsis style
In reply to Junio C HamanoQuoted 9 lines · On Monday, 18 May 2026 02:26:37 CEST Junio C Hamano wrote:
Quoted 5 lines · Jean-Noël Avila via GitGitGadget
From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <[email protected]>
Convert
Documentation/git-bisect.adocto the modern synopsis style.- Replace [verse] with [synopsis] in the SYNOPSIS block
This was expected.
Quoted 7 lines
Quoted 3 lines
- Remove single quotes around command names in the synopsis
- Use backticks for inline commands, options, refs, and special values
- Apply [synopsis] attribute to in-body command-form code blocksThis is very much unexpected. I think everybody thought [synopsis] was invented to be used for the SYNOPSIS section at the beginning of each manual page, and ...
In fact, the synopsis style was already applied before outside the SYNOPSIS sections in diff-generate-patch.adoc when describing the output of the -p option.
This formatting reaches beyond the synopsis, but the rationale is simple. Each time a listing contains some <placeholder>, what is actually described is a model, not an actual output. The <placeholder> needs a special formatting to convey its special meaning.
That may mean that the naming of "synopsis style" may not be adequate.
Quoted 6 lines
Quoted 6 lines
SYNOPSIS
---------[verse]
-'git bisect' start [--term-(bad|new)=<term-new> --term-(good|old)=<term-
old>]
Quoted 1 line
Review
Quoted 1 line
(quoted diff) +0
-1- [--no-checkout] [--first-parent] [<bad> [<good>...]]
[--] [<pathspec>...]
Quoted 4 lines
Quoted 4 lines
...
-'git bisect' help
+[synopsis]
+git bisect start [--term-(bad|new)=<term-new> --term-(good|old)=<term-
old>]
Quoted 1 line
Review
Quoted 1 line
(quoted diff) +1
-0+ [--no-checkout] [--first-parent] [<bad> [<good>...]] [--]
[<pathspec>...]
Quoted 16 lines
Quoted 2 lines
...
+git bisect help... a change like this is very much expected and understandable, but
new appearances of [synonsis] in places like:
Quoted 5 lines
+[synopsis]
------------------------------------------------
$ git bisect reset <commit> ------------------------------------------------and
Quoted 2 lines
+[synopsis]
Quoted 7 lines
Quoted 3 lines
------------------------------------------------
git bisect old [<rev>]
------------------------------------------------were a bit surprising and confusing. They are not exactly command syntax definitions (which is the SYNOPSIS section is about), but examples of usage.
Are they? the "[<rev>]" block is typical of synopsis syntax, not something you would actually type in.
Quoted 4 lines
The one with '$' command line prompt feels particularly confusing, as the prompt is not something that the end-user gives, unlike what we write in the synopsis section.
The '$' is an error to me. Will fix.
Quoted 1 line
Other than that, this is quite exciting.
Re: [PATCH 1/5] doc: convert git-bisect to synopsis style
In reply to Junio C HamanoQuoted 21 lines · On Monday, 18 May 2026 04:10:58 CEST Junio C Hamano wrote:
Quoted 20 lines · Junio C Hamano
Quoted 5 lines
+[synopsis]
------------------------------------------------
$ git bisect reset <commit> ------------------------------------------------and
Quoted 5 lines
+[synopsis]
------------------------------------------------
git bisect old [<rev>]
------------------------------------------------were a bit surprising and confusing. They are not exactly command syntax definitions (which is the SYNOPSIS section is about), but examples of usage. The one with '$' command line prompt feels particularly confusing, as the prompt is not something that the end-user gives, unlike what we write in the synopsis section.
Quoted 6 lines
Quoted 1 line
Other than that, this is quite exciting.
Well, my local test with asciidoctor did not barf, but it seems that the documentation pipeline run in GitHub Actions CI is unhappy.
76444895183#step:4:4846
Quoted 4 lines
I do not know what the differences among the three environments (counting your development environment---only one of which fails) are offhand.
Thank you for pointing out that the test fails with Asciidoctor. On my debian testing, both asciidoc.py and asciidoctor pass. I can try and revert to paragraph styling instead of block styling.
v2 cover doc: convert another batch of files to synopsis style
In reply to Jean-Noël Avila via GitGitGadgetThis time, 5 new conversions:
* git-bisect
* git-grep
* git-am
* git-apply
* git-imap-send
This batch was an opportunity to test AI-helped conversion.
Changes since v1:
* clarify the use of synopsis vs code block in git-bisect, which also include using '$'
Jean-Noël Avila (6):
doc: convert git-bisect to synopsis style
doc: git bisect: clarify the usage of the synopsis vs actual command
doc: convert git-grep synopsis and options to new style
doc: convert git-am synopsis and options to new style
doc: convert git-apply synopsis and options to new style
doc: convert git-imap-send synopsis and options to new style
Documentation/asciidoc.conf.in | 6 + Documentation/config/am.adoc | 6 +- Documentation/config/apply.adoc | 17 +- Documentation/config/grep.adoc | 36 ++-- Documentation/config/imap.adoc | 30 +-- Documentation/format-patch-caveats.adoc | 2 +- .../format-patch-end-of-commit-message.adoc | 4 +- Documentation/git-am.adoc | 132 ++++++------ Documentation/git-apply.adoc | 125 +++++------ Documentation/git-bisect.adoc | 109 +++++----- Documentation/git-grep.adoc | 196 +++++++++--------- Documentation/git-imap-send.adoc | 24 +-- 12 files changed, 346 insertions(+), 341 deletions(-)
base-commit: 56a4f3c3a221adf1df9b39da69b8a6890f803157
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-2117%2Fjnavila%2Fbisect-synopsis-style-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-2117/jnavila/bisect-synopsis-style-v2
Pull-Request: https://github.com/gitgitgadget/git/pull/2117
Range-diff vs v1:
1: dca7f192f1 ! 1: 7284281fe0 doc: convert git-bisect to synopsis style
@@ Documentation/git-bisect.adoc: that, as it cleans up the old bisection state.)
With an optional argument, you can return to a different commit instead:
+-------------------------------------------------
+[synopsis]
- ------------------------------------------------
$ git bisect reset <commit>
- ------------------------------------------------
+-------------------------------------------------
+
+ For example, git bisect reset bisect/bad will check out the first
+ bad revision, while git bisect reset HEAD will leave you on the
@@ Documentation/git-bisect.adoc: To use "old" and "new" instead of "good" and bad, you must run `git
bisect start` without commits as argument and then run the following
commands to add the commits:
+-------------------------------------------------
+[synopsis]
- ------------------------------------------------ git bisect old [<rev>]
- ------------------------------------------------
+-------------------------------------------------
to indicate that a commit was before the sought change, or
+-------------------------------------------------
+[synopsis]
- ------------------------------------------------
git bisect new [<rev>...]
- ------------------------------------------------
-@@ Documentation/git-bisect.adoc: to indicate that it was after.
+-------------------------------------------------
+
+ to indicate that it was after.
To get a reminder of the currently used terms, use
+-------------------------------------------------
+[synopsis]
- ------------------------------------------------
git bisect terms
- ------------------------------------------------
+-------------------------------------------------
+
+ You can get just the old term with git bisect terms --term-old
+ or git bisect terms --term-good; git bisect terms --term-new
@@ Documentation/git-bisect.adoc: If you would like to use your own terms instead of "bad"/"good" or
subcommands like reset, start, ...) by starting the
bisection using
+-------------------------------------------------
+[synopsis]
- ------------------------------------------------
git bisect start --term-old <term-old> --term-new <term-new>
- ------------------------------------------------
+-------------------------------------------------
+
+ For example, if you are looking for a commit that introduced a
+ performance regression, you might use
@@ Documentation/git-bisect.adoc: of git bisect good and git bisect bad to mark commits.
Bisect visualize/view
~~~~~~~~~~~~~~~~~~~~~
-: ---------- > 2: 4fb33dd440 doc: git bisect: clarify the usage of the synopsis vs actual command 2: 1b4efce1b2 = 3: fceaf195e8 doc: convert git-grep synopsis and options to new style 3: 4ab60a95f4 = 4: b9c2adfa1d doc: convert git-am synopsis and options to new style 4: 437e3f99c7 = 5: 60a420ea38 doc: convert git-apply synopsis and options to new style 5: dbe4d20b4b = 6: d88824bf09 doc: convert git-imap-send synopsis and options to new style
Signature · 1 line
gitgitgadget
PATCH v2 1/6 doc: convert git-bisect to synopsis style
From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <[email protected]>
Convert Documentation/git-bisect.adoc to the modern synopsis style.
- Replace [verse] with [synopsis] in the SYNOPSIS block
- Remove single quotes around command names in the synopsis
- Use backticks for inline commands, options, refs, and special values
- Apply [synopsis] attribute to in-body command-form code blocks
- Format OPTIONS entries with backtick-quoted terms and direct
- Add synopsis-style formatting to listing blocks
- Format man page references as command(N)
--- Documentation/asciidoc.conf.in | 6 +++ Documentation/git-bisect.adoc | 90 ++++++++++++++++------------------ 2 files changed, 48 insertions(+), 48 deletions(-)
Documentation/asciidoc.conf.in +6 -0
@@ -84,6 +84,9 @@ ifdef::doctype-manpage[] [blockdef-open] synopsis-style=template="verseparagraph",filter="sed 's!…\\(\\]\\|$\\)!<phrase>\\0</phrase>!g;s!\\([\\[ |()]\\|^\\|\\]\\|>\\)\\([-=a-zA-Z0-9:+@,\\/_^\\$.\\\\\\*]\\+\\|…\\)!\\1<literal>\\2</literal>!g;s!<[-a-zA-Z0-9.]\\+>!<emphasis>\\0</emphasis>!g'" +[blockdef-listing] +synopsis-style=template="verseparagraph",filter="sed 's!…\\(\\]\\|$\\)!<phrase>\\0</phrase>!g;s!\\([\\[ |()]\\|^\\|\\]\\|>\\)\\([-=a-zA-Z0-9:+@,\\/_^\\$.\\\\\\*]\\+\\|…\\)!\\1<literal>\\2</literal>!g;s!<[-a-zA-Z0-9.]\\+>!<emphasis>\\0</emphasis>!g'" + [paradef-default] synopsis-style=template="verseparagraph",filter="sed 's!…\\(\\]\\|$\\)!<phrase>\\0</phrase>!g;s!\\([\\[ |()]\\|^\\|\\]\\|>\\)\\([-=a-zA-Z0-9:+@,\\/_^\\$.\\\\\\*]\\+\\|…\\)!\\1<literal>\\2</literal>!g;s!<[-a-zA-Z0-9.]\\+>!<emphasis>\\0</emphasis>!g'" endif::doctype-manpage[]
@@ -93,6 +96,9 @@ ifdef::backend-xhtml11[] [blockdef-open] synopsis-style=template="verseparagraph",filter="sed 's!…\\(\\]\\|$\\)!<span>\\0</span>!g;s!\\([\\[ |()]\\|^\\|\\]\\|>\\)\\([-=a-zA-Z0-9:+@,\\/_^\\$.\\\\\\*]\\+\\|…\\)!\\1<code>\\2</code>!g;s!<[-a-zA-Z0-9.]\\+>!<em>\\0</em>!g'" +[blockdef-listing] +synopsis-style=template="verseparagraph",filter="sed 's!…\\(\\]\\|$\\)!<span>\\0</span>!g;s!\\([\\[ |()]\\|^\\|\\]\\|>\\)\\([-=a-zA-Z0-9:+@,\\/_^\\$.\\\\\\*]\\+\\|…\\)!\\1<code>\\2</code>!g;s!<[-a-zA-Z0-9.]\\+>!<em>\\0</em>!g'" + [paradef-default] synopsis-style=template="verseparagraph",filter="sed 's!…\\(\\]\\|$\\)!<span>\\0</span>!g;s!\\([\\[ |()]\\|^\\|\\]\\|>\\)\\([-=a-zA-Z0-9:+@,\\/_^\\$.\\\\\\*]\\+\\|…\\)!\\1<code>\\2</code>!g;s!<[-a-zA-Z0-9.]\\+>!<em>\\0</em>!g'" endif::backend-xhtml11[]
Documentation/git-bisect.adoc +42 -48
199 lines not on this page · raw message
Signature · 1 line
gitgitgadget
PATCH v2 2/6 doc: git bisect: clarify the usage of the synopsis vs actual command
In reply to Jean-Noël Avila via GitGitGadgetFrom: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <[email protected]>
The difference between a synopsis and an actual command is that the synopsis is a more abstract representation of the command, which may include placeholders for arguments and options. The actual command is the specific instance of the command with all the arguments and options filled in.
The formatting of an actual command is a code block, with the command prefixed by a dollar sign ($) to indicate that it is a command to be run in the terminal. It can also include comments with a hash sign (#) to explain the command or provide additional information, just like in a regular terminal session.
--- Documentation/git-bisect.adoc | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-)
Documentation/git-bisect.adoc +9 -10
@@ -96,9 +96,8 @@ Bisect reset After a bisect session, to clean up the bisection state and return to the original `HEAD`, issue the following command: ------------------------------------------------- -$ git bisect reset ------------------------------------------------- +[synopsis] +git bisect reset By default, this will return your tree to the commit that was checked out before `git bisect start`. (A new `git bisect start` will also do
@@ -108,7 +107,8 @@ With an optional argument, you can return to a different commit instead: [synopsis] -$ git bisect reset <commit> +git bisect reset <commit> + For example, `git bisect reset bisect/bad` will check out the first bad revision, while `git bisect reset HEAD` will leave you on the
@@ -174,13 +174,13 @@ For example, if you are looking for a commit that introduced a performance regression, you might use ------------------------------------------------ -git bisect start --term-old fast --term-new slow +$ git bisect start --term-old fast --term-new slow ------------------------------------------------ Or if you are looking for the commit that fixed a bug, you might use ------------------------------------------------ -git bisect start --term-new fixed --term-old broken +$ git bisect start --term-new fixed --term-old broken ------------------------------------------------ Then, use `git bisect <term-old>` and `git bisect <term-new>` instead
@@ -328,11 +328,10 @@ Bisect run If you have a script that can tell if the current source code is good or bad, you can bisect by issuing the command: ------------- -$ git bisect run my_script arguments ------------- +[synopsis] +git bisect run <cmd> [<arg>...] -Note that the script (`my_script` in the above example) should exit +Note that _<cmd>_ run with _<arg>_ should exit with code 0 if the current source code is good/old, and exit with a code between 1 and 127 (inclusive), except 125, if the current source code is bad/new.
Signature · 1 line
gitgitgadget
PATCH v2 3/6 doc: convert git-grep synopsis and options to new style
In reply to Jean-Noël Avila via GitGitGadgetFrom: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <[email protected]>
Convert git-grep.adoc from [verse]/single-quote style to the modern synopsis-block style:
- Replace [verse] with [synopsis] in SYNOPSIS block
- Change 'git grep' to git grep (no single quotes)
- Backtick-quote all OPTIONS terms
- Convert inline man page refs: grep(1) -> grep(1)
- Convert inline command refs: 'git diff' -> git diff
- Convert prose placeholders: <file> -> _<file>_
--- Documentation/config/grep.adoc | 36 +++--- Documentation/git-grep.adoc | 196 ++++++++++++++++----------------- 2 files changed, 116 insertions(+), 116 deletions(-)
Documentation/config/grep.adoc +18 -18
@@ -1,28 +1,28 @@ -grep.lineNumber:: - If set to true, enable `-n` option by default. +`grep.lineNumber`:: + If set to `true`, enable `-n` option by default. -grep.column:: - If set to true, enable the `--column` option by default. +`grep.column`:: + If set to `true`, enable the `--column` option by default. -grep.patternType:: - Set the default matching behavior. Using a value of 'basic', 'extended', - 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`, +`grep.patternType`:: + Set the default matching behavior. Using a value of `basic`, `extended`, + `fixed`, or `perl` will enable the `--basic-regexp`, `--extended-regexp`, `--fixed-strings`, or `--perl-regexp` option accordingly, while the - value 'default' will use the `grep.extendedRegexp` option to choose - between 'basic' and 'extended'. + value `default` will use the `grep.extendedRegexp` option to choose + between `basic` and `extended`. -grep.extendedRegexp:: - If set to true, enable `--extended-regexp` option by default. This +`grep.extendedRegexp`:: + If set to `true`, enable `--extended-regexp` option by default. This option is ignored when the `grep.patternType` option is set to a value - other than 'default'. + other than `default`. -grep.threads:: +`grep.threads`:: Number of grep worker threads to use. If unset (or set to 0), Git will use as many threads as the number of logical cores available. -grep.fullName:: - If set to true, enable `--full-name` option by default. +`grep.fullName`:: + If set to `true`, enable `--full-name` option by default. -grep.fallbackToNoIndex:: - If set to true, fall back to `git grep --no-index` if `git grep` - is executed outside of a git repository. Defaults to false. +`grep.fallbackToNoIndex`:: + If set to `true`, fall back to `git grep --no-index` if `git grep` + is executed outside of a git repository. Defaults to `false`.
Documentation/git-grep.adoc +98 -98
376 lines not on this page · raw message
Signature · 1 line
gitgitgadget
PATCH v2 4/6 doc: convert git-am synopsis and options to new style
In reply to Jean-Noël Avila via GitGitGadgetFrom: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <[email protected]>
Convert git-am from [verse]/single-quote style to the modern synopsis-block style:
- Replace [verse] with [synopsis] in SYNOPSIS block
- Backtick-quote all OPTIONS terms
- Convert inline man page refs
- Convert inline command refs
- Convert prose placeholders:
--- Documentation/config/am.adoc | 6 +- Documentation/format-patch-caveats.adoc | 2 +- .../format-patch-end-of-commit-message.adoc | 4 +- Documentation/git-am.adoc | 132 +++++++++--------- 4 files changed, 72 insertions(+), 72 deletions(-)
Documentation/config/am.adoc +3 -3
@@ -1,11 +1,11 @@ -am.keepcr:: +`am.keepcr`:: If true, linkgit:git-am[1] will call linkgit:git-mailsplit[1] for patches in mbox format with parameter `--keep-cr`. In this case linkgit:git-mailsplit[1] will not remove `\r` from lines ending with `\r\n`. Can be overridden by giving `--no-keep-cr` from the command line. -am.threeWay:: +`am.threeWay`:: By default, linkgit:git-am[1] will fail if the patch does not apply cleanly. When set to true, this setting tells linkgit:git-am[1] to fall back on 3-way merge if the patch
@@ -13,7 +13,7 @@ am.threeWay:: have those blobs available locally (equivalent to giving the `--3way` option from the command line). Defaults to `false`. -am.messageId:: +`am.messageId`:: Add a `Message-ID` trailer based on the email header to the commit when using linkgit:git-am[1] (see linkgit:git-interpret-trailers[1]). See also the `--message-id`
Documentation/format-patch-caveats.adoc +1 -1
@@ -28,6 +28,6 @@ repositories. This goes to show that this behavior does not only impact email workflows. Given these limitations, one might be tempted to use a general-purpose -utility like patch(1) instead. However, patch(1) will not only look for +utility like `patch`(1) instead. However, `patch`(1) will not only look for unindented diffs (like linkgit:git-am[1]) but will try to apply indented diffs as well.
Documentation/format-patch-end-of-commit-message.adoc +2 -2
@@ -1,8 +1,8 @@ Any line that is of the form: * three-dashes and end-of-line, or -* a line that begins with "diff -", or -* a line that begins with "Index: " +* a line that begins with `diff -`, or +* a line that begins with `Index: ` is taken as the beginning of a patch, and the commit log message is terminated before the first occurrence of such a line.
Documentation/git-am.adoc +66 -66
284 lines not on this page · raw message
Signature · 1 line
gitgitgadget
PATCH v2 5/6 doc: convert git-apply synopsis and options to new style
In reply to Jean-Noël Avila via GitGitGadgetFrom: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <[email protected]>
Convert git-apply from [verse]/single-quote style to the modern synopsis-block style:
- Replace [verse] with [synopsis] in SYNOPSIS block
- Backtick-quote all OPTIONS terms and config keys in config/apply.adoc
- Convert single-quoted inline commands ('git apply', 'diff', etc.)
- Wrap standalone placeholders in underscores (<n>, <root>, <action>)
- Backtick-quote *.rej and GNU patch tool references
--- Documentation/config/apply.adoc | 17 +++-- Documentation/git-apply.adoc | 125 ++++++++++++++++---------------- 2 files changed, 74 insertions(+), 68 deletions(-)
Documentation/config/apply.adoc +11 -6
@@ -1,11 +1,16 @@ -apply.ignoreWhitespace:: - When set to 'change', tells 'git apply' to ignore changes in +`apply.ignoreWhitespace`:: + When set to `change`, tells `git apply` to ignore changes in whitespace, in the same way as the `--ignore-space-change` option. - When set to one of: no, none, never, false, it tells 'git apply' to + When set to one of: `no`, `none`, `never`, `false`, it tells `git apply` to respect all whitespace differences. +ifndef::git-apply[] See linkgit:git-apply[1]. +endif::git-apply[] -apply.whitespace:: - Tells 'git apply' how to handle whitespace, in the same way - as the `--whitespace` option. See linkgit:git-apply[1]. +`apply.whitespace`:: + Tells `git apply` how to handle whitespace, in the same way + as the `--whitespace` option. +ifndef::git-apply[] + See linkgit:git-apply[1]. +endif::git-apply[]
Documentation/git-apply.adoc +63 -62
292 lines not on this page · raw message
Signature · 1 line
gitgitgadget
PATCH v2 6/6 doc: convert git-imap-send synopsis and options to new style
In reply to Jean-Noël Avila via GitGitGadgetFrom: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <[email protected]>
Convert git-imap-send from [verse]/single-quote style to the modern synopsis-block style:
- Replace [verse] with [synopsis] in SYNOPSIS block
- Backtick-quote all OPTIONS terms
- Backtick-quote all config keys in config/imap.adoc
- Backtick-quote bare config key references in prose
--- Documentation/config/imap.adoc | 30 +++++++++++++++--------------- Documentation/git-imap-send.adoc | 24 ++++++++++++------------ 2 files changed, 27 insertions(+), 27 deletions(-)
Documentation/config/imap.adoc +15 -15
@@ -1,44 +1,44 @@ -imap.folder:: +`imap.folder`:: The folder to drop the mails into, which is typically the Drafts folder. For example: `INBOX.Drafts`, `INBOX/Drafts` or `[Gmail]/Drafts`. The IMAP folder to interact with MUST be specified; the value of this configuration variable is used as the fallback default value when the `--folder` option is not given. -imap.tunnel:: +`imap.tunnel`:: Command used to set up a tunnel to the IMAP server through which commands will be piped instead of using a direct network connection - to the server. Required when imap.host is not set. + to the server. Required when `imap.host` is not set. -imap.host:: +`imap.host`:: A URL identifying the server. Use an `imap://` prefix for non-secure connections and an `imaps://` prefix for secure connections. - Ignored when imap.tunnel is set, but required otherwise. + Ignored when `imap.tunnel` is set, but required otherwise. -imap.user:: +`imap.user`:: The username to use when logging in to the server. -imap.pass:: +`imap.pass`:: The password to use when logging in to the server. -imap.port:: +`imap.port`:: An integer port number to connect to on the server. - Defaults to 143 for imap:// hosts and 993 for imaps:// hosts. - Ignored when imap.tunnel is set. + Defaults to 143 for `imap://` hosts and 993 for `imaps://` hosts. + Ignored when `imap.tunnel` is set. -imap.sslverify:: +`imap.sslverify`:: A boolean to enable/disable verification of the server certificate used by the SSL/TLS connection. Default is `true`. Ignored when - imap.tunnel is set. + `imap.tunnel` is set. -imap.preformattedHTML:: +`imap.preformattedHTML`:: A boolean to enable/disable the use of html encoding when sending - a patch. An html encoded patch will be bracketed with <pre> + a patch. An html encoded patch will be bracketed with `<pre>` and have a content type of text/html. Ironically, enabling this option causes Thunderbird to send the patch as a plain/text, format=fixed email. Default is `false`. -imap.authMethod:: +`imap.authMethod`:: Specify the authentication method for authenticating with the IMAP server. If Git was built with the NO_CURL option, or if your curl version is older than 7.34.0, or if you're running git-imap-send with the `--no-curl`
Documentation/git-imap-send.adoc +12 -12
@@ -8,9 +8,9 @@ git-imap-send - Send a collection of patches from stdin to an IMAP folder SYNOPSIS -------- -[verse] -'git imap-send' [-v] [-q] [--[no-]curl] [(--folder|-f) <folder>] -'git imap-send' --list +[synopsis] +git imap-send [-v] [-q] [--[no-]curl] [(--folder|-f) <folder>] +git imap-send --list DESCRIPTION
@@ -32,30 +32,30 @@ $ git format-patch --signoff --stdout --attach origin | git imap-send OPTIONS ------- --v:: ---verbose:: +`-v`:: +`--verbose`:: Be verbose. --q:: ---quiet:: +`-q`:: +`--quiet`:: Be quiet. --f <folder>:: ---folder=<folder>:: +`-f <folder>`:: +`--folder=<folder>`:: Specify the folder in which the emails have to saved. For example: `--folder=[Gmail]/Drafts` or `-f INBOX/Drafts`. ---curl:: +`--curl`:: Use libcurl to communicate with the IMAP server, unless tunneling into it. Ignored if Git was built without the USE_CURL_FOR_IMAP_SEND option set. ---no-curl:: +`--no-curl`:: Talk to the IMAP server using git's own IMAP routines instead of using libcurl. Ignored if Git was built with the NO_OPENSSL option set. ---list:: +`--list`:: Run the IMAP LIST command to output a list of all the folders present. CONFIGURATION
Signature · 1 line
gitgitgadget