diff options
| author |  Derrick Stolee <derrickstolee@github.com> | 2022-03-09 16:01:31 +0000 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2022-03-09 10:25:26 -0800 |
| commit | 1f52cdfacb6af203cdcc6a5101fc8cb5fff72735 (patch) | |
| tree | e6d0de9562311f63bf55a53552c27609a9a142ec /Documentation | |
| parent | The seventh batch (diff) | |
| download | tgif-1f52cdfacb6af203cdcc6a5101fc8cb5fff72735.tar.xz | |
index-pack: document and test the --promisor option
The --promisor option of 'git index-pack' was created in 88e2f9e
(introduce fetch-object: fetch one promisor object, 2017-12-05) but was
untested. It is currently unused within the Git codebase, but that will
change in an upcoming change to 'git bundle unbundle' when there is a
filter capability.
For now, add documentation about the option and add a test to ensure it
is working as expected.
Signed-off-by: Derrick Stolee <derrickstolee@github.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/git-index-pack.txt | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/Documentation/git-index-pack.txt b/Documentation/git-index-pack.txt index 1f1e359225..4e71c256ec 100644 --- a/Documentation/git-index-pack.txt +++ b/Documentation/git-index-pack.txt @@ -122,6 +122,14 @@ This option cannot be used with --stdin. + include::object-format-disclaimer.txt[] +--promisor[=<message>]:: + Before committing the pack-index, create a .promisor file for this + pack. Particularly helpful when writing a promisor pack with --fix-thin + since the name of the pack is not final until the pack has been fully + written. If a `<message>` is provided, then that content will be + written to the .promisor file for future reference. See + link:technical/partial-clone.html[partial clone] for more information. + NOTES ----- |