git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 0/3] doc: introducing synopsis para

From
Jean-Noël Avila via GitGitGadget <gitgitgadget@gmail.com>
Date
Jul 23, 2024, 22:44 UTC
Message-ID
<pull.1766.git.1721774680.gitgitgadget@gmail.com>

Following several issues with the way the formatting of synopsis is done in the manpages that were recently reworked, this patch series introduces the processing of a new custom paragraph attribute 'synopsis'.

This extension is added to asciidoc and asciidoctor and lets write the synopsis of the commands without any typeset. The git-init and git-clone manpages are converted to this new system.

Jean-Noël Avila (3):
  doc: introduce a synopsis custom paragraph attribute
  doc: update the guidelines to reflect the current formatting rules
  doc: apply synopsis simplification on git-clone and git-init
 Documentation/CodingGuidelines          | 34 ++++++++++++++-----------
 Documentation/asciidoc.conf             | 14 ++++++++++
 Documentation/asciidoctor-extensions.rb | 17 +++++++++++++
 Documentation/git-clone.txt             | 20 +++++++--------
 Documentation/git-init.txt              | 12 ++++-----
 t/t0450-txt-doc-vs-help.sh              |  7 ++---
 6 files changed, 68 insertions(+), 36 deletions(-)
base-commit: a7dae3bdc8b516d36f630b12bb01e853a667e0d9
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1766%2Fjnavila%2Fdoc_synopsis_para-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1766/jnavila/doc_synopsis_para-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/1766
-- 
gitgitgadget
Next: Jean-Noël Avila via GitGitGadget
Message 1 of 45 in “doc: introducing synopsis para”
  1. 0/3 doc: introducing synopsis paraJean-Noël Avila via GitGitGadget, Jul 23, 2024
  2. 1/3 doc: introduce a synopsis custom paragraph attributeJean-Noël Avila via GitGitGadget, Jul 23, 2024
  3. Junio C HamanoJul 23, 2024
  4. 2/3 doc: update the guidelines to reflect the current formatting rulesJean-Noël Avila via GitGitGadget, Jul 23, 2024
  5. Junio C HamanoJul 23, 2024
  6. 3/3 doc: apply synopsis simplification on git-clone and git-initJean-Noël Avila via GitGitGadget, Jul 23, 2024
  7. Jean-Noël AVILAJul 23, 2024
  8. 0/3 doc: introducing synopsis paraJean-Noël Avila via GitGitGadget, Jul 24, 2024
  9. 1/3 doc: introduce a synopsis custom paragraph attributeJean-Noël Avila via GitGitGadget, Jul 24, 2024
  10. 2/3 doc: update the guidelines to reflect the current formatting rulesJean-Noël Avila via GitGitGadget, Jul 24, 2024
  11. 3/3 doc: apply synopsis simplification on git-clone and git-initJean-Noël Avila via GitGitGadget, Jul 24, 2024
  12. Junio C HamanoJul 24, 2024
  13. Jean-Noël AVILAJul 25, 2024
  14. Junio C HamanoJul 25, 2024
  15. 0/3 doc: introducing synopsis paraJean-Noël Avila via GitGitGadget, Aug 11, 2024
  16. 1/3 doc: introduce a synopsis custom paragraph attributeJean-Noël Avila via GitGitGadget, Aug 11, 2024
  17. 2/3 doc: update the guidelines to reflect the current formatting rulesJean-Noël Avila via GitGitGadget, Aug 11, 2024
  18. Eric SunshineAug 11, 2024
  19. Jean-Noël AvilaAug 12, 2024
  20. 3/3 doc: apply synopsis simplification on git-clone and git-initJean-Noël Avila via GitGitGadget, Aug 11, 2024
  21. Junio C HamanoAug 19, 2024
  22. Jean-Noël AVILAAug 21, 2024
  23. Junio C HamanoAug 30, 2024
  24. 0/3 doc: introducing synopsis paraJean-Noël Avila via GitGitGadget, Sep 5, 2024
  25. 1/3 doc: introduce a synopsis typesettingJean-Noël Avila via GitGitGadget, Sep 5, 2024
  26. 2/3 doc: update the guidelines to reflect the current formatting rulesJean-Noël Avila via GitGitGadget, Sep 5, 2024
  27. 3/3 doc: apply synopsis simplification on git-clone and git-initJean-Noël Avila via GitGitGadget, Sep 5, 2024
  28. Junio C HamanoSep 13, 2024
  29. Josh SteadmonSep 20, 2024
  30. Junio C HamanoSep 21, 2024
  31. Junio C HamanoSep 21, 2024
  32. Junio C HamanoSep 21, 2024
  33. Chris TorekSep 21, 2024
  34. Junio C HamanoSep 23, 2024
  35. 0/3 doc: introducing synopsis paraJean-Noël Avila via GitGitGadget, Sep 24, 2024
  36. 1/3 doc: introduce a synopsis typesettingJean-Noël Avila via GitGitGadget, Sep 24, 2024
  37. 2/3 doc: update the guidelines to reflect the current formatting rulesJean-Noël Avila via GitGitGadget, Sep 24, 2024
  38. 3/3 doc: apply synopsis simplification on git-clone and git-initJean-Noël Avila via GitGitGadget, Sep 24, 2024
  39. Junio C HamanoSep 24, 2024
  40. Torsten BögershausenSep 24, 2024
  41. Junio C HamanoSep 24, 2024
  42. Josh SteadmonOct 2, 2024
  43. Junio C HamanoOct 2, 2024
  44. Josh SteadmonSep 24, 2024
  45. Junio C HamanoSep 24, 2024

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.