[PATCH 0/3] git-bundle.txt options clarification

[PATCH 0/3] git-bundle.txt options clarification

[Michael J Gruber]

This mini-series is the outcome of my attempt with the following command:

git bundle master~7..master~5

I understand (now) why it fails and why it must fail, but this should be
easier to grasp from the man page. Before amending it, the 1st two patches
do some systematic and coding resp. whitespace cleanup. Feel free to squash
as you deem appropriate.

Michael J Gruber (3):
  git-bundle.txt: Cleanup
  git-bundle.txt: whitespace cleanup
  git-bundle.txt: Clarify rev-list-args restrictions

 Documentation/git-bundle.txt |   73 +++++++++++++++++++++--------------------
 1 files changed, 37 insertions(+), 36 deletions(-)

-- 
1.7.2.1.52.g7f7860

[PATCH 1/3] git-bundle.txt: Cleanup

[Michael J Gruber]

Cleanup various spellings of the same argument, as well as the code
for the tilde: Since neither '~' nor '\~' work consistently, use
'{tilde}'.

Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net>
---
 Documentation/git-bundle.txt |   18 +++++++++---------
 1 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt
index a5ed8fb..2d92696 100644
--- a/Documentation/git-bundle.txt
+++ b/Documentation/git-bundle.txt
@@ -9,7 +9,7 @@ git-bundle - Move objects and refs by archive
 SYNOPSIS
 --------
 [verse]
-'git bundle' create <file> <git-rev-list args>
+'git bundle' create <file> <git-rev-list-args>
 'git bundle' verify <file>
 'git bundle' list-heads <file> [refname...]
 'git bundle' unbundle <file> [refname...]
@@ -35,7 +35,7 @@ OPTIONS
 
 create <file>::
        Used to create a bundle named 'file'.  This requires the
-       'git rev-list' arguments to define the bundle contents.
+       'git-rev-list-args' arguments to define the bundle contents.
 
 verify <file>::
        Used to check that a bundle file is valid and will apply
@@ -57,10 +57,10 @@ unbundle <file>::
        references matching those in the list are printed. This command is
        really plumbing, intended to be called only by 'git fetch'.
 
-[git-rev-list-args...]::
+<git-rev-list-args>::
        A list of arguments, acceptable to 'git rev-parse' and
        'git rev-list', that specifies the specific objects and references
-       to transport.  For example, `master\~10..master` causes the
+       to transport.  For example, `master{tilde}10..master` causes the
        current master reference to be packaged along with all objects
        added since its 10th ancestor commit.  There is no explicit
        limit to the number of references and objects that may be
@@ -79,12 +79,12 @@ SPECIFYING REFERENCES
 
 'git bundle' will only package references that are shown by
 'git show-ref': this includes heads, tags, and remote heads.  References
-such as `master\~1` cannot be packaged, but are perfectly suitable for
+such as `master{tilde}1` cannot be packaged, but are perfectly suitable for
 defining the basis.  More than one reference may be packaged, and more
 than one basis can be specified.  The objects packaged are those not
 contained in the union of the given bases.  Each basis can be
-specified explicitly (e.g. `^master\~10`), or implicitly (e.g.
-`master\~10..master`, `--since=10.days.ago master`).
+specified explicitly (e.g. `^master{tilde}10`), or implicitly (e.g.
+`master{tilde}10..master`, `--since=10.days.ago master`).
 
 It is very important that the basis used be held by the destination.
 It is okay to err on the side of caution, causing the bundle file
@@ -154,7 +154,7 @@ machineB$ git pull
 If you know up to what commit the intended recipient repository should
 have the necessary objects, you can use that knowledge to specify the
 basis, giving a cut-off point to limit the revisions and objects that go
-in the resulting bundle. The previous example used lastR2bundle tag
+in the resulting bundle. The previous example used the lastR2bundle tag
 for this purpose, but you can use any other options that you would give to
 the linkgit:git-log[1] command. Here are more examples:
 
@@ -194,7 +194,7 @@ references when fetching:
 $ git fetch mybundle master:localRef
 ----------------
 
