From: Mark Levedahl Date: Wed, 14 Feb 2007 14:10:29 GMT Subject: [PATCH] Create a man page for git-unbundle. Message-ID: <1171462229415-git-send-email-mdl123@verizon.net> In-Reply-To: <11714622291709-git-send-email-mdl123@verizon.net> Signed-off-by: Mark Levedahl --- Documentation/git-unbundle.txt | 55 ++++++++++++++++++++++++++++++++++++++++ 1 files changed, 55 insertions(+), 0 deletions(-) create mode 100644 Documentation/git-unbundle.txt diff --git a/Documentation/git-unbundle.txt b/Documentation/git-unbundle.txt new file mode 100644 index 0000000..8dbfccb --- /dev/null +++ b/Documentation/git-unbundle.txt @@ -0,0 +1,55 @@ +git-unbundle(1) +================ + +NAME +---- +git-unbundle - Unpackage objects and refs to update a disconnected repository + + +SYNOPSIS +-------- +'git-unbundle' [--bare ] [--force] [--shallow] file + +DESCRIPTION +----------- + +Some workflows require that one or more branches of development on one machine +be replicated on another machine, but the two machines cannot be directly +connected so the gitlink:git-fetch[1] protocol cannot be used. This command +unpacks a bundle file created by gitlink:git-bundle[1] on another repository, +adding the objects and updating references as defined by the donor repository. + +OPTIONS +------- + +--bare:: + Assume operation in a bare repository. + +--force:: + Normally only fast-forward reference updates are performed. Specifying + this option allows non-fast forward updates. + +--shallow:: + Normally, git-fsck is invoked on each reference to assure there are no + missing objects. This option bypasses that checking, allowing shallow + copies. Use with caution, many git operations are not supported on + shallow repositories. + +file:: + Bundle file created by gitlink:git-bundle[1]. Default is bundle.zip. + +ERROR CHECKING +-------------- + +In addition to the checks mentioned under --force and --shallow above, +git-unbundle uses gitlink:git-unpack-objects[1] to update objects, and +gitlink:git-update-ref to update all references, and thus all the inherent +safety checks provided by those functions are in force. + +Author +------ +Written by Mark Levedahl + +GIT +--- +Part of the gitlink:git[7] suite -- 1.5.0.rc3.24.g0c5e