summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorDavid Greaves <david@dgreaves.com>2005-05-22 17:44:17 (GMT)
committerLinus Torvalds <torvalds@ppc970.osdl.org>2005-05-22 18:07:22 (GMT)
commit2aef5bbae99aeba3551408eae13faea02bf55b67 (patch)
tree99282828d5af15b0af0d0eac13a5b1194e88342c /Documentation
parent7096a645cde91c96ce849c43750c04433164418c (diff)
downloadgit-2aef5bbae99aeba3551408eae13faea02bf55b67.zip
git-2aef5bbae99aeba3551408eae13faea02bf55b67.tar.gz
git-2aef5bbae99aeba3551408eae13faea02bf55b67.tar.bz2
[PATCH] Docs - delta object
Added delta documentation Signed-off-by: David Greaves <david@dgreaves.com> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git-fsck-cache.txt5
-rw-r--r--Documentation/git-mkdelta.txt45
-rw-r--r--Documentation/git.txt3
3 files changed, 52 insertions, 1 deletions
diff --git a/Documentation/git-fsck-cache.txt b/Documentation/git-fsck-cache.txt
index bcd3b0a..c05b1bf 100644
--- a/Documentation/git-fsck-cache.txt
+++ b/Documentation/git-fsck-cache.txt
@@ -9,7 +9,7 @@ git-fsck-cache - Verifies the connectivity and validity of the objects in the da
SYNOPSIS
--------
-'git-fsck-cache' [--tags] [--root] [[--unreachable] [--cache] <object>\*]
+'git-fsck-cache' [--tags] [--root] [--delta-depth] [[--unreachable] [--cache] <object>\*]
DESCRIPTION
-----------
@@ -34,6 +34,9 @@ OPTIONS
Consider any object recorded in the cache also as a head node for
an unreachability trace.
+--delta-depth::
+ Report back the length of the longest delta chain found.
+
It tests SHA1 and general object sanity, and it does full tracking of
the resulting reachability and everything else. It prints out any
corruption it finds (missing or bad objects), and if you use the
diff --git a/Documentation/git-mkdelta.txt b/Documentation/git-mkdelta.txt
new file mode 100644
index 0000000..240d59a
--- /dev/null
+++ b/Documentation/git-mkdelta.txt
@@ -0,0 +1,45 @@
+git-mkdelta(1)
+==============
+May 2005
+
+NAME
+----
+git-mkdelta - Creates a delta object
+
+
+SYNOPSIS
+--------
+'git-mkdelta' [-v] [-d N | --max-depth=N ] <reference_object> <target_object> [ <next_object> ... ]
+
+DESCRIPTION
+-----------
+Creates a delta object to replace <reference_object> by using an
+ordered list of potential objects to deltafy against earlier objects
+in the list.
+
+A cap on the depth of delta references can be provided as well,
+otherwise the default is to not have any limit. A limit of 0 will
+also undeltafy a given object.
+
+
+OPTIONS
+-------
+-v::
+ Verbose
+
+-d|--max-depth::
+ limit the number of delta references in a chain
+ If 0 then all objects are undeltafied.
+
+Author
+------
+Git is written by Linus Torvalds <torvalds@osdl.org> and the git-list <git@vger.kernel.org>.
+
+Documentation
+--------------
+Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
+
+GIT
+---
+Part of the link:git.html[git] suite
+
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 89e4cf7..7edbcc3 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -51,6 +51,9 @@ link:git-init-db.html[git-init-db]::
link:git-merge-base.html[git-merge-base]::
Finds as good a common ancestor as possible for a merge
+link:git-mkdelta.html[git-mkdelta]::
+ Creates a delta object
+
link:git-mktag.html[git-mktag]::
Creates a tag object