threads / discuss / 11718

Query about documentation of git pull -n

Subject: Query about documentation of git pull -n

## tl;dr

8 messages between Jan 24, 2008 and Jan 25, 2008.

replies: 7people: 4as markdown or json

Anthony Bolton· Jan 24, 2008, 08:51 UTC · lore
Comment from a new user:
 
The git-pull man pages imply that "git pull -n" and "git pull --no-tags"
are the same, but -n seems to do something different entirely (same with
git fetch). I found this in msysgit but the msysgit boys say that it's
actually a problem with core git.
 
If -n is intended to be different from --no-tags than can you update the
documentation please?
 
Regards,
Anthony
____________________________________________________________

Anthony Bolton phone: +44 (0)1225 475290, email: anthony.bolton@ipl.com

IPL Information Processing Limited www.ipl.com ____________________________________________________________

The information transmitted is intended only for the person or entity to which it is addressed and may contain confidential and/or privileged material. If you are not the addressee, any disclosure, reproduction, copying, distribution, or other dissemination or use of this communication is strictly prohibited. If you have received this transmission in error please notify the sender immediately and then delete this email.

Any representations or commitments expressed in this email are subject to contract.

This message has been scanned for viruses and dangerous content. However, it is essential that the recipient also checks this message using commercially available mail scanning and anti-virus software. IPL Information Processing Limited accepts no liability for any loss or damage resulting from any virus or other dangerous content in this message.

IPL Information Processing Limited is registered in England and Wales under company registration number 1418818. Registration took place at Cardiff on 10 May 1979. IPL Information Processing Limited's registered office and normal place of business is Eveleigh House, Grove Street, Bath, BA1 5LR, United Kingdom. IPL is also registered for Value Added Tax (VAT) under registration number GB 601 2931 83.

Johannes Schindelin· Jan 24, 2008, 11:01 UTC · re: Anthony Bolton · lore

Re: Query about documentation of git pull -n

Hi,
On Thu, 24 Jan 2008, Anthony Bolton wrote:
Show 5 quoted lines
> Comment from a new user:
>  The git-pull man pages imply that "git pull -n" and "git pull 
> --no-tags" are the same, but -n seems to do something different entirely 
> (same with git fetch). I found this in msysgit but the msysgit boys say 
> that it's actually a problem with core git.

FWIW I am that msysgit boy. And I did not say anything about git-fetch, but only about git-pull. I even said that "-n" means "--no-summary" to git-pull.

> If -n is intended to be different from --no-tags than can you update the 
> documentation please?

That is such a low-hanging fruit. Since you apparently use git yourself, there is not much left to learn in order to fix this bug. IOW this is a perfect occasion to get just a little involved in the git development.

Just look at Documentation/diff-options.txt for an example how to use the "ifdef::" construct, and then use that construct in Documentation/fetch-options.txt.

Hth, Dscho

Miklos Vajna· Jan 24, 2008, 23:24 UTC · re: Johannes Schindelin · lore

[PATCH] git pull manpage: don't include -n from fetch-options.txt

The -n option stands for --no-summary in git pull
Signed-off-by: Miklos Vajna <vmiklos@frugalware.org>
---
 Documentation/fetch-options.txt |    2 ++
 Documentation/git-pull.txt      |    1 +
 2 files changed, 3 insertions(+), 0 deletions(-)
diff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt
index 61e48cc..0a1ce68 100644
--- a/Documentation/fetch-options.txt
+++ b/Documentation/fetch-options.txt
@@ -23,11 +23,13 @@
 	fetches is a descendant of `<lbranch>`.  This option
 	overrides that check.
 
+ifndef::git-pull[]
 -n, \--no-tags::
 	By default, `git-fetch` fetches tags that point at
 	objects that are downloaded from the remote repository
 	and stores them locally.  This option disables this
 	automatic tag following.
+endif::git-pull[]
 
 -t, \--tags::
 	Most of the tags are fetched automatically as branch
diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt
index 77fdaf1..f9f1e0d 100644
--- a/Documentation/git-pull.txt
+++ b/Documentation/git-pull.txt
@@ -25,6 +25,7 @@ OPTIONS
 -------
 include::merge-options.txt[]
 
+:git-pull: 1
 include::fetch-options.txt[]
 
 include::pull-fetch-param.txt[]

-- 
1.5.4.rc4-dirty
Johannes Schindelin· Jan 24, 2008, 23:59 UTC · re: Miklos Vajna · lore

Re: [PATCH] git pull manpage: don't include -n from fetch-options.txt

Hi,
On Fri, 25 Jan 2008, Miklos Vajna wrote:
> The -n option stands for --no-summary in git pull

Very nice, Anthony... uhm, oh! Okay, I take that back. Very nice, Miklos!

Thanks, Dscho

Junio C Hamano· Jan 25, 2008, 01:36 UTC · re: Miklos Vajna · lore

Re: [PATCH] git pull manpage: don't include -n from fetch-options.txt

