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>,
	"Jean-Noël Avila" <jn.avila@free.fr>
Subject: [PATCH v2 4/9] doc: git-log: convert line range format to new doc format
Date: Sun, 29 Jun 2025 13:20:36 +0000	[thread overview]
Message-ID: <384a7d23563ade9764a261be5492dc229445a8d0.1751203241.git.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.1933.v2.git.1751203241.gitgitgadget@gmail.com>

From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>

- Use _<placeholder>_ instead of <placeholder> in the description
- Use `backticks` for keywords and more complex option
descriptions. The new rendering engine will apply synopsis rules to
these spans.

Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
---
 Documentation/line-range-format.adoc | 26 +++++++++++++-------------
 1 file changed, 13 insertions(+), 13 deletions(-)

diff --git a/Documentation/line-range-format.adoc b/Documentation/line-range-format.adoc
index 9b51e9fb6614..3cc2a14544cf 100644
--- a/Documentation/line-range-format.adoc
+++ b/Documentation/line-range-format.adoc
@@ -1,30 +1,30 @@
-'<start>' and '<end>' can take one of these forms:
+_<start>_ and _<end>_ can take one of these forms:
 
-- number
+- _<number>_
 +
-If '<start>' or '<end>' is a number, it specifies an
+If _<start>_ or _<end>_ is a number, it specifies an
 absolute line number (lines count from 1).
 +
 
-- `/regex/`
+- `/<regex>/`
 +
 This form will use the first line matching the given
-POSIX regex. If '<start>' is a regex, it will search from the end of
+POSIX _<regex>_. If _<start>_ is a regex, it will search from the end of
 the previous `-L` range, if any, otherwise from the start of file.
-If '<start>' is `^/regex/`, it will search from the start of file.
-If '<end>' is a regex, it will search
-starting at the line given by '<start>'.
+If _<start>_ is `^/<regex>/`, it will search from the start of file.
+If _<end>_ is a regex, it will search starting at the line given by
+_<start>_.
 +
 
-- +offset or -offset
+- `+<offset>` or `-<offset>`
 +
-This is only valid for '<end>' and will specify a number
-of lines before or after the line given by '<start>'.
+This is only valid for _<end>_ and will specify a number
+of lines before or after the line given by _<start>_.
 
 +
-If `:<funcname>` is given in place of '<start>' and '<end>', it is a
+If `:<funcname>` is given in place of _<start>_ and _<end>_, it is a
 regular expression that denotes the range from the first funcname line
-that matches '<funcname>', up to the next funcname line. `:<funcname>`
+that matches _<funcname>_, up to the next funcname line. `:<funcname>`
 searches from the end of the previous `-L` range, if any, otherwise
 from the start of file. `^:<funcname>` searches from the start of
 file. The function names are determined in the same way as `git diff`
-- 
gitgitgadget


  parent reply	other threads:[~2025-06-29 13:20 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   ` Jean-Noël Avila via GitGitGadget [this message]
2025-06-29 13:20   ` [PATCH v2 5/9] doc: git-log: convert rev list " 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   ` [PATCH v3 0/9] doc: convert git log man page to new synopsis format Jean-Noël Avila via GitGitGadget
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=384a7d23563ade9764a261be5492dc229445a8d0.1751203241.git.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).