Re: [PATCH] pack-objects: name pack files after trailer hash
- From
Jeff King <peff@peff.net>
- Date
- Dec 16, 2013, 19:04 UTC
- Message-ID
- <20131216190445.GB29324@sigill.intra.peff.net>
- In-Reply-To
- <52AEAEB2.6060203@alum.mit.edu>
On Mon, Dec 16, 2013 at 08:41:38AM +0100, Michael Haggerty wrote:
Show 14 quoted lines
> The old naming scheme is documented in
> Documentation/git-pack-objects.txt, under "OPTIONS" -> "base-name":
>
> > base-name::
> > Write into a pair of files (.pack and .idx), using
> > <base-name> to determine the name of the created file.
> > When this option is used, the two files are written in
> > <base-name>-<SHA-1>.{pack,idx} files. <SHA-1> 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.
>
> The documentation should either be updated or the description of the
> naming scheme should be removed altogether.Thanks. I looked in Documentation/technical for anything to update, but didn't imagine we would be advertising the format in the user-facing documentation. :)
The original patch is in next, so here's one on top. I just updated the description. I was tempted to explicitly say something like "this is opaque and meaningless to you, don't rely on it", but I don't know that there is any need.
-- >8 -- Subject: docs: update pack-objects "base-name" description
As of 1190a1a, the SHA-1 used to determine the filename is now calculated differently. Update the documentation to reflect this.
Noticed-by: Michael Haggerty <mhagger@alum.mit.edu> Signed-off-by: Jeff King <peff@peff.net> --- On top of jk/name-pack-after-byte-representations, naturally.
Documentation/git-pack-objects.txt | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt index d94edcd..c69affc 100644 --- a/Documentation/git-pack-objects.txt +++ b/Documentation/git-pack-objects.txt @@ -51,8 +51,7 @@ base-name:: <base-name> to determine the name of the created file. When this option is used, the two files are written in <base-name>-<SHA-1>.{pack,idx} files. <SHA-1> is a hash - of the sorted object names to make the resulting filename - based on the pack content, and written to the standard + of the bytes of the packfile, and is written to the standard output of the command. --stdout::
-- 1.8.5.524.g6743da6