Home Explore Blog CI



git

1st chunk of `Documentation/git-index-pack.adoc`
52e45c0f1150854d440e7c7dedd85f6d59b395c8aeff3c640000000100000c47
git-index-pack(1)
=================

NAME
----
git-index-pack - Build pack index file for an existing packed archive


SYNOPSIS
--------
[verse]
'git index-pack' [-v] [-o <index-file>] [--[no-]rev-index] <pack-file>
'git index-pack' --stdin [--fix-thin] [--keep] [-v] [-o <index-file>]
		  [--[no-]rev-index] [<pack-file>]


DESCRIPTION
-----------
Reads a packed archive (.pack) from the specified file,
builds a pack index file (.idx) for it, and 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.


OPTIONS
-------
-v::
	Be verbose about what is going on, including progress status.

-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).

--[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`.

--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
	objects/pack/ directory of the current Git repository with
	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
	'git repack'.

--fix-thin::
	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.

--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
	simultaneous 'git repack' process from deleting
	the newly constructed pack and index before refs can be
	updated to use objects contained in the pack.

--keep=<msg>::
	Like --keep, create a .keep file before moving the index into
	its final destination.  However, instead of creating an empty file
	place '<msg>' followed by an LF into the .keep file.  The '<msg>'
	message can later be searched for within all .keep files to
	locate any which have outlived their usefulness.

--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.

--strict[=<msg-id>=<severity>...]::
	Die, if the pack contains broken objects or links. An optional
	comma-separated list of `<msg-id>=<severity>` can be passed to change
	the severity of some possible issues, e.g.,
	 `--strict="missingEmail=ignore,badTagName=error"`. See the entry for the
	`fsck.<msg-id>` configuration

Title: Git Index-Pack Command
Summary
The git-index-pack command builds a pack index file for an existing packed archive, allowing it to be used in a Git repository, with options for customizing the output and handling potential issues with the pack.