Skip to content

doc: convert git-status, git remote and git stage to synopsis style

Jean-Noël Avila via GitGitGadget git 1 version New

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest5 patches 0 repliesNew

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/5doc: fix t0450-txt-doc-vs-help to select only first synopsis blockt/t0450-txt-doc-vs-help.sh+1 -10 replies
2/5doc: convert git-status to synopsis styleDocumentation/git-status.adoc+95 -870 replies
3/5doc: convert git-status tables to AsciiDoc formatDocumentation/git-status.adoc+85 -850 replies
4/5doc: convert git stage to use synopsis blockDocumentation/git-stage.adoc+2 -20 replies
5/5doc: convert git-remote to synopsis styleDocumentation/git-remote.adoc+53 -530 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 0/5] doc: convert git-status, git remote and git stage to synopsis style

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

Signature · 1 line
gitgitgadget