git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: "Jean-Noël Avila" <jn.avila@free.fr>
Subject: [PATCH 0/5] doc: convert git-status, git remote and git stage to synopsis style
Date: Sat, 20 Dec 2025 19:16:22 +0000	[thread overview]
Message-ID: <pull.2020.git.1766258187.gitgitgadget@gmail.com> (raw)

The changes are basically the expected stuff for synopsis conversion, and a
few cases of "imperative mood" style.

Additionally, this series has two special commits

 * fix to the comparison of synopsis and help, to allow using synopsis
   paragraph elsewhere in manpages
 * the "ascii art" tables in git-status are converted to plain asciidoc
   tables. The alignment output is managed by the asciidoc processor.

The second patch is a RFC as to whether we should convert our tables or not.
For the translations of the manual pages, this setup simplifies the
maintenance, because we are able to export each table cell as a separate
segment.

Jean-Noël Avila (5):
  doc: fix t0450-txt-doc-vs-help to select only first synopsis block
  doc: convert git-status to synopsis style
  doc: convert git-status tables to AsciiDoc format
  doc: convert git stage to use synopsis block
  doc: convert git-remote to synopsis style

 Documentation/git-remote.adoc | 106 +++++-----
 Documentation/git-stage.adoc  |   4 +-
 Documentation/git-status.adoc | 356 +++++++++++++++++-----------------
 t/t0450-txt-doc-vs-help.sh    |   2 +-
 4 files changed, 238 insertions(+), 230 deletions(-)


base-commit: c4a0c8845e2426375ad257b6c221a3a7d92ecfda
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-2020%2Fjnavila%2Fdoc_git_status-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-2020/jnavila/doc_git_status-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/2020
-- 
gitgitgadget

             reply	other threads:[~2025-12-20 19:16 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-12-20 19:16 Jean-Noël Avila via GitGitGadget [this message]
2025-12-20 19:16 ` [PATCH 1/5] doc: fix t0450-txt-doc-vs-help to select only first synopsis block Jean-Noël Avila via GitGitGadget
2025-12-20 19:16 ` [PATCH 2/5] doc: convert git-status to synopsis style Jean-Noël Avila via GitGitGadget
2025-12-20 19:16 ` [PATCH 3/5] doc: convert git-status tables to AsciiDoc format Jean-Noël Avila via GitGitGadget
2025-12-20 19:16 ` [PATCH 4/5] doc: convert git stage to use synopsis block Jean-Noël Avila via GitGitGadget
2025-12-20 19:16 ` [PATCH 5/5] doc: convert git-remote to synopsis style Jean-Noël Avila via GitGitGadget

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=pull.2020.git.1766258187.gitgitgadget@gmail.com \
    --to=gitgitgadget@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=jn.avila@free.fr \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).