doc: move extensions.worktreeConfig to the right place
All config extensions are described in technical/repository-version.txt. I made a mistake of adding it in config.txt instead. This patch moves it back to where it belongs. Since repository-version.txt is not part of officially generated documents (it's not even part of DOC_HTML target), it's only visible to developers who read plain .txt files. Let's include it in gitrepository-layout.5 for more visibility. Some minor asciidoc fixes are required in repository-version.txt to make this happen. Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
parent
d166e6afe5
commit
356aea6f79
@ -292,13 +292,6 @@ include::config/advice.txt[]
|
|||||||
|
|
||||||
include::config/core.txt[]
|
include::config/core.txt[]
|
||||||
|
|
||||||
extensions.worktreeConfig::
|
|
||||||
If set, by default "git config" reads from both "config" and
|
|
||||||
"config.worktree" file from GIT_DIR in that order. In
|
|
||||||
multiple working directory mode, "config" file is shared while
|
|
||||||
"config.worktree" is per-working directory (i.e., it's in
|
|
||||||
GIT_COMMON_DIR/worktrees/<id>/config.worktree)
|
|
||||||
|
|
||||||
include::config/add.txt[]
|
include::config/add.txt[]
|
||||||
|
|
||||||
include::config/alias.txt[]
|
include::config/alias.txt[]
|
||||||
|
@ -290,6 +290,8 @@ worktrees/<id>/locked::
|
|||||||
worktrees/<id>/config.worktree::
|
worktrees/<id>/config.worktree::
|
||||||
Working directory specific configuration file.
|
Working directory specific configuration file.
|
||||||
|
|
||||||
|
include::technical/repository-version.txt[]
|
||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
linkgit:git-init[1],
|
linkgit:git-init[1],
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
Git Repository Format Versions
|
== Git Repository Format Versions
|
||||||
==============================
|
|
||||||
|
|
||||||
Every git repository is marked with a numeric version in the
|
Every git repository is marked with a numeric version in the
|
||||||
`core.repositoryformatversion` key of its `config` file. This version
|
`core.repositoryformatversion` key of its `config` file. This version
|
||||||
@ -40,16 +39,14 @@ format by default.
|
|||||||
|
|
||||||
The currently defined format versions are:
|
The currently defined format versions are:
|
||||||
|
|
||||||
Version `0`
|
=== Version `0`
|
||||||
-----------
|
|
||||||
|
|
||||||
This is the format defined by the initial version of git, including but
|
This is the format defined by the initial version of git, including but
|
||||||
not limited to the format of the repository directory, the repository
|
not limited to the format of the repository directory, the repository
|
||||||
configuration file, and the object and ref storage. Specifying the
|
configuration file, and the object and ref storage. Specifying the
|
||||||
complete behavior of git is beyond the scope of this document.
|
complete behavior of git is beyond the scope of this document.
|
||||||
|
|
||||||
Version `1`
|
=== Version `1`
|
||||||
-----------
|
|
||||||
|
|
||||||
This format is identical to version `0`, with the following exceptions:
|
This format is identical to version `0`, with the following exceptions:
|
||||||
|
|
||||||
@ -74,21 +71,18 @@ it here, in order to claim the name.
|
|||||||
|
|
||||||
The defined extensions are:
|
The defined extensions are:
|
||||||
|
|
||||||
`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.
|
||||||
|
|
||||||
`preciousObjects`
|
==== `preciousObjects`
|
||||||
~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
When the config key `extensions.preciousObjects` is set to `true`,
|
When the config key `extensions.preciousObjects` is set to `true`,
|
||||||
objects in the repository MUST NOT be deleted (e.g., by `git-prune` or
|
objects in the repository MUST NOT be deleted (e.g., by `git-prune` or
|
||||||
`git repack -d`).
|
`git repack -d`).
|
||||||
|
|
||||||
`partialclone`
|
==== `partialclone`
|
||||||
~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
When the config key `extensions.partialclone` is set, it indicates
|
When the config key `extensions.partialclone` is set, it indicates
|
||||||
that the repo was created with a partial clone (or later performed
|
that the repo was created with a partial clone (or later performed
|
||||||
@ -98,3 +92,11 @@ and it promises that all such omitted objects can be fetched from it
|
|||||||
in the future.
|
in the future.
|
||||||
|
|
||||||
The value of this key is the name of the promisor remote.
|
The value of this key is the name of the promisor remote.
|
||||||
|
|
||||||
|
==== `worktreeConfig`
|
||||||
|
|
||||||
|
If set, by default "git config" reads from both "config" and
|
||||||
|
"config.worktree" file from GIT_DIR in that order. In
|
||||||
|
multiple working directory mode, "config" file is shared while
|
||||||
|
"config.worktree" is per-working directory (i.e., it's in
|
||||||
|
GIT_COMMON_DIR/worktrees/<id>/config.worktree)
|
||||||
|
Loading…
Reference in New Issue
Block a user