Skip to contentSkip to conversation

doc: add/remove backticks for inline-verbatim markup

PATCH In review [email protected] 2 participants 4 messages Sep 2, 2025 Documentation

lore
Share & tools
lore

[email protected]

author
#0 lore raw

cover doc: add/remove backticks for inline-verbatim markup

From: Kristoffer Haugsbakk <[email protected]>

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/[email protected]/

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

Signature · 1 line
2.51.0.16.gcd94ab5bf81
author
#1 lore raw

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

From: Kristoffer Haugsbakk <[email protected]>

Signed-off-by Kristoffer Haugsbakk <[email protected]>
---
 Documentation/fetch-options.adoc        | 2 +-
 Documentation/git-multi-pack-index.adoc | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
Documentation/fetch-options.adoc +1 -1
index d3ac31f4e2a..ad1e1f49be1 100644
@@ -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::
Documentation/git-multi-pack-index.adoc +1 -1
index e8073bc2723..2f642697e9e 100644
@@ -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:
Signature · 1 line
2.51.0.16.gcd94ab5bf81
author
#2 lore raw

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

In reply to [email protected]

From: Kristoffer Haugsbakk <[email protected]>

Signed-off-by Kristoffer Haugsbakk <[email protected]>
---
 Documentation/git-fast-import.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/git-fast-import.adoc +1 -1
index 3144ffcdb68..e7d1214d2d1 100644
@@ -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`.
Signature · 1 line
2.51.0.16.gcd94ab5bf81
#3 lore raw
In reply to [email protected]
Quoted 7 lines · [email protected] writes:

From: Kristoffer Haugsbakk <[email protected]>

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.