Skip to content

A new batch of synopsis conversion#2185

Open
jnavila wants to merge 4 commits into
gitgitgadget:masterfrom
jnavila:convert_synopsis_202606
Open

A new batch of synopsis conversion#2185
jnavila wants to merge 4 commits into
gitgitgadget:masterfrom
jnavila:convert_synopsis_202606

Conversation

@jnavila

@jnavila jnavila commented Jul 19, 2026

Copy link
Copy Markdown

The conversion to synopsis continues. Now the commands are less common, so I may propose larger PRs if it's ok.

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

Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
@jnavila
jnavila force-pushed the convert_synopsis_202606 branch from 885f94f to 3b70020 Compare July 19, 2026 13:08
jnavila added 3 commits July 19, 2026 15:18
Replace [verse] with [synopsis] in the SYNOPSIS block and remove
single-quote formatting from the command name.

Backtick-quote all option terms in the OPTIONS section, convert
standalone placeholders to _<placeholder>_ form, and convert
single-quoted commands and tools in prose to backtick form.

Also update the included files:
- diff-options.adoc: backtick-quote the git-format-patch-specific
  option terms (-p, --no-stat, --max-depth=<depth>)
- format-patch-caveats.adoc: convert patch(1) to `patch`(1)

Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
Replace [verse] with [synopsis] in the SYNOPSIS block and remove
single-quote formatting from the command name.

Backtick-quote all option terms in the OPTIONS section, convert
the standalone placeholder _<encoding>_ in prose, fix single-quoted
server names to backtick form, and convert mbox(5) to `mbox`(5).

Also update config/sendemail.adoc: backtick-quote all configuration
key terms and fix a bare sendemail.aliasesFile reference in prose.

Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
 * Replace [verse] with [synopsis] in the SYNOPSIS block
 * remove single-quote formatting from the command name
 * backtick-quote the flag
 * use _<placeholder>_ form for positional parameter terms

Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
@jnavila
jnavila force-pushed the convert_synopsis_202606 branch from 3b70020 to 5b6e9bd Compare July 19, 2026 13:18
@jnavila

jnavila commented Jul 19, 2026

Copy link
Copy Markdown
Author

/submit

@gitgitgadget

gitgitgadget Bot commented Jul 19, 2026

Copy link
Copy Markdown

Submitted as pull.2185.git.1784490878.gitgitgadget@gmail.com

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-2185/jnavila/convert_synopsis_202606-v1

To fetch this version to local tag pr-2185/jnavila/convert_synopsis_202606-v1:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-2185/jnavila/convert_synopsis_202606-v1

@@ -13,8 +13,8 @@ endif::git-diff[]
endif::git-format-patch[]

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Junio C Hamano wrote on the Git mailing list (how to reply to this email):

"Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com> writes:

> Backtick-quote all option terms in the OPTIONS section, convert
> standalone placeholders to _<placeholder>_ form, and convert
> single-quoted commands and tools in prose to backtick form.

OK.

> @@ -708,15 +708,15 @@ BASE TREE INFORMATION
>  
>  The base tree information block is used for maintainers or third party
>  testers to know the exact state the patch series applies to. It consists
> +of the "base commit", which is a well-known commit that is part of the
>  stable part of the project history everybody else works off of, and zero
> +or more "prerequisite patches", which are well-known patches in flight
> +that is not yet part of the "base commit" that need to be applied on top
> +of "base commit" in topological order before the patches can be applied.

GIven that the last part of this hunk below uses backtick-quoting
for `prerequisite patch` and `patch id`, shouldn't the references to
`base commit`, and `prerequisite patch(es)` in the above also be
backtick quoted for consistency?

> +The "base commit" is shown as "base-commit: " followed by the 40-hex of
> +the commit object name.  A `prerequisite patch` is shown as
> +"prerequisite-patch-id: " followed by the 40-hex `patch id`, which can
>  be obtained by passing the patch through the `git patch-id --stable`
>  command.

@@ -7,8 +7,8 @@ git-request-pull - Generates a summary of pending changes

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Junio C Hamano wrote on the Git mailing list (how to reply to this email):

"Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com> writes:

> @@ -54,11 +54,15 @@ the `v1.0` release, and want it to be integrated into the project.
>  First you push that change to your public repository for others to
>  see:
>  
> -	git push https://git.ko.xz/project master
> +-----
> +git push https://git.ko.xz/project master
> +-----
>  
>  Then, you run this command:
>  
> -	git request-pull v1.0 https://git.ko.xz/project master
> +------
> +git request-pull v1.0 https://git.ko.xz/project master
> +------
>  
>  which will produce a request to the upstream, summarizing the
>  changes between the `v1.0` release and your `master`, to pull it
> @@ -67,11 +71,15 @@ from your public repository.
>  If you pushed your change to a branch whose name is different from
>  the one you have locally, e.g.
>  
> -	git push https://git.ko.xz/project master:for-linus
> +-----
> +git push https://git.ko.xz/project master:for-linus
> +-----
>  
>  then you can ask that to be pulled with
>  
> -	git request-pull v1.0 https://git.ko.xz/project master:for-linus
> +-----
> +git request-pull v1.0 https://git.ko.xz/project master:for-linus
> +-----

Is there a widely accepted guideline among AsciiDoc users governing
how many dashes should delimit these blocks, other than "at least
four, with the opening and closing counts matching"?  If so, what is
it?  We see five, six, five, and five dashes in the proposed changes
above, and in '[PATCH 1/4]' we saw nine.  Even if varying counts are
functionally equivalent, the inconsistency is a bit distracting.

Thanks.

[Footnote]

 * an excerpt from [PATCH 1/4]

diff --git a/Documentation/git-imap-send.adoc b/Documentation/git-imap-send.adoc
index 538b91afc0..dd1e0a3718 100644
--- a/Documentation/git-imap-send.adoc
+++ b/Documentation/git-imap-send.adoc
@@ -192,7 +192,10 @@ supports only `XOAUTH2` as the mechanism.
 
 Once the commits are ready to be sent, run the following command:
 
-  $ git format-patch --cover-letter -M --stdout origin/master | git imap-send
+
+---------
+$ git format-patch --cover-letter -M --stdout origin/master | git imap-send
+---------

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant