threads / patch / 12033

patchgit-pull documentation: fix linkgit in the --rebase option description.

Subject: [PATCH] git-pull documentation: fix linkgit in the --rebase option description.

## tl;dr

6 messages between Feb 11, 2008 and Feb 12, 2008. Diffs are folded; open one to read it.

replies: 5people: 3as markdown or json

Miklos Vajna· Feb 11, 2008, 13:28 UTC · lore

We do not have newlines before NOTEs at other places either, like git clone -s documentation and removing that newline turns 'linkgit:git\-rebase[1]' to '\fBgit-rebase\fR(1)' properly.

Signed-off-by: Miklos Vajna <vmiklos@frugalware.org>
---
 Documentation/git-pull.txt |    1 -
 1 files changed, 0 insertions(+), 1 deletions(-)
Show changes to Documentation/git-pull.txt +0 −1
diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt
index 4cc633a..b9bc6ed 100644
--- a/Documentation/git-pull.txt
+++ b/Documentation/git-pull.txt
@@ -39,7 +39,6 @@ include::merge-strategies.txt[]
 	there is a remote ref for the upstream branch, and this branch
 	was rebased since last fetched, the rebase uses that information
 	to avoid rebasing non-local changes.
-
 	*NOTE:* This is a potentially _dangerous_ mode of operation.
 	It rewrites history, which does not bode well when you
 	published that history already.  Do *not* use this option

-- 
1.5.4
Johannes Schindelin· Feb 11, 2008, 15:15 UTC · re: Miklos Vajna · lore

Re: [PATCH] git-pull documentation: fix linkgit in the --rebase option description.

Hi,
On Mon, 11 Feb 2008, Miklos Vajna wrote:
Show 12 quoted lines
> diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt
> index 4cc633a..b9bc6ed 100644
> --- a/Documentation/git-pull.txt
> +++ b/Documentation/git-pull.txt
> @@ -39,7 +39,6 @@ include::merge-strategies.txt[]
>  	there is a remote ref for the upstream branch, and this branch
>  	was rebased since last fetched, the rebase uses that information
>  	to avoid rebasing non-local changes.
> -
>  	*NOTE:* This is a potentially _dangerous_ mode of operation.
>  	It rewrites history, which does not bode well when you
>  	published that history already.  Do *not* use this option

The intention was to force a new paragraph. The *NOTE* should be loud and clear, so that those few people who read man pages are properly warned that --rebase is a dangerous option if you do not know what you are doing.

Ciao, Dscho

Miklos Vajna· Feb 11, 2008, 18:29 UTC · re: Johannes Schindelin · lore

Re: [PATCH] git-pull documentation: fix linkgit in the --rebase option description.

On Mon, Feb 11, 2008 at 03:15:31PM +0000, Johannes Schindelin <Johannes.Schindelin@gmx.de> wrote:
> The intention was to force a new paragraph.  The *NOTE* should be loud and 
> clear, so that those few people who read man pages are properly warned 
> that --rebase is a dangerous option if you do not know what you are doing.

i see your point and i played with it a bit, no success so far. if it becomes a new paragraph, the linkgit: is not processed. maybe it's an asciidoc bug?

(is it better to have it as a new paragraph with linkgit: shown? hmm)
thanks,
- VMiklos
Junio C Hamano· Feb 11, 2008, 19:10 UTC · re: Miklos Vajna · lore

Re: [PATCH] git-pull documentation: fix linkgit in the --rebase option description.

Miklos Vajna <vmiklos@frugalware.org> writes:
> I see your point and i played with it a bit, no success so far. If it
> becomes a new paragraph, the linkgit: is not processed. maybe it's an
> asciidoc bug?
You probably meant to do this, then.
 Documentation/git-pull.txt |   10 +++++-----
 1 files changed, 5 insertions(+), 5 deletions(-)
Show changes to Documentation/git-pull.txt +5 −5
diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt
index 4cc633a..179bdfc 100644
--- a/Documentation/git-pull.txt
+++ b/Documentation/git-pull.txt
@@ -39,11 +39,11 @@ include::merge-strategies.txt[]
 	there is a remote ref for the upstream branch, and this branch
 	was rebased since last fetched, the rebase uses that information
 	to avoid rebasing non-local changes.
-
-	*NOTE:* This is a potentially _dangerous_ mode of operation.
-	It rewrites history, which does not bode well when you
-	published that history already.  Do *not* use this option
-	unless you have read linkgit:git-rebase[1] carefully.
++
+*NOTE:* This is a potentially _dangerous_ mode of operation.
+It rewrites history, which does not bode well when you
+published that history already.  Do *not* use this option
+unless you have read linkgit:git-rebase[1] carefully.
 
 \--no-rebase::
 	Override earlier \--rebase.
Johannes Schindelin· Feb 11, 2008, 21:13 UTC · re: Junio C Hamano · lore

Re: [PATCH] git-pull documentation: fix linkgit in the --rebase option description.

Hi,
On Mon, 11 Feb 2008, Junio C Hamano wrote:
Show 7 quoted lines
> Miklos Vajna <vmiklos@frugalware.org> writes:
> 
> > I see your point and i played with it a bit, no success so far. If it
> > becomes a new paragraph, the linkgit: is not processed. maybe it's an
> > asciidoc bug?
> 
> You probably meant to do this, then.

Thanks. At some point, it feels (at least to me) that the ease of use of asciidoc just vanishes...

Ciao, Dscho

Miklos Vajna· Feb 12, 2008, 00:08 UTC · re: Junio C Hamano · lore

Re: [PATCH] git-pull documentation: fix linkgit in the --rebase option description.

On Mon, Feb 11, 2008 at 11:10:33AM -0800, Junio C Hamano <gitster@pobox.com> wrote:
Show 5 quoted lines
> > I see your point and i played with it a bit, no success so far. If it
> > becomes a new paragraph, the linkgit: is not processed. maybe it's an
> > asciidoc bug?
> 
> You probably meant to do this, then.

ah, great. then i'll send a patch to change git clone -s' NOTE like this.

thanks,
- VMiklos

← back to recent threads