public inbox for git@vger.kernel.org 
 help / color / mirror / Atom feed
From: "Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail•com>
To: git@vger•kernel.org
Cc: "Kristoffer Haugsbakk" <kristofferhaugsbakk@fastmail•com>,
	"Jean-Noël Avila" <jn.avila@free•fr>
Subject: [PATCH v3 0/9] doc: convert git log man page to new synopsis format
Date: Mon, 07 Jul 2025 18:53:23 +0000	[thread overview]
Message-ID: <pull.1933.v3.git.1751914412.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.1933.v2.git.1751203241.gitgitgadget@gmail.com>

This series converts the man page of git log to the synopsis format style.
Git log is the second largest manpage after git config, which makes the
changes quite large.

A special note about the log format description which required escaping the
synopsis processing of parentheses.

Changes since V1:

 * rework the grammar style when refering to plural placeholders . The text
   is more descriptive and does not rely on puns. Puns may be difficult to
   understand and to translate.
 * change commit message to reflect the conversion of inline description of
   several option to a list.

Jean-Noël Avila (9):
  doc: convert git-log to new documentation format
  doc: git-log convert rev-list-description  to new doc format
  doc: git-log: convert line range options to new doc format
  doc: git-log: convert line range format to new doc format
  doc: git-log: convert rev list options to new doc format
  doc: git-log: convert pretty options to new doc format
  doc: git-log: convert pretty formats to new doc format
  doc: git-log: convert diff options to new doc format
  doc: git-log: convert log config to new doc format

 Documentation/asciidoc.conf.in             |   2 +-
 Documentation/asciidoctor-extensions.rb.in |   4 +-
 Documentation/config/log.adoc              |  47 +--
 Documentation/diff-options.adoc            |  40 ++-
 Documentation/git-log.adoc                 |  86 ++---
 Documentation/line-range-format.adoc       |  26 +-
 Documentation/line-range-options.adoc      |  10 +-
 Documentation/pretty-formats.adoc          | 283 +++++++--------
 Documentation/pretty-options.adoc          |  71 ++--
 Documentation/rev-list-description.adoc    |   6 +-
 Documentation/rev-list-options.adoc        | 390 ++++++++++-----------
 11 files changed, 493 insertions(+), 472 deletions(-)


base-commit: 8b6f19ccfc3aefbd0f22f6b7d56ad6a3fc5e4f37
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1933%2Fjnavila%2Fdoc_git_log-v3
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1933/jnavila/doc_git_log-v3
Pull-Request: https://github.com/gitgitgadget/git/pull/1933

