<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<article lang="en" id="git-pack-objects(1)">
<articleinfo>
    <title>git-pack-objects(1)</title>
        <indexterm>
                <primary>git-pack-objects(1)</primary>
        </indexterm>
</articleinfo>
<simplesect id="_name">
<title>NAME</title>
<simpara>git-pack-objects - Create a packed archive of objects</simpara>
</simplesect>
<simplesect id="_synopsis">
<title>SYNOPSIS</title>
<blockquote>
<literallayout><emphasis>git pack-objects</emphasis> [-q] [--no-reuse-delta] [--delta-base-offset] [--non-empty]
        [--local] [--incremental] [--window=N] [--depth=N] [--all-progress]
        [--revs [--unpacked | --all]*] [--stdout | base-name] &lt; object-list</literallayout>
</blockquote>
</simplesect>
<simplesect id="_description">
<title>DESCRIPTION</title>
<simpara>Reads list of objects from the standard input, and writes a packed
archive with specified base-name, or to the standard output.</simpara>
<simpara>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 self contained so that it can be unpacked without
any further information, but for fast, random access to the objects
in the pack, a pack index file (.idx) will be generated.</simpara>
<simpara>Placing both in the pack/ subdirectory of $GIT_OBJECT_DIRECTORY (or
any of the directories on $GIT_ALTERNATE_OBJECT_DIRECTORIES)
enables git to read from such an archive.</simpara>
<simpara>The <emphasis>git-unpack-objects</emphasis> 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.</simpara>
<simpara>In a packed archive, an object is either stored as a compressed
whole, or as a difference from some other object.  The latter is
often called a delta.</simpara>
</simplesect>
<simplesect id="_options">
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>
base-name
</term>
<listitem>
<simpara>
        Write into a pair of files (.pack and .idx), using
        &lt;base-name&gt; to determine the name of the created file.
        When this option is used, the two files are written in
        &lt;base-name&gt;-&lt;SHA1&gt;.{pack,idx} files.  &lt;SHA1&gt; is a hash
        of the sorted object names to make the resulting filename
        based on the pack content, and written to the standard
        output of the command.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--stdout
</term>
<listitem>
<simpara>
        Write the pack contents (what would have been written to
        .pack file) out to the standard output.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--revs
</term>
<listitem>
<simpara>
        Read the revision arguments from the standard input, instead of
        individual object names.  The revision arguments are processed
        the same way as <emphasis>git-rev-list</emphasis> with the <literal>--objects</literal> flag
        uses its <literal>commit</literal> arguments to build the list of objects it
        outputs.  The objects on the resulting list are packed.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--unpacked
</term>
<listitem>
<simpara>
        This implies <literal>--revs</literal>.  When processing the list of
        revision arguments read from the standard input, limit
        the objects packed to those that are not already packed.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--all
</term>
<listitem>
<simpara>
        This implies <literal>--revs</literal>.  In addition to the list of
        revision arguments read from the standard input, pretend
        as if all refs under <literal>$GIT_DIR/refs</literal> are specified to be
        included.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--include-tag
</term>
<listitem>
<simpara>
        Include unasked-for annotated tags if the object they
        reference was included in the resulting packfile.  This
        can be useful to send new tags to native git clients.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--window=[N]
</term>
<term>
--depth=[N]
</term>
<listitem>
<simpara>
        These two options affect 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.
        The default value for --window is 10 and --depth is 50.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--window-memory=[N]
</term>
<listitem>
<simpara>
        This option provides an additional limit on top of <literal>--window</literal>;
        the window size will dynamically scale down so as to not take
        up more than N bytes in memory.  This is useful in
        repositories with a mix of large and small objects to not run
        out of memory with a large window, but still be able to take
        advantage of the large window for the smaller objects.  The
        size can be suffixed with "k", "m", or "g".
        <literal>--window-memory=0</literal> makes memory usage unlimited, which is the
        default.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--max-pack-size=&lt;n&gt;
</term>
<listitem>
<simpara>
        Maximum size of each output packfile, expressed in MiB.
        If specified,  multiple packfiles may be created.
        The default is unlimited, unless the config variable
        <literal>pack.packSizeLimit</literal> is set.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--honor-pack-keep
