From e31bb3bb939a8feb7af472c55d95f41a90bbc438 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Mon, 15 Aug 2005 15:48:47 -0700 Subject: [PATCH] Add documentation for git repack and git-prune-packed. [jc: the patch forgot to update the main git.txt documentation, making all these new documentation practically no-op, so I added a minimum attempt linking them from there.] Signed-off-by: Ryan Anderson --- Documentation/git-pack-objects.txt | 4 ++++ Documentation/git-prune-packed.txt | 42 +++++++++++++++++++++++++++++++++++++ Documentation/git-repack-script.txt | 40 +++++++++++++++++++++++++++++++++++ Documentation/git.txt | 11 ++++++++++ 4 files changed, 97 insertions(+) create mode 100644 Documentation/git-prune-packed.txt create mode 100644 Documentation/git-repack-script.txt (limited to 'Documentation') diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt index 9628183143..7710be0851 100644 --- a/Documentation/git-pack-objects.txt +++ b/Documentation/git-pack-objects.txt @@ -74,6 +74,10 @@ Documentation ------------- Documentation by Junio C Hamano +See-Also +-------- +git-repack-script(1) git-prune-packed(1) + GIT --- Part of the link:git.html[git] suite diff --git a/Documentation/git-prune-packed.txt b/Documentation/git-prune-packed.txt new file mode 100644 index 0000000000..893c1df55e --- /dev/null +++ b/Documentation/git-prune-packed.txt @@ -0,0 +1,42 @@ +git-prune-packed(1) +===================== +v0.1, August 2005 + +NAME +---- +git-prune-packed - Program used to remove the extra object files that are now +residing in a pack file. + + +SYNOPSIS +-------- +'git-prune-packed' + +DESCRIPTION +----------- +This program search the GIT_OBJECT_DIR for all objects that currently exist in +a pack file as well as the independent object directories. + +All such extra objects are removed. + +A pack is a collection of objects, individually compressed, with delta +compression applied, stored in a single file, with an associated index file. + +Packs are used to reduce the load on mirror systems, backup engines, disk storage, etc. + +Author +------ +Written by Linus Torvalds + +Documentation +-------------- +Documentation by Ryan Anderson + +See-Also +-------- +git-pack-objects(1) git-repack-script(1) + +GIT +--- +Part of the link:git.html[git] suite + diff --git a/Documentation/git-repack-script.txt b/Documentation/git-repack-script.txt new file mode 100644 index 0000000000..497d0dfe80 --- /dev/null +++ b/Documentation/git-repack-script.txt @@ -0,0 +1,40 @@ +git-repack-script(1) +===================== +v0.1, August 2005 + +NAME +---- +git-repack-script - Script used to pack a repository from a collection of +objects into pack files. + + +SYNOPSIS +-------- +'git-repack-script' + +DESCRIPTION +----------- +This script is used to combine all objects that do not currently reside in a +"pack", into a pack. + +A pack is a collection of objects, individually compressed, with delta +compression applied, stored in a single file, with an associated index file. + +Packs are used to reduce the load on mirror systems, backup engines, disk storage, etc. + +Author +------ +Written by Linus Torvalds + +Documentation +-------------- +Documentation by Ryan Anderson + +See-Also +-------- +git-pack-objects(1) git-prune-packed(1) + +GIT +--- +Part of the link:git.html[git] suite + diff --git a/Documentation/git.txt b/Documentation/git.txt index dd805e3061..27f362626f 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -71,6 +71,13 @@ link:git-hash-object.html[git-hash-object]:: link:git-write-tree.html[git-write-tree]:: Creates a tree from the current cache +link:git-pack-objects.html[git-pack-objects]:: + Creates a packed archive of objects. + +link:git-prune-packed.html[git-prune-packed]:: + Remove extra objects that are already in pack files. + + Interrogation commands ~~~~~~~~~~~~~~~~~~~~~~ link:git-cat-file.html[git-cat-file]:: @@ -191,6 +198,10 @@ link:git-commit-script.html[git-commit-script]:: link:git-show-branches-script.html[git-show-branches-script]:: Show branches and their commits. +link:git-repack-script.html[git-repack-script]:: + Pack unpacked objects in a repository. + + Ancillary Commands ------------------ Manipulators: -- cgit v1.2.3