-You can also see what references it offers.
+You can also see what references it offers:
 
 ----------------
 $ git ls-remote mybundle
-- 
1.7.2.1.52.g7f7860

Re: [PATCH 1/3] git-bundle.txt: Cleanup

[Thomas Rast]

Michael J Gruber wrote:
> Cleanup various spellings of the same argument
[...]
> -       'git rev-list' arguments to define the bundle contents.
> +       'git-rev-list-args' arguments to define the bundle contents.

As indicated by the Cc but not the text, this was fallout from my
automated replacements in 0b444cd (Documentation: spell 'git cmd'
without dash throughout, 2010-01-10).

An analogous change to one of your {tilde} replacements is already in
Jonathan's series.  The rest probably don't hurt, if only to drive
people towards a more consistent {tilde} spelling in the future.

So, Ack.

-- 
Thomas Rast
trast@{inf,student}.ethz.ch

Re: [PATCH 1/3] git-bundle.txt: Cleanup

[Michael J Gruber]

Thomas Rast venit, vidit, dixit 23.08.2010 13:59:
> Michael J Gruber wrote:
>> Cleanup various spellings of the same argument
> [...]
>> -       'git rev-list' arguments to define the bundle contents.
>> +       'git-rev-list-args' arguments to define the bundle contents.
> 
> As indicated by the Cc but not the text, this was fallout from my
> automated replacements in 0b444cd (Documentation: spell 'git cmd'
> without dash throughout, 2010-01-10).

No blame intended (and no "git blame" run). I cc'ed you as the doc
sheriff ;)

The change above was really about using the place holder name
consistently, which includes keeping the "-args".

> An analogous change to one of your {tilde} replacements is already in
> Jonathan's series.  The rest probably don't hurt, if only to drive

I was behind an idiotic firewall for the last 2 weeks which not only
blocked vpn and nntp but made it impossible to get larger chunks over
git:, git+ssh: or even scp (bundle) even though bandwidth was no
apparent issue. One of those countries which are currently argueing with
RIM. Makes you wonder how routinely they do content sniffing and how
they react to any (false) triggers. Might also have been an overly eager
institution, of course.

So I didn't see Jonathan's series in time.

> people towards a more consistent {tilde} spelling in the future.

I did some experimenting after noticing that I had many broken ~ (either
disappearing or appearing with spurious \ in the html). I might even
have come up with a rule, but I'm afraid these things change from
asciidoc version to asciidoc version, so that I went the chatty {tilde}.

Cheers (back on home soil),
Michael

[PATCH 2/3] git-bundle.txt: whitespace cleanup

[Michael J Gruber]

Use tabs, not 7 spaces.

Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net>
---
 Documentation/git-bundle.txt |   56 +++++++++++++++++++++---------------------
 1 files changed, 28 insertions(+), 28 deletions(-)

diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt
index 2d92696..3cdbc72 100644
--- a/Documentation/git-bundle.txt
+++ b/Documentation/git-bundle.txt
@@ -34,45 +34,45 @@ OPTIONS
 -------
 
 create <file>::
-       Used to create a bundle named 'file'.  This requires the
-       'git-rev-list-args' arguments to define the bundle contents.
+	Used to create a bundle named 'file'.  This requires the
+	'git-rev-list-args' arguments to define the bundle contents.
 
 verify <file>::
-       Used to check that a bundle file is valid and will apply
-       cleanly to the current repository.  This includes checks on the
-       bundle format itself as well as checking that the prerequisite
-       commits exist and are fully linked in the current repository.
-       'git bundle' prints a list of missing commits, if any, and exits
-       with a non-zero status.
+	Used to check that a bundle file is valid and will apply
+	cleanly to the current repository.  This includes checks on the
+	bundle format itself as well as checking that the prerequisite
+	commits exist and are fully linked in the current repository.
+	'git bundle' prints a list of missing commits, if any, and exits
+	with a non-zero status.
 
 list-heads <file>::
