doc/refs: backtick-quote commands and options consistently
The git-refs doc was converted to the synopsis style inmain89be7d2774(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> Signed-off-by: Junio C Hamano <gitster@pobox.com>
parent
db06ca011e
commit
995251109f
|
|
@ -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]).
|
||||
|
|
|
|||
Loading…
Reference in New Issue