[PATCH v3 2/2] doc/refs: backtick-quote commands and options consistently
- From
Todd Zullinger <tmz@pobox.com>
- Date
- Sep 15, 2026, 13:10 UTC
- Message-ID
- <20260915131036.393249-3-tmz@pobox.com>
- In-Reply-To
- <20260912191509.844954-1-tmz@pobox.com>
The git-refs doc was converted to the synopsis style in 89be7d2774 (builtin/refs: add '--no-reflog' flag to drop reflogs, 2025-02-21). The commands and options were not backtick-quoted at that time. 84f3d6e11e (doc lint: check that synopsis manpages have synopsis inlines, 2025-08-11) applied backtick-quotes to the existing commands and options.
Subsequently, a number of commands and options were added without such quoting, leaving the documentation rendered inconsistently. Apply backtick-quotes to all entries.
Signed-off-by: Todd Zullinger <tmz@pobox.com> --- Documentation/git-refs.adoc | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/Documentation/git-refs.adoc b/Documentation/git-refs.adoc index 9063892651..9dc08cbca9 100644 --- a/Documentation/git-refs.adoc +++ b/Documentation/git-refs.adoc @@ -54,40 +54,40 @@ These limitations may eventually be lifted. `verify`:: Verify reference database consistency. -list:: +`list`:: List references in the repository with support for filtering, formatting, and sorting. This subcommand is an alias for linkgit:git-for-each-ref[1] and offers identical functionality. -exists:: +`exists`:: Check whether the given reference exists. Returns an exit code of 0 if it does, 2 if it is missing, and 1 in case looking up the reference failed with an error other than the reference being missing. This does not verify whether the reference resolves to an actual object. -optimize:: +`optimize`:: Optimizes references to improve repository performance and reduce disk usage. This subcommand is an alias for linkgit:git-pack-refs[1] and offers identical functionality. -create:: +`create`:: Create the given reference, which must not already exist, pointing at `<new-value>`. -delete:: +`delete`:: Delete the given reference. This subcommand mirrors `git update-ref -d` (see linkgit:git-update-ref[1]). When `<old-value>` is given, the reference is only deleted after verifying that it currently contains `<old-value>`. -update:: +`update`:: Update the given reference to point at `<new-value>`. If `<old-value>` is given, the reference is only updated after verifying that it currently contains `<old-value>`. As a special case, an all-zeroes `<new-value>` deletes the branch, whereas an all-zeroes `<old-value>` ensures that the branch does not yet exist. -rename:: +`rename`:: Rename the reference `<oldref>` to `<newref>`. The old reference must exist and the new reference must not yet exist, and both must have a well-formed name (see linkgit:git-check-ref-format[1]).
-- 2.56.0.rc0