</term>
<listitem>
<simpara>
        This flag causes an object already in a local pack that
        has a .keep file to be ignored, even if it appears in the
        standard input.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--incremental
</term>
<listitem>
<simpara>
        This flag causes an object already in a pack ignored
        even if it appears in the standard input.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--local
</term>
<listitem>
<simpara>
        This flag is similar to <literal>--incremental</literal>; instead of
        ignoring all packed objects, it only ignores objects
        that are packed and/or not in the local object store
        (i.e. borrowed from an alternate).
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--non-empty
</term>
<listitem>
<simpara>
        Only create a packed archive if it would contain at
        least one object.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--progress
</term>
<listitem>
<simpara>
        Progress status is reported on the standard error stream
        by default when it is attached to a terminal, unless -q
        is specified. This flag forces progress status even if
        the standard error stream is not directed to a terminal.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--all-progress
</term>
<listitem>
<simpara>
        When --stdout is specified then progress report is
        displayed during the object count and deltification phases
        but inhibited during the write-out phase. The reason is
        that in some cases the output stream is directly linked
        to another command which may wish to display progress
        status of its own as it processes incoming pack data.
        This flag is like --progress except that it forces progress
        report for the write-out phase as well even if --stdout is
        used.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
-q
</term>
<listitem>
<simpara>
        This flag makes the command not to report its progress
        on the standard error stream.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--no-reuse-delta
</term>
<listitem>
<simpara>
        When creating a packed archive in a repository that
        has existing packs, the command reuses existing deltas.
        This sometimes results in a slightly suboptimal pack.
        This flag tells the command not to reuse existing deltas
        but compute them from scratch.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--no-reuse-object
</term>
<listitem>
<simpara>
        This flag tells the command not to reuse existing object data at all,
        including non deltified object, forcing recompression of everything.
        This implies --no-reuse-delta. Useful only in the obscure case where
        wholesale enforcement of a different compression level on the
        packed data is desired.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--compression=[N]
</term>
<listitem>
<simpara>
        Specifies compression level for newly-compressed data in the
        generated pack.  If not specified,  pack compression level is
        determined first by pack.compression,  then by core.compression,
        and defaults to -1,  the zlib default,  if neither is set.
        Add --no-reuse-object if you want to force a uniform compression
        level on all data no matter the source.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--delta-base-offset
</term>
<listitem>
<simpara>
        A packed archive can express base object of a delta as
        either 20-byte object name or as an offset in the
        stream, but older version of git does not understand the
        latter.  By default, <emphasis>git-pack-objects</emphasis> only uses the
        former format for better compatibility.  This option
        allows the command to use the latter format for
        compactness.  Depending on the average delta chain
        length, this option typically shrinks the resulting
        packfile by 3-5 per-cent.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--threads=&lt;n&gt;
</term>
<listitem>
<simpara>
        Specifies the number of threads to spawn when searching for best
        delta matches.  This requires that pack-objects 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.
        Specifying 0 will cause git to auto-detect the number of CPU&#8217;s
        and set the number of threads accordingly.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--index-version=&lt;version&gt;[,&lt;offset&gt;]
</term>
<listitem>
<simpara>
        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.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</simplesect>
<simplesect id="_author">
<title>Author</title>
<simpara>Written by Linus Torvalds &lt;<ulink url="mailto:torvalds@osdl.org">torvalds@osdl.org</ulink>&gt;</simpara>
</simplesect>
<simplesect id="_documentation">
<title>Documentation</title>
<simpara>Documentation by Junio C Hamano</simpara>
</simplesect>
<simplesect id="_see_also">
<title>SEE ALSO</title>
<simpara><xref linkend="git-rev-list(1)"/>
<xref linkend="git-repack(1)"/>
<xref linkend="git-prune-packed(1)"/></simpara>
</simplesect>
<simplesect id="_git">
<title>GIT</title>
<simpara>Part of the <xref linkend="git(1)"/> suite</simpara>
</simplesect>
</article>
