Clarify man page.
authorJoey Hess <joey@kitenet.net>
Thu, 7 Jul 2011 16:17:15 +0000 (12:17 -0400)
committerJoey Hess <joey@kitenet.net>
Thu, 7 Jul 2011 16:17:15 +0000 (12:17 -0400)
debian/changelog
pristine-tar

index ed878f5..033733e 100644 (file)
@@ -1,3 +1,9 @@
+pristine-tar (1.14) UNRELEASED; urgency=low
+
+  * Clarify man page.
+
+ -- Joey Hess <joeyh@debian.org>  Thu, 07 Jul 2011 12:17:00 -0400
+
 pristine-tar (1.13) unstable; urgency=low
 
   [ Faidon Liambotis ]
index 1aae144..78a366e 100755 (executable)
@@ -55,12 +55,13 @@ I<tarball>, and commits it to version control. The B<pristine-tar checkout>
 command can later be used to recreate the original tarball based only
 on the information stored in version control.
 
-For B<pristine-tar checkout> to work, you also need to store the precise
-contents of the tarball in version control. To specify in which tag (or
-branch or other treeish object) it's stored, use the I<upstream> parameter.
-This defaults to "refs/heads/upstream", or if there's no such branch, any
+The I<upstream> parameter specifies the tag or branch that contains the
+same content that is present in the tarball. This defaults to
+"refs/heads/upstream", or if there's no such branch, any
 branch matching "upstream". The name of the tree it points to will be
-recorded for later use by B<pristine-tar checkout>.
+recorded for later use by B<pristine-tar checkout>. Note that the content
+does not need to be 100% identical to the content of the tarball, but
+if it is not, additional space will be used in the delta file.
 
 The delta files are stored in a branch named "pristine-tar", with filenames
 corresponding to the input tarball, with ".delta" appended. This