2005-10-12 23:01:31 +04:00
|
|
|
git-index-pack(1)
|
|
|
|
|
=================
|
|
|
|
|
|
|
|
|
|
NAME
|
|
|
|
|
----
|
|
|
|
|
git-index-pack - Build pack index file for an existing packed archive
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
|
--------
|
2007-05-18 17:39:34 +04:00
|
|
|
[verse]
|
2021-01-26 02:37:26 +03:00
|
|
|
'git index-pack' [-v] [-o <index-file>] [--[no-]rev-index] <pack-file>
|
2008-06-30 10:09:04 +04:00
|
|
|
'git index-pack' --stdin [--fix-thin] [--keep] [-v] [-o <index-file>]
|
2021-01-26 02:37:26 +03:00
|
|
|
[--[no-]rev-index] [<pack-file>]
|
2005-10-12 23:01:31 +04:00
|
|
|
|
|
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
|
|
|
|
Reads a packed archive (.pack) from the specified file, and
|
2021-01-26 02:37:26 +03:00
|
|
|
builds a pack index file (.idx) for it. Optionally writes a
|
|
|
|
|
reverse-index (.rev) for the specified pack. The packed
|
|
|
|
|
archive together with the pack index can then be placed in
|
|
|
|
|
the objects/pack/ directory of a Git repository.
|
2005-10-12 23:01:31 +04:00
|
|
|
|
|
|
|
|
|
|
|
|
|
OPTIONS
|
|
|
|
|
-------
|
2006-10-26 07:32:59 +04:00
|
|
|
-v::
|
|
|
|
|
Be verbose about what is going on, including progress status.
|
|
|
|
|
|
2005-10-12 23:01:31 +04:00
|
|
|
-o <index-file>::
|
|
|
|
|
Write the generated pack index into the specified
|
|
|
|
|
file. Without this option the name of pack index
|
|
|
|
|
file is constructed from the name of packed archive
|
|
|
|
|
file by replacing .pack with .idx (and the program
|
|
|
|
|
fails if the name of packed archive does not end
|
|
|
|
|
with .pack).
|
|
|
|
|
|
2021-01-26 02:37:26 +03:00
|
|
|
--[no-]rev-index::
|
|
|
|
|
When this flag is provided, generate a reverse index
|
|
|
|
|
(a `.rev` file) corresponding to the given pack. If
|
|
|
|
|
`--verify` is given, ensure that the existing
|
|
|
|
|
reverse index is correct. Takes precedence over
|
|
|
|
|
`pack.writeReverseIndex`.
|
|
|
|
|
|
2006-10-23 22:50:18 +04:00
|
|
|
--stdin::
|
|
|
|
|
When this flag is provided, the pack is read from stdin
|
|
|
|
|
instead and a copy is then written to <pack-file>. If
|
|
|
|
|
<pack-file> is not specified, the pack is written to
|
2013-01-21 23:17:53 +04:00
|
|
|
objects/pack/ directory of the current Git repository with
|
2006-10-29 12:41:59 +03:00
|
|
|
a default name determined from the pack content. If
|
|
|
|
|
<pack-file> is not specified consider using --keep to
|
|
|
|
|
prevent a race condition between this process and
|
2010-01-10 02:33:00 +03:00
|
|
|
'git repack'.
|
2005-10-12 23:01:31 +04:00
|
|
|
|
2006-10-26 07:28:17 +04:00
|
|
|
--fix-thin::
|
2010-02-18 12:10:28 +03:00
|
|
|
Fix a "thin" pack produced by `git pack-objects --thin` (see
|
|
|
|
|
linkgit:git-pack-objects[1] for details) by adding the
|
|
|
|
|
excluded objects the deltified objects are based on to the
|
|
|
|
|
pack. This option only makes sense in conjunction with --stdin.
|
2006-10-29 12:41:59 +03:00
|
|
|
|
|
|
|
|
--keep::
|
|
|
|
|
Before moving the index into its final destination
|
|
|
|
|
create an empty .keep file for the associated pack file.
|
|
|
|
|
This option is usually necessary with --stdin to prevent a
|
2010-01-10 02:33:00 +03:00
|
|
|
simultaneous 'git repack' process from deleting
|
2006-10-29 12:41:59 +03:00
|
|
|
the newly constructed pack and index before refs can be
|
|
|
|
|
updated to use objects contained in the pack.
|
|
|
|
|
|
2010-10-08 21:31:15 +04:00
|
|
|
--keep=<msg>::
|
2006-10-29 12:41:59 +03:00
|
|
|
Like --keep create a .keep file before moving the index into
|
|
|
|
|
its final destination, but rather than creating an empty file
|
2010-10-08 21:31:15 +04:00
|
|
|
place '<msg>' followed by an LF into the .keep file. The '<msg>'
|
2006-10-29 12:41:59 +03:00
|
|
|
message can later be searched for within all .keep files to
|
|
|
|
|
locate any which have outlived their usefulness.
|
2006-10-26 07:28:17 +04:00
|
|
|
|
2007-04-20 06:16:53 +04:00
|
|
|
--index-version=<version>[,<offset>]::
|
|
|
|
|
This is intended to be used by the test suite only. It allows
|
|
|
|
|
to force the version for the generated pack index, and to force
|
|
|
|
|
64-bit index entries on objects located above the given offset.
|
|
|
|
|
|
2008-02-26 00:46:12 +03:00
|
|
|
--strict::
|
|
|
|
|
Die, if the pack contains broken objects or links.
|
|
|
|
|
|
index-pack: add --progress-title option
Add a --progress-title option to index-pack, when data is piped into
index-pack its progress is a proxy for whatever's feeding it data.
This option will allow us to set a more relevant progress bar title in
"git bundle unbundle", and is also used in my "bundle-uri" RFC
patches[1] by a new caller in fetch-pack.c.
The code change in cmd_index_pack() won't handle
"--progress-title=xyz", only "--progress-title xyz", and the "(i+1)"
style (as opposed to "i + 1") is a bit odd.
Not using the "--long-option=value" style is inconsistent with
existing long options handled by cmd_index_pack(), but makes the code
that needs to call it better (two strvec_push(), instead of needing a
strvec_pushf()). Since the option is internal-only the inconsistency
shouldn't matter.
I'm copying the pattern to handle it as-is from the handling of the
existing "-o" option in the same function, see 9cf6d3357aa (Add
git-index-pack utility, 2005-10-12) for its addition. That's a short
option, but the code to implement the two is the same in functionality
and style. Eventually we'd like to migrate all of this this to
parse_options(), which would make these differences in behavior go
away.
1. https://lore.kernel.org/git/RFC-cover-00.13-0000000000-20210805T150534Z-avarab@gmail.com/
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-09-05 10:34:44 +03:00
|
|
|
--progress-title::
|
|
|
|
|
For internal use only.
|
|
|
|
|
+
|
|
|
|
|
Set the title of the progress bar. The title is "Receiving objects" by
|
|
|
|
|
default and "Indexing objects" when `--stdin` is specified.
|
|
|
|
|
|
2013-05-26 05:16:17 +04:00
|
|
|
--check-self-contained-and-connected::
|
|
|
|
|
Die if the pack contains broken links. For internal use only.
|
|
|
|
|
|
2018-03-14 21:42:40 +03:00
|
|
|
--fsck-objects::
|
2021-02-22 22:20:09 +03:00
|
|
|
For internal use only.
|
|
|
|
|
+
|
|
|
|
|
Die if the pack contains broken objects. If the pack contains a tree
|
|
|
|
|
pointing to a .gitmodules blob that does not exist, prints the hash of
|
|
|
|
|
that blob (for the caller to check) after the hash that goes into the
|
|
|
|
|
name of the pack/idx file (see "Notes").
|
2018-03-14 21:42:40 +03:00
|
|
|
|
2012-05-06 16:31:55 +04:00
|
|
|
--threads=<n>::
|
|
|
|
|
Specifies the number of threads to spawn when resolving
|
|
|
|
|
deltas. This requires that index-pack be compiled with
|
|
|
|
|
pthreads otherwise this option is ignored with a warning.
|
|
|
|
|
This is meant to reduce packing time on multiprocessor
|
|
|
|
|
machines. The required amount of memory for the delta search
|
|
|
|
|
window is however multiplied by the number of threads.
|
2013-01-21 23:17:53 +04:00
|
|
|
Specifying 0 will cause Git to auto-detect the number of CPU's
|
2012-05-06 16:31:55 +04:00
|
|
|
and use maximum 3 threads.
|
|
|
|
|
|
2016-08-24 21:41:55 +03:00
|
|
|
--max-input-size=<size>::
|
|
|
|
|
Die, if the pack is larger than <size>.
|
2006-10-26 07:28:17 +04:00
|
|
|
|
2020-06-19 20:55:52 +03:00
|
|
|
--object-format=<hash-algorithm>::
|
|
|
|
|
Specify the given object format (hash algorithm) for the pack. The valid
|
|
|
|
|
values are 'sha1' and (if enabled) 'sha256'. The default is the algorithm for
|
|
|
|
|
the current repository (set by `extensions.objectFormat`), or 'sha1' if no
|
|
|
|
|
value is set or outside a repository.
|
|
|
|
|
+
|
|
|
|
|
This option cannot be used with --stdin.
|
Documentation: mark `--object-format=sha256` as experimental
After eff45daab8 ("repository: enable SHA-256 support by default",
2020-07-29), vanilla builds of Git enable the user to run, e.g.,
git init --object-format=sha256
and hack away. This can be a good way to gain experience with the
SHA-256 world, e.g., to find bugs that
GIT_TEST_DEFAULT_HASH=sha256 make test
doesn't spot.
But it really is a separate world: Such SHA-256 repos will live entirely
separate from the (by now fairly large) set of SHA-1 repos. Interacting
across the border is possible in principle, e.g., through "diff + apply"
(or "format-patch + am"), but even that has its limitations: Applying a
SHA-256 diff in a SHA-1 repo works in the simple case, but if you need
to resort to `-3`, you're out of luck.
Similarly, "push + pull" should work, but you really will be operating
mostly offset from the rest of the world. That might be ok by the time
you initialize your repository, and it might be ok for several months
after that, but there might come a day when you're starting to regret
your use of `git init --object-format=sha256` and have dug yourself into
a fairly deep hole.
There are currently topics in flight to document our data formats and
protocols regarding SHA-256 and in some cases (midx and commit-graph),
we're considering adjusting how the file formats indicate which object
format to use.
Wherever `--object-format` is mentioned in our documentation, let's make
it clear that using it with "sha256" is experimental. If we later need
to explain why we can't handle data we generated back in 2020, we can
always point to this paragraph we're adding here.
By "include::"-ing a small blurb, we should be able to be consistent
throughout the documentation and can eventually gradually tone down the
severity of this text. One day, we might even use it to start phasing
out `--object-format=sha1`, but let's not get ahead of ourselves...
There's also `extensions.objectFormat`, but it's only mentioned three
times. Twice where we're adding this new disclaimer and in the third
spot we already have a "do not edit" warning. From there, interested
readers should eventually find this new one that we're adding here.
Because `GIT_DEFAULT_HASH` provides another entry point to this
functionality, document the experimental nature of it too.
Signed-off-by: Martin Ågren <martin.agren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-08-16 13:01:18 +03:00
|
|
|
+
|
|
|
|
|
include::object-format-disclaimer.txt[]
|
2020-06-19 20:55:52 +03:00
|
|
|
|
2022-03-09 19:01:31 +03:00
|
|
|
--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.
|
|
|
|
|
|
2018-04-30 18:35:33 +03:00
|
|
|
NOTES
|
|
|
|
|
-----
|
2006-11-02 01:06:25 +03:00
|
|
|
|
2020-07-23 00:40:31 +03:00
|
|
|
Once the index has been created, the hash that goes into the name of
|
|
|
|
|
the pack/idx file is printed to stdout. If --stdin was
|
2006-11-02 01:06:25 +03:00
|
|
|
also used then this is prefixed by either "pack\t", or "keep\t" if a
|
|
|
|
|
new .keep file was successfully created. This is useful to remove a
|
2010-01-10 02:33:00 +03:00
|
|
|
.keep file used as a lock to prevent the race with 'git repack'
|
2006-11-02 01:06:25 +03:00
|
|
|
mentioned above.
|
|
|
|
|
|
2005-10-12 23:01:31 +04:00
|
|
|
GIT
|
|
|
|
|
---
|
2008-06-06 11:07:32 +04:00
|
|
|
Part of the linkgit:git[1] suite
|
