Re: [PATCH] git-bundle(1): add no references required simplest case

From: Junio C Hamano <gitster@pobox.com>
Date: Jan 26, 2009, 19:53 UTC
Message-ID: <7vljsx6dzi.fsf@gitster.siamese.dyndns.org>
In-Reply-To: <87d4e97uxb.fsf_-_@jidanni.org>

jidanni@jidanni.org writes:

Show 15 quoted lines

> Signed-off-by: jidanni <jidanni@jidanni.org>
> ---
> See http://article.gmane.org/gmane.comp.version-control.git/103576
>  Documentation/git-bundle.txt |    7 +++++++
>  1 files changed, 7 insertions(+), 0 deletions(-)
>
> diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt
> index 1b66ab7..7c1e990 100644
> --- a/Documentation/git-bundle.txt
> +++ b/Documentation/git-bundle.txt
> @@ -164,6 +164,13 @@ $ git pull bundle
>  would treat it as if it is talking with a remote side over the
>  network.
>  
> +If a bundle requires no references, one may simply use:

Two nits.

 1. Bundle does not require reference;it requires commits.

 2. "One may simply use:" with a recipe without saying what the recipe is
    useful for is not very helpful.

The second point needs to be stressed. For example, you could say something like this:

        With any bundle, you may simply say:

                $ git ls-remote bundle.bdl

and it is a correct description if it is to see the refs in the bundle is what you want to do, but it does not help when cloning from it is what you want.

It would be a good practice to make the new part go with the flow of the existing examples. Adding the following at the end might be a better way to do this than your "init then pull" example:

	A complete bundle is one that does not require you to have any
	prerequiste object for you to extract its contents.  Not only you
	can fetch/pull from a bundle, you can clone from a complete bundle
	as if it is a remote repository, like this:

	----------------
        $ git clone /home/me/tmp/file.bdl mine.git
        ----------------

	This will define a remote called "origin" in the resulting
	repository that lets you fetch and pull from the bundle, just
	like the previous example lets you do with the remote called
	"bundle", and from then on you can fetch/pull to update the
	resulting mine.git repository after replacing the bundle you store
	at /home/me/tmp/file.bdl with incremental updates.