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>
Nguyễn Thái Ngọc Duy committed
Nov 14, 2018 at 17:02 UTC
356aea6f7921d83f2794124c84ad366b418ec804
3 files changed
+16
-19
Documentation/config.txt
-7
@@ -292,13 +292,6 @@ include::config/advice.txt[]
292
293
include::config/core.txt[]
294
295
-extensions.worktreeConfig::
296
- If set, by default "git config" reads from both "config" and
297
- "config.worktree" file from GIT_DIR in that order. In
298
- multiple working directory mode, "config" file is shared while
299
- "config.worktree" is per-working directory (i.e., it's in
300
- GIT_COMMON_DIR/worktrees/<id>/config.worktree)
301
-
295
include::config/add.txt[]
296
297
include::config/alias.txt[]
Documentation/gitrepository-layout.txt
+2
@@ -290,6 +290,8 @@ worktrees/<id>/locked::
290
worktrees/<id>/config.worktree::
291
Working directory specific configuration file.
292
293
+include::technical/repository-version.txt[]
294
+
295
SEE ALSO
296
--------
297
linkgit:git-init[1],
Documentation/technical/repository-version.txt
+14
-12
@@ -1,5 +1,4 @@
1
-Git Repository Format Versions
2
-==============================
1
+== Git Repository Format Versions
2
3
Every git repository is marked with a numeric version in the
4
`core.repositoryformatversion` key of its `config` file. This version
@@ -40,16 +39,14 @@ format by default.
39
40
The currently defined format versions are:
41
43
-Version `0`
44
------------
42
+=== Version `0`
43
44
This is the format defined by the initial version of git, including but
45
not limited to the format of the repository directory, the repository
46
configuration file, and the object and ref storage. Specifying the
47
complete behavior of git is beyond the scope of this document.
48
51
-Version `1`
52
------------
49
+=== Version `1`
50
51
This format is identical to version `0`, with the following exceptions:
52
@@ -74,21 +71,18 @@ it here, in order to claim the name.
71
72
The defined extensions are:
73
77
-`noop`
78
-~~~~~~
74
+==== `noop`
75
76
This extension does not change git's behavior at all. It is useful only
77
for testing format-1 compatibility.
78
83
-`preciousObjects`
84
-~~~~~~~~~~~~~~~~~
79
+==== `preciousObjects`
80
81
When the config key `extensions.preciousObjects` is set to `true`,
82
objects in the repository MUST NOT be deleted (e.g., by `git-prune` or
83
`git repack -d`).
84
90
-`partialclone`
91
-~~~~~~~~~~~~~~
85
+==== `partialclone`
86
87
When the config key `extensions.partialclone` is set, it indicates
88
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
92
in the future.
93
94
The value of this key is the name of the promisor remote.
95
+
96
+==== `worktreeConfig`
97
+
98
+If set, by default "git config" reads from both "config" and
99
+"config.worktree" file from GIT_DIR in that order. In
100
+multiple working directory mode, "config" file is shared while
101
+"config.worktree" is per-working directory (i.e., it's in
102
+GIT_COMMON_DIR/worktrees/<id>/config.worktree)