diff options
| author | Junio C Hamano <gitster@pobox.com> | 2025-08-25 14:22:01 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2025-08-25 14:22:02 -0700 |
| commit | 0d8f4ccfe3b13bb5eb95f030dc5fe76efb255397 (patch) | |
| tree | d7c7205b2ae9788e006996be6f8074978f215507 /Documentation/git-refs.adoc | |
| parent | 109c3df14ccf372c2438a470bdfb566265399f0a (diff) | |
| parent | 84f3d6e11e085a52e561a509f2433208f22c6d3b (diff) | |
| download | git-0d8f4ccfe3b13bb5eb95f030dc5fe76efb255397.tar.xz | |
Merge branch 'ja/doc-lint-sections-and-synopsis'
Doc lint updates to encourage the newer and easier-to-use
`synopsis` format, with fixes to a handful of existing uses.
* ja/doc-lint-sections-and-synopsis:
doc lint: check that synopsis manpages have synopsis inlines
doc:git-for-each-ref: fix styling and typos
doc: check for absence of the form --[no-]parameter
doc: check for absence of multiple terms in each entry of desc list
doc: check well-formedness of delimited sections
doc: test linkgit macros for well-formedness
Diffstat (limited to 'Documentation/git-refs.adoc')
| -rw-r--r-- | Documentation/git-refs.adoc | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/Documentation/git-refs.adoc b/Documentation/git-refs.adoc index e608980711..d462953fb5 100644 --- a/Documentation/git-refs.adoc +++ b/Documentation/git-refs.adoc @@ -17,7 +17,7 @@ git refs list [--count=<count>] [--shell|--perl|--python|--tcl] [--merged[=<object>]] [--no-merged[=<object>]] [--contains[=<object>]] [--no-contains[=<object>]] [(--exclude=<pattern>)...] [--start-after=<marker>] - [ --stdin | <pattern>... ] + [ --stdin | (<pattern>...)] DESCRIPTION ----------- @@ -27,10 +27,10 @@ This command provides low-level access to refs. COMMANDS -------- -migrate:: +`migrate`:: Migrate ref store between different formats. -verify:: +`verify`:: Verify reference database consistency. list:: @@ -41,32 +41,32 @@ list:: OPTIONS ------- -The following options are specific to 'git refs migrate': +The following options are specific to `git refs migrate`: ---ref-format=<format>:: +`--ref-format=<format>`:: The ref format to migrate the ref store to. Can be one of: + include::ref-storage-format.adoc[] ---dry-run:: +`--dry-run`:: Perform the migration, but do not modify the repository. The migrated refs will be written into a separate directory that can be inspected separately. The name of the directory will be reported on stdout. This can be used to double check that the migration works as expected before performing the actual migration. ---reflog:: ---no-reflog:: +`--reflog`:: +`--no-reflog`:: Choose between migrating the reflog data to the new backend, and discarding them. The default is "--reflog", to migrate. -The following options are specific to 'git refs verify': +The following options are specific to `git refs verify`: ---strict:: +`--strict`:: Enable stricter error checking. This will cause warnings to be reported as errors. See linkgit:git-fsck[1]. ---verbose:: +`--verbose`:: When verifying the reference database consistency, be chatty. The following options are specific to 'git refs list': |