Merge branch 'ja/doc-markup-attached-paragraph-fix' into maint-2.51

Documentation mark-up fix.

* ja/doc-markup-attached-paragraph-fix:
  doc: fix indentation of refStorage item in git-config(1)
  doc: change the markup of paragraphs following a nested list item
maint
Junio C Hamano 2025-10-15 10:29:35 -07:00
commit 554e474d03
2 changed files with 17 additions and 15 deletions

View File

@ -3,8 +3,7 @@ extensions.*::
`core.repositoryFormatVersion` is not `1`. See `core.repositoryFormatVersion` is not `1`. See
linkgit:gitrepository-layout[5]. linkgit:gitrepository-layout[5].
+ +
-- compatObjectFormat:::
compatObjectFormat::
Specify a compatibility hash algorithm to use. The acceptable values Specify a compatibility hash algorithm to use. The acceptable values
are `sha1` and `sha256`. The value specified must be different from the are `sha1` and `sha256`. The value specified must be different from the
value of `extensions.objectFormat`. This allows client level value of `extensions.objectFormat`. This allows client level
@ -19,18 +18,18 @@ Note that the functionality enabled by this extension is incomplete and subject
to change. It currently exists only to allow development and testing of to change. It currently exists only to allow development and testing of
the underlying feature and is not designed to be enabled by end users. the underlying feature and is not designed to be enabled by end users.


noop:: noop:::
This extension does not change git's behavior at all. It is useful only This extension does not change git's behavior at all. It is useful only
for testing format-1 compatibility. for testing format-1 compatibility.
+ +
For historical reasons, this extension is respected regardless of the For historical reasons, this extension is respected regardless of the
`core.repositoryFormatVersion` setting. `core.repositoryFormatVersion` setting.


noop-v1:: noop-v1:::
This extension does not change git's behavior at all. It is useful only This extension does not change git's behavior at all. It is useful only
for testing format-1 compatibility. for testing format-1 compatibility.


objectFormat:: objectFormat:::
Specify the hash algorithm to use. The acceptable values are `sha1` and Specify the hash algorithm to use. The acceptable values are `sha1` and
`sha256`. If not specified, `sha1` is assumed. `sha256`. If not specified, `sha1` is assumed.
+ +
@ -38,7 +37,7 @@ Note that this setting should only be set by linkgit:git-init[1] or
linkgit:git-clone[1]. Trying to change it after initialization will not linkgit:git-clone[1]. Trying to change it after initialization will not
work and will produce hard-to-diagnose issues. work and will produce hard-to-diagnose issues.


partialClone:: partialClone:::
When enabled, indicates that the repo was created with a partial clone When enabled, indicates that the repo was created with a partial clone
(or later performed a partial fetch) and that the remote may have (or later performed a partial fetch) and that the remote may have
omitted sending certain unwanted objects. Such a remote is called a omitted sending certain unwanted objects. Such a remote is called a
@ -50,30 +49,31 @@ The value of this key is the name of the promisor remote.
For historical reasons, this extension is respected regardless of the For historical reasons, this extension is respected regardless of the
`core.repositoryFormatVersion` setting. `core.repositoryFormatVersion` setting.


preciousObjects:: preciousObjects:::
If enabled, indicates that objects in the repository MUST NOT be deleted If enabled, indicates that objects in the repository MUST NOT be deleted
(e.g., by `git-prune` or `git repack -d`). (e.g., by `git-prune` or `git repack -d`).
+ +
For historical reasons, this extension is respected regardless of the For historical reasons, this extension is respected regardless of the
`core.repositoryFormatVersion` setting. `core.repositoryFormatVersion` setting.


refStorage:: refStorage:::
Specify the ref storage format to use. The acceptable values are: Specify the ref storage format to use. The acceptable values are:
+ +
--
include::../ref-storage-format.adoc[] include::../ref-storage-format.adoc[]

--
+ +
Note that this setting should only be set by linkgit:git-init[1] or Note that this setting should only be set by linkgit:git-init[1] or
linkgit:git-clone[1]. Trying to change it after initialization will not linkgit:git-clone[1]. Trying to change it after initialization will not
work and will produce hard-to-diagnose issues. work and will produce hard-to-diagnose issues.


