threads / patch / 64079

patch, 2 partsdoc: add/remove backticks for inline-verbatim markup

Subject: [PATCH 0/2] doc: add/remove backticks for inline-verbatim markup

## tl;dr

4 messages between Sep 2, 2025 and Sep 2, 2025. Diffs are folded; open one to read it.

replies: 3people: 2as markdown or json

kristofferhaugsbakk@fastmail.com· Sep 2, 2025, 20:35 UTC · lore

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

Fix markup where either a backtick (for inline-verbatim) was missed or one too many was used.

Ignores the one in `Documentation/config/alias.adoc` because [1] already covers that one.

[1]: topic km/alias-doc-markup-fix;
    https://lore.kernel.org/git/20250901180419.2212086-1-kyle@kemitchell.com/

Kristoffer Haugsbakk (2):
  doc: add missing backtick for inline-verbatim
  doc: remove extra backtick for inline-verbatim

 Documentation/fetch-options.adoc        | 2 +-
 Documentation/git-fast-import.adoc      | 2 +-
 Documentation/git-multi-pack-index.adoc | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

base-commit: 2462961280690837670d997bde64bd4ebf8ae66d

-- 
2.51.0.16.gcd94ab5bf81

kristofferhaugsbakk@fastmail.com· Sep 2, 2025, 20:35 UTC · re: kristofferhaugsbakk@fastmail.com · lore

[PATCH 1/2] doc: add missing backtick for inline-verbatim

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
 Documentation/fetch-options.adoc        | 2 +-
 Documentation/git-multi-pack-index.adoc | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

Show changes to 2 files +2 −2

Documentation/fetch-options.adoc, Documentation/git-multi-pack-index.adoc

diff --git a/Documentation/fetch-options.adoc b/Documentation/fetch-options.adoc
index d3ac31f4e2a..ad1e1f49be1 100644
--- a/Documentation/fetch-options.adoc
+++ b/Documentation/fetch-options.adoc
@@ -2,7 +2,7 @@
 --no-all::
 	Fetch all remotes, except for the ones that has the
 	`remote.<name>.skipFetchAll` configuration variable set.
-	This overrides the configuration variable fetch.all`.
+	This overrides the configuration variable `fetch.all`.
 
 -a::
 --append::
diff --git a/Documentation/git-multi-pack-index.adoc b/Documentation/git-multi-pack-index.adoc
index e8073bc2723..2f642697e9e 100644
--- a/Documentation/git-multi-pack-index.adoc
+++ b/Documentation/git-multi-pack-index.adoc
@@ -29,7 +29,7 @@ OPTIONS
 --no-progress::
 	Turn progress on/off explicitly. If neither is specified, progress is
 	shown if standard error is connected to a terminal. Supported by
-	sub-commands `write`, `verify`, `expire`, and `repack.
+	sub-commands `write`, `verify`, `expire`, and `repack`.
 
 The following subcommands are available:

-- 
2.51.0.16.gcd94ab5bf81

kristofferhaugsbakk@fastmail.com· Sep 2, 2025, 20:35 UTC · re: kristofferhaugsbakk@fastmail.com · lore

[PATCH 2/2] doc: remove extra backtick for inline-verbatim

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
 Documentation/git-fast-import.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Show changes to Documentation/git-fast-import.adoc +1 −1

diff --git a/Documentation/git-fast-import.adoc b/Documentation/git-fast-import.adoc
index 3144ffcdb68..e7d1214d2d1 100644
--- a/Documentation/git-fast-import.adoc
+++ b/Documentation/git-fast-import.adoc
@@ -647,7 +647,7 @@ External data format::
 +
 Here usually `<dataref>` must be either a mark reference (`:<idnum>`)
 set by a prior `blob` command, or a full 40-byte SHA-1 of an
-existing Git blob object.  If `<mode>` is `040000`` then
+existing Git blob object.  If `<mode>` is `040000` then
 `<dataref>` must be the full 40-byte SHA-1 of an existing
 Git tree object or a mark reference set with `--import-marks`.

-- 
2.51.0.16.gcd94ab5bf81

Junio C Hamano· Sep 2, 2025, 21:54 UTC · re: kristofferhaugsbakk@fastmail.com · lore

Re: [PATCH 0/2] doc: add/remove backticks for inline-verbatim markup

kristofferhaugsbakk@fastmail.com writes:

Show 7 quoted lines

> From: Kristoffer Haugsbakk <code@khaugsbakk.name>
>
> Fix markup where either a backtick (for inline-verbatim) was missed or
> one too many was used.
>
> Ignores the one in `Documentation/config/alias.adoc` because [1] already
> covers that one.

The places these patches address are clearly broken. Thanks for noticing and fixing them.

Will queue.

Thanks.