[PATCH] Documentation: packed GIT support commands.
This adds documentation for creating packed archives, inspecting, validating them, and unpacking them. Signed-off-by: Junio C Hamano <junkio@cox.net> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
This commit is contained in:
Junio C Hamano
Linus Torvalds
parent
516236ce3f
commit
5f40520f8c
80
Documentation/git-pack-objects.txt
Normal file
80
Documentation/git-pack-objects.txt
Normal file
@ -0,0 +1,80 @@
|
||||
git-pack-objects(1)
|
||||
===================
|
||||
v0.1, July 2005
|
||||
|
||||
NAME
|
||||
----
|
||||
git-pack-objects - Create a packed archive of objects.
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
'git-pack-objects' [--incremental] [--window=N] [--depth=N] {--stdout | base-name} < object-list
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Reads list of objects from the standard input, and writes a packed
|
||||
archive with specified base-name, or to the standard output.
|
||||
|
||||
A packed archive is an efficient way to transfer set of objects
|
||||
between two repositories, and also is an archival format which
|
||||
is efficient to access. The packed archive format (.pack) is
|
||||
designed to be unpackable without having anything else, but for
|
||||
random access, accompanied with the pack index file (.idx).
|
||||
|
||||
'git-unpack-objects' command can read the packed archive and
|
||||
expand the objects contained in the pack into "one-file
|
||||
one-object" format; this is typically done by the smart-pull
|
||||
commands when a pack is created on-the-fly for efficient network
|
||||
transport by their peers.
|
||||
|
||||
Placing both in pack subdirectory of $GIT_OBJECT_DIRECTORY (or
|
||||
any of the directories on $GIT_ALTERNATE_OBJECT_DIRECTORIES)
|
||||
enables GIT to read from such an archive.
|
||||
|
||||
|
||||
OPTIONS
|
||||
-------
|
||||
base-name::
|
||||
Write into a pair of files (.pack and .idx), using
|
||||
<base-name> to determine the name of the created file.
|
||||
When this option is used, the two files are written in
|
||||
<base-name>-<SHA1>.{pack,idx} files. <SHA1> is a hash
|
||||
of object names (currently in random order so it does
|
||||
not have any useful meaning) to make the resulting
|
||||
filename reasonably unique, and written to the standard
|
||||
output of the command.
|
||||
|
||||
--stdout::
|
||||
Write the pack contents (what would have been writtin to
|
||||
.pack file) out to the standard output.
|
||||
|
||||
--window and --depth::
|
||||
These two options affects how the objects contained in
|
||||
the pack are stored using delta compression. The
|
||||
objects are first internally sorted by type, size and
|
||||
optionally names and compared against the other objects
|
||||
within --window to see if using delta compression saves
|
||||
space. --depth limits the maximum delta depth; making
|
||||
it too deep affects the performance on the unpacker
|
||||
side, because delta data needs to be applied that many
|
||||
times to get to the necessary object.
|
||||
|
||||
--incremental::
|
||||
This flag causes an object already in a pack ignored
|
||||
even if it appears in the standard input.
|
||||
|
||||
|
||||
Author
|
||||
------
|
||||
Written by Linus Torvalds <torvalds@osdl.org>
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
Documentation by Junio C Hamano
|
||||
|
||||
GIT
|
||||
---
|
||||
Part of the link:git.html[git] suite
|
||||
|
||||
36
Documentation/git-show-index.txt
Normal file
36
Documentation/git-show-index.txt
Normal file
@ -0,0 +1,36 @@
|
||||
git-show-index(1)
|
||||
=================
|
||||
v0.1, July 2005
|
||||
|
||||
NAME
|
||||
----
|
||||
git-show-index - Show packed archive index
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
'git-show-index' < idx-file
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Reads given idx file for packed GIT archive created with
|
||||
git-pack-objects command, and dumps its contents.
|
||||
|
||||
The information it outputs is subset of what you can get from
|
||||
'git-verify-pack -v'; this command only shows the packfile
|
||||
offset and SHA1 of each object.
|
||||
|
||||
|
||||
Author
|
||||
------
|
||||
Written by Linus Torvalds <torvalds@osdl.org>
|
||||
|
||||
Documentation
|
||||
--------------
|
||||
Documentation by Junio C Hamano
|
||||
|
||||
GIT
|
||||
---
|
||||
Part of the link:git.html[git] suite
|
||||
|
||||
33
Documentation/git-unpack-objects.txt
Normal file
33
Documentation/git-unpack-objects.txt
Normal file
@ -0,0 +1,33 @@
|
||||
git-unpack-objects(1)
|
||||
=====================
|
||||
v0.1, July 2005
|
||||
|
||||
NAME
|
||||
----
|
||||
git-unpack-objects - Create a packed archive of objects.
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
'git-unpack-objects' < pack-file
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Reads a packed archive (.pack) from the standard input, and
|
||||
expands the objects contained in the pack into "one-file
|
||||
one-object" format in $GIT_OBJECT_DIRECTORY.
|
||||
|
||||
|
||||
Author
|
||||
------
|
||||
Written by Linus Torvalds <torvalds@osdl.org>
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
Documentation by Junio C Hamano
|
||||
|
||||
GIT
|
||||
---
|
||||
Part of the link:git.html[git] suite
|
||||
|
||||
@ -9,7 +9,7 @@ git-verify-pack - Validate packed GIT archive files.
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
'git-verify-pack' <pack>.idx ...
|
||||
'git-verify-pack' [-v] <pack>.idx ...
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
@ -23,6 +23,17 @@ OPTIONS
|
||||
<pack>.idx ...::
|
||||
The idx files to verify.
|
||||
|
||||
-v::
|
||||
After verifying the pack, show list of objects contained
|
||||
in the pack. The format used is:
|
||||
|
||||
SHA1 type size offset-in-packfile
|
||||
|
||||
for objects that are not deltified in the pack, and
|
||||
|
||||
SHA1 type size offset-in-packfile depth base-SHA1
|
||||
|
||||
for objects that are deltified.
|
||||
|
||||
Author
|
||||
------
|
||||
|
||||
Loading…
Reference in New Issue
Block a user