Range-diff vs v2:

  1:  f2b69588195 =  1:  10ea4ad1cbe doc: convert git-log to new documentation format
  2:  1f6c951726b =  2:  9b52a62204c doc: git-log convert rev-list-description  to new doc format
  3:  7bab515e136 =  3:  b0b229082ce doc: git-log: convert line range options to new doc format
  4:  384a7d23563 =  4:  a4ac3ea5306 doc: git-log: convert line range format to new doc format
  5:  c2e857105d4 =  5:  1eb897ee9ad doc: git-log: convert rev list options to new doc format
  6:  01835272c2e !  6:  b860561069d doc: git-log: convert pretty options to new doc format
     @@ Documentation/pretty-options.adoc
       +
       See the "PRETTY FORMATS" section for some additional details for each
      -format.  When '=<format>' part is omitted, it defaults to 'medium'.
     -+format.  When `=<format>` part is omitted, it defaults to `medium.
     ++format.  When `=<format>` part is omitted, it defaults to `medium`.
       +
      -Note: you can specify the default pretty format in the repository
      +NOTE: you can specify the default pretty format in the repository
  7:  d5490f7d868 =  7:  0d461544c9d doc: git-log: convert pretty formats to new doc format
  8:  c2346eb580c =  8:  207fc49a201 doc: git-log: convert diff options to new doc format
  9:  b12b8294b86 =  9:  b51d3621964 doc: git-log: convert log config to new doc format

-- 
gitgitgadget

  parent reply	other threads:[~2025-07-07 18:53 UTC|newest]

Thread overview: 50+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-08  9:09 [PATCH 0/9] Doc git log Jean-Noël Avila via GitGitGadget
2025-06-08  9:09 ` [PATCH 1/9] doc: convert git-log to new documentation format Jean-Noël Avila via GitGitGadget
2025-06-16 23:02   ` Junio C Hamano
2025-06-19 20:51     ` Jean-Noël AVILA
2025-06-08  9:09 ` [PATCH 2/9] doc: git-log convert rev-list-description to new doc format Jean-Noël Avila via GitGitGadget
2025-06-19  1:24   ` Junio C Hamano
2025-06-19 20:55     ` Jean-Noël AVILA
2025-06-08  9:09 ` [PATCH 3/9] doc: git-log: convert line range options " Jean-Noël Avila via GitGitGadget
2025-06-08  9:09 ` [PATCH 4/9] doc: git-log: convert line range format " Jean-Noël Avila via GitGitGadget
2025-06-08  9:09 ` [PATCH 5/9] doc: git-log: convert rev list options " Jean-Noël Avila via GitGitGadget
2025-06-08  9:09 ` [PATCH 6/9] doc: git-log: convert pretty " Jean-Noël Avila via GitGitGadget
2025-06-08  9:09 ` [PATCH 7/9] doc: git-log: convert pretty formats " Jean-Noël Avila via GitGitGadget
2025-07-04 20:43   ` Kristoffer Haugsbakk
2025-07-04 21:39     ` Kristoffer Haugsbakk
2025-07-06 15:07       ` Jean-Noël AVILA
2025-06-08  9:09 ` [PATCH 8/9] doc: git-log: convert diff options " Jean-Noël Avila via GitGitGadget
2025-06-08  9:09 ` [PATCH 9/9] doc: git-log: convert log config " Jean-Noël Avila via GitGitGadget
2025-06-18 21:35 ` [PATCH 0/9] Doc git log Junio C Hamano
2025-07-06 15:27   ` Jean-Noël AVILA
2025-06-29 13:20 ` [PATCH v2 0/9] doc: convert git log man page to new synopsis format Jean-Noël Avila via GitGitGadget
2025-06-29 13:20   ` [PATCH v2 1/9] doc: convert git-log to new documentation format Jean-Noël Avila via GitGitGadget
2025-06-29 13:20   ` [PATCH v2 2/9] doc: git-log convert rev-list-description to new doc format Jean-Noël Avila via GitGitGadget
2025-06-29 13:20   ` [PATCH v2 3/9] doc: git-log: convert line range options " Jean-Noël Avila via GitGitGadget
2025-06-29 13:20   ` [PATCH v2 4/9] doc: git-log: convert line range format " Jean-Noël Avila via GitGitGadget
2025-06-29 13:20   ` [PATCH v2 5/9] doc: git-log: convert rev list options " Jean-Noël Avila via GitGitGadget
2025-06-29 13:20   ` [PATCH v2 6/9] doc: git-log: convert pretty " Jean-Noël Avila via GitGitGadget
2025-07-04 20:31     ` Kristoffer Haugsbakk
2025-06-29 13:20   ` [PATCH v2 7/9] doc: git-log: convert pretty formats " Jean-Noël Avila via GitGitGadget
2025-06-29 13:20   ` [PATCH v2 8/9] doc: git-log: convert diff options " Jean-Noël Avila via GitGitGadget
2025-06-29 13:20   ` [PATCH v2 9/9] doc: git-log: convert log config " Jean-Noël Avila via GitGitGadget
2025-07-07 18:53   ` Jean-Noël Avila via GitGitGadget [this message]
2025-07-07 18:53     ` [PATCH v3 1/9] doc: convert git-log to new documentation format Jean-Noël Avila via GitGitGadget
2025-07-07 18:53     ` [PATCH v3 2/9] doc: git-log convert rev-list-description to new doc format Jean-Noël Avila via GitGitGadget
2025-07-07 18:53     ` [PATCH v3 3/9] doc: git-log: convert line range options " Jean-Noël Avila via GitGitGadget
2025-07-07 18:53     ` [PATCH v3 4/9] doc: git-log: convert line range format " Jean-Noël Avila via GitGitGadget
2025-07-07 18:53     ` [PATCH v3 5/9] doc: git-log: convert rev list options " Jean-Noël Avila via GitGitGadget
2025-07-07 18:53     ` [PATCH v3 6/9] doc: git-log: convert pretty " Jean-Noël Avila via GitGitGadget
2025-07-07 18:53     ` [PATCH v3 7/9] doc: git-log: convert pretty formats " Jean-Noël Avila via GitGitGadget
2025-08-17 21:29       ` SZEDER Gábor
2025-08-19 21:22         ` [PATCH] doc: fix asciidoc format compatibility in pretty-formats.adoc Jean-Noël Avila
2025-08-19 21:49           ` Junio C Hamano
2025-08-20 20:26             ` [PATCH v2] " Jean-Noël Avila
2025-08-20 20:26               ` Jean-Noël Avila
2025-08-20 21:03               ` Junio C Hamano
2025-08-20 21:00             ` [PATCH] " Jean-Noël AVILA
2025-08-20 21:23         ` [PATCH v3] " Jean-Noël Avila
2025-07-07 18:53     ` [PATCH v3 8/9] doc: git-log: convert diff options to new doc format Jean-Noël Avila via GitGitGadget
2025-07-07 18:53     ` [PATCH v3 9/9] doc: git-log: convert log config " Jean-Noël Avila via GitGitGadget
2025-07-07 20:59     ` [PATCH v3 0/9] doc: convert git log man page to new synopsis format Junio C Hamano
2025-07-07 21:01       ` Jean-Noël AVILA

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.1933.v3.git.1751914412.gitgitgadget@gmail.com \
    --to=gitgitgadget@gmail$(echo .)com \
    --cc=git@vger$(echo .)kernel.org \
    --cc=jn.avila@free$(echo .)fr \
    --cc=kristofferhaugsbakk@fastmail$(echo .)com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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