[PATCH] git-pack-objects.txt: Make wording slightly less ambiguous

[PATCH] git-pack-objects.txt: Make wording slightly less ambiguous

[Peter Eriksen]

It is a bit confusing on first read, that

        "The packed archive format (.pack) is designed
        to be unpackable..."

Signed-off-by: Peter Eriksen <s022018@student.dtu.dk>
---
 Documentation/git-pack-objects.txt |    5 +++--
 1 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt
index eed0a94..3a1be08 100644
--- a/Documentation/git-pack-objects.txt
+++ b/Documentation/git-pack-objects.txt
@@ -22,8 +22,9 @@ archive with specified base-name, or to the standard output.
 A packed archive is an efficient way to transfer set of objects
 between two repositories, and also is an archival format which
 is efficient to access.  The packed archive format (.pack) is
-designed to be unpackable without having anything else, but for
-random access, accompanied with the pack index file (.idx).
+designed to be self contained so that it can be unpacked without
+any further information, but for fast, random access to the objects
+in the pack, a pack index file (.idx) will be generated.
 
 Placing both in the pack/ subdirectory of $GIT_OBJECT_DIRECTORY (or
 any of the directories on $GIT_ALTERNATE_OBJECT_DIRECTORIES)
-- 
1.5.5-rc3.GIT

Re: [PATCH] git-pack-objects.txt: Make wording slightly less ambiguous

[Shawn O. Pearce]

Peter Eriksen <s022018@student.dtu.dk> wrote:
> It is a bit confusing on first read, that
> 
>         "The packed archive format (.pack) is designed
>         to be unpackable..."
> 
> Signed-off-by: Peter Eriksen <s022018@student.dtu.dk>

Yea, this is a good improvement in readability.  I can't even
make sense out of the old language, and I know how this works.

:-)

> diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt
> index eed0a94..3a1be08 100644
> --- a/Documentation/git-pack-objects.txt
> +++ b/Documentation/git-pack-objects.txt
> @@ -22,8 +22,9 @@ archive with specified base-name, or to the standard output.
>  A packed archive is an efficient way to transfer set of objects
>  between two repositories, and also is an archival format which
>  is efficient to access.  The packed archive format (.pack) is
> -designed to be unpackable without having anything else, but for
> -random access, accompanied with the pack index file (.idx).
> +designed to be self contained so that it can be unpacked without
> +any further information, but for fast, random access to the objects
> +in the pack, a pack index file (.idx) will be generated.
>  
>  Placing both in the pack/ subdirectory of $GIT_OBJECT_DIRECTORY (or
>  any of the directories on $GIT_ALTERNATE_OBJECT_DIRECTORIES)

-- 
Shawn.