relativeWorktrees:: relativeWorktrees:::
If enabled, indicates at least one worktree has been linked with If enabled, indicates at least one worktree has been linked with
relative paths. Automatically set if a worktree has been created or relative paths. Automatically set if a worktree has been created or
repaired with either the `--relative-paths` option or with the repaired with either the `--relative-paths` option or with the
`worktree.useRelativePaths` config set to `true`. `worktree.useRelativePaths` config set to `true`.


worktreeConfig:: worktreeConfig:::
If enabled, then worktrees will load config settings from the If enabled, then worktrees will load config settings from the
`$GIT_DIR/config.worktree` file in addition to the `$GIT_DIR/config.worktree` file in addition to the
`$GIT_COMMON_DIR/config` file. Note that `$GIT_COMMON_DIR` and `$GIT_COMMON_DIR/config` file. Note that `$GIT_COMMON_DIR` and
@ -87,11 +87,12 @@ When enabling this extension, you must be careful to move
certain values from the common config file to the main working tree's certain values from the common config file to the main working tree's
`config.worktree` file, if present: `config.worktree` file, if present:
+ +
--
* `core.worktree` must be moved from `$GIT_COMMON_DIR/config` to * `core.worktree` must be moved from `$GIT_COMMON_DIR/config` to
`$GIT_COMMON_DIR/config.worktree`. `$GIT_COMMON_DIR/config.worktree`.
* If `core.bare` is true, then it must be moved from `$GIT_COMMON_DIR/config` * If `core.bare` is true, then it must be moved from `$GIT_COMMON_DIR/config`
to `$GIT_COMMON_DIR/config.worktree`. to `$GIT_COMMON_DIR/config.worktree`.

--
+ +
It may also be beneficial to adjust the locations of `core.sparseCheckout` It may also be beneficial to adjust the locations of `core.sparseCheckout`
and `core.sparseCheckoutCone` depending on your desire for customizable and `core.sparseCheckoutCone` depending on your desire for customizable
@ -104,4 +105,3 @@ details.
+ +
For historical reasons, this extension is respected regardless of the For historical reasons, this extension is respected regardless of the
`core.repositoryFormatVersion` setting. `core.repositoryFormatVersion` setting.
--

View File

@ -232,7 +232,7 @@ ref names with custom decorations. The `decorate` string may be followed by a
colon and zero or more comma-separated options. Option values may contain colon and zero or more comma-separated options. Option values may contain
literal formatting codes. These must be used for commas (`%x2C`) and closing literal formatting codes. These must be used for commas (`%x2C`) and closing
parentheses (`%x29`), due to their role in the option syntax. parentheses (`%x29`), due to their role in the option syntax.
+
** `prefix=<value>`: Shown before the list of ref names. Defaults to "{nbsp}++(++". ** `prefix=<value>`: Shown before the list of ref names. Defaults to "{nbsp}++(++".
** `suffix=<value>`: Shown after the list of ref names. Defaults to "+)+". ** `suffix=<value>`: Shown after the list of ref names. Defaults to "+)+".
** `separator=<value>`: Shown between ref names. Defaults to "+,+{nbsp}". ** `separator=<value>`: Shown between ref names. Defaults to "+,+{nbsp}".
@ -241,10 +241,12 @@ parentheses (`%x29`), due to their role in the option syntax.
** `tag=<value>`: Shown before tag names. Defaults to "`tag:`{nbsp}". ** `tag=<value>`: Shown before tag names. Defaults to "`tag:`{nbsp}".


+ +
--
For example, to produce decorations with no wrapping For example, to produce decorations with no wrapping
or tag annotations, and spaces as separators: or tag annotations, and spaces as separators:
+
++%(decorate:prefix=,suffix=,tag=,separator= )++ ++%(decorate:prefix=,suffix=,tag=,separator= )++
--


++%(describe++`[:<option>,...]`++)++:: ++%(describe++`[:<option>,...]`++)++::
human-readable name, like linkgit:git-describe[1]; empty string for human-readable name, like linkgit:git-describe[1]; empty string for