Miklos Vajna <vmiklos@frugalware.org> writes:
> The -n option stands for --no-summary in git pull
Ok, but does that mean --no-tags does not exist there?
Miklos Vajna· Jan 25, 2008, 09:28 UTC · re: Junio C Hamano · lore

[PATCH] git pull manpage: don't include -n from fetch-options.txt

The -n option stands for --no-summary in git pull
Signed-off-by: Miklos Vajna <vmiklos@frugalware.org>
---
On Thu, Jan 24, 2008 at 05:36:33PM -0800, Junio C Hamano <gitster@pobox.com> wrote:
> > The -n option stands for --no-summary in git pull
>
> Ok, but does that mean --no-tags does not exist there?

Oops, my bad. Here is an updated patch to just remove '-n' and keep '--no-tags'.

 Documentation/fetch-options.txt |    5 +++++
 Documentation/git-pull.txt      |    1 +
 2 files changed, 6 insertions(+), 0 deletions(-)
diff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt
index 61e48cc..702f953 100644
--- a/Documentation/fetch-options.txt
+++ b/Documentation/fetch-options.txt
@@ -23,7 +23,12 @@
 	fetches is a descendant of `<lbranch>`.  This option
 	overrides that check.
 
+ifndef::git-pull[]
 -n, \--no-tags::
+endif::git-pull[]
+ifdef::git-pull[]
+\--no-tags::
+endif::git-pull[]
 	By default, `git-fetch` fetches tags that point at
 	objects that are downloaded from the remote repository
 	and stores them locally.  This option disables this
diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt
index 77fdaf1..f9f1e0d 100644
--- a/Documentation/git-pull.txt
+++ b/Documentation/git-pull.txt
@@ -25,6 +25,7 @@ OPTIONS
 -------
 include::merge-options.txt[]
 
+:git-pull: 1
 include::fetch-options.txt[]
 
 include::pull-fetch-param.txt[]

-- 
1.5.4.rc4-dirty
Johannes Schindelin· Jan 25, 2008, 10:17 UTC · re: Miklos Vajna · lore

[PATCH] git pull manpage: don't include -n from fetch-options.txt

From: Miklos Vajna <vmiklos@frugalware.org>
The -n option stands for --no-summary in git pull
[jes: reworded the description to avoid mentioning 'git-fetch';
 also exclude '-n' conditional on git-pull -- ugly because of
 the missing "else" statement in asciidoc]
Signed-off-by: Miklos Vajna <vmiklos@frugalware.org>
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
---
	On Fri, 25 Jan 2008, Miklos Vajna wrote:
	> On Thu, Jan 24, 2008 at 05:36:33PM -0800, Junio C Hamano 
	> <gitster@pobox.com> wrote:
	>
	> > > The -n option stands for --no-summary in git pull
	> >
	> > Ok, but does that mean --no-tags does not exist there?
	> 
	> Oops, my bad. Here is an updated patch to just remove '-n' and 
	> keep '--no-tags'.
	How about this instead?
 Documentation/fetch-options.txt |   12 ++++++++----
 Documentation/git-pull.txt      |    1 +
 2 files changed, 9 insertions(+), 4 deletions(-)
diff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt
index 61e48cc..b675911 100644
--- a/Documentation/fetch-options.txt
+++ b/Documentation/fetch-options.txt
@@ -23,11 +23,15 @@
 	fetches is a descendant of `<lbranch>`.  This option
 	overrides that check.
 
+ifdef::git-pull[]
+\--no-tags::
+endif::git-pull[]
+ifndef::git-pull[]
 -n, \--no-tags::
-	By default, `git-fetch` fetches tags that point at
-	objects that are downloaded from the remote repository
-	and stores them locally.  This option disables this
-	automatic tag following.
+endif::git-pull[]
+	By default, tags that point at objects that are downloaded
+	from the remote repository are fetched and stored locally.
+	This option disables this automatic tag following.
 
 -t, \--tags::
 	Most of the tags are fetched automatically as branch
diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt
index 77fdaf1..f9f1e0d 100644
--- a/Documentation/git-pull.txt
+++ b/Documentation/git-pull.txt
@@ -25,6 +25,7 @@ OPTIONS
 -------
 include::merge-options.txt[]
 
+:git-pull: 1
 include::fetch-options.txt[]
 
 include::pull-fetch-param.txt[]

-- 
1.5.4.rc4.36.g6e122
Miklos Vajna· Jan 25, 2008, 22:13 UTC · re: Johannes Schindelin · lore

Re: [PATCH] git pull manpage: don't include -n from fetch-options.txt

On Fri, Jan 25, 2008 at 10:17:38AM +0000, Johannes Schindelin <Johannes.Schindelin@gmx.de> wrote:
> [jes: reworded the description to avoid mentioning 'git-fetch';
>  also exclude '-n' conditional on git-pull -- ugly because of
>  the missing "else" statement in asciidoc]

right, i should have noticed that we should not include git-fetch in the git pull manpage :)

thanks,
- VMiklos

← back to recent threads