-       Lists the references defined in the bundle.  If followed by a
-       list of references, only references matching those given are
-       printed out.
+	Lists the references defined in the bundle.  If followed by a
+	list of references, only references matching those given are
+	printed out.
 
 unbundle <file>::
-       Passes the objects in the bundle to 'git index-pack'
-       for storage in the repository, then prints the names of all
-       defined references. If a list of references is given, only
-       references matching those in the list are printed. This command is
-       really plumbing, intended to be called only by 'git fetch'.
+	Passes the objects in the bundle to 'git index-pack'
+	for storage in the repository, then prints the names of all
+	defined references. If a list of references is given, only
+	references matching those in the list are printed. This command is
+	really plumbing, intended to be called only by 'git fetch'.
 
 <git-rev-list-args>::
-       A list of arguments, acceptable to 'git rev-parse' and
-       'git rev-list', that specifies the specific objects and references
-       to transport.  For example, `master{tilde}10..master` causes the
-       current master reference to be packaged along with all objects
-       added since its 10th ancestor commit.  There is no explicit
-       limit to the number of references and objects that may be
-       packaged.
+	A list of arguments, acceptable to 'git rev-parse' and
+	'git rev-list', that specifies the specific objects and references
+	to transport.  For example, `master{tilde}10..master` causes the
+	current master reference to be packaged along with all objects
+	added since its 10th ancestor commit.  There is no explicit
+	limit to the number of references and objects that may be
+	packaged.
 
 
 [refname...]::
-       A list of references used to limit the references reported as
-       available. This is principally of use to 'git fetch', which
-       expects to receive only those references asked for and not
-       necessarily everything in the pack (in this case, 'git bundle' acts
-       like 'git fetch-pack').
+	A list of references used to limit the references reported as
+	available. This is principally of use to 'git fetch', which
+	expects to receive only those references asked for and not
+	necessarily everything in the pack (in this case, 'git bundle' acts
+	like 'git fetch-pack').
 
 SPECIFYING REFERENCES
 ---------------------
-- 
1.7.2.1.52.g7f7860

[PATCH 3/3] git-bundle.txt: Clarify rev-list-args restrictions

[Michael J Gruber]

Currently, one could think that 'git bundle create' groks
any 'git rev-list' expression. But in fact it requires a named reference
to be present. Try and make this clearer.

Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net>
---
 Documentation/git-bundle.txt |    3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)

diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt
index 3cdbc72..38e59af 100644
--- a/Documentation/git-bundle.txt
+++ b/Documentation/git-bundle.txt
@@ -59,7 +59,8 @@ unbundle <file>::
 
 <git-rev-list-args>::
 	A list of arguments, acceptable to 'git rev-parse' and
-	'git rev-list', that specifies the specific objects and references
+	'git rev-list' (and containg a named ref, see SPECIFYING REFERENCES
+	below), that specifies the specific objects and references
 	to transport.  For example, `master{tilde}10..master` causes the
 	current master reference to be packaged along with all objects
 	added since its 10th ancestor commit.  There is no explicit
-- 
1.7.2.1.52.g7f7860

Re: [PATCH 3/3] git-bundle.txt: Clarify rev-list-args restrictions

[Thomas Rast]

Michael J Gruber wrote:
> diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt
> index 3cdbc72..38e59af 100644
> --- a/Documentation/git-bundle.txt
> +++ b/Documentation/git-bundle.txt
> @@ -59,7 +59,8 @@ unbundle <file>::
>  
>  <git-rev-list-args>::
>  	A list of arguments, acceptable to 'git rev-parse' and
> -	'git rev-list', that specifies the specific objects and references
> +	'git rev-list' (and containg a named ref, see SPECIFYING REFERENCES
> +	below), that specifies the specific objects and references
>  	to transport.  For example, `master{tilde}10..master` causes the
>  	current master reference to be packaged along with all objects
>  	added since its 10th ancestor commit.  There is no explicit

Ack on this, too; having it point at "Specifying References" is a good
thing.

-- 
Thomas Rast
trast@{inf,student}.ethz.ch