threads / discuss / 1815

PATCH Documentation/git-rev-list.txt typo fix

Subject: PATCH Documentation/git-rev-list.txt typo fix

## tl;dr

7 messages between Sep 15, 2005 and Sep 16, 2005.

replies: 6people: 4as markdown or json

jdl@freescale.com· Sep 15, 2005, 22:40 UTC · lore

I'm not positive what the doc conventions are, but I think something like this patch fixes the "superscript" problem on the git-rev-list doc page.

Signed-off-by: Jon Loeliger <jdl@freescale.com>
---
diff --git a/Documentation/git-rev-list.txt b/Documentation/git-rev-list.txt
--- a/Documentation/git-rev-list.txt
+++ b/Documentation/git-rev-list.txt
@@ -32,8 +32,8 @@ I have the commit object 'bar', but not

 The *--bisect* flag limits output to the one commit object which is
 roughly halfway between the included and excluded commits. Thus,
-if "git-rev-list --bisect foo ^bar ^baz" outputs 'midpoint', the output
-of "git-rev-list foo ^midpoint" and "git-rev-list midpoint ^bar ^baz"
+if 'git-rev-list --bisect foo ^bar ^baz' outputs 'midpoint', the output
+of 'git-rev-list foo ^midpoint' and 'git-rev-list midpoint ^bar ^baz'
 would be of roughly the same length. Finding the change which introduces
 a regression is thus reduced to a binary search: repeatedly generate and
 test new 'midpoint's until the commit chain is of length one.
Peter Hagervall· Sep 16, 2005, 14:24 UTC · re: jdl@freescale.com · lore

Re: PATCH Documentation/git-rev-list.txt typo fix

On Thu, Sep 15, 2005 at 05:40:13PM -0500, jdl@freescale.com wrote:
Show 5 quoted lines
> I'm not positive what the doc conventions are, but I think
> something like this patch fixes the "superscript" problem
> on the git-rev-list doc page.
> 
> Signed-off-by: Jon Loeliger <jdl@freescale.com>
<snip>
> -if "git-rev-list --bisect foo ^bar ^baz" outputs 'midpoint', the output
> -of "git-rev-list foo ^midpoint" and "git-rev-list midpoint ^bar ^baz"
> +if 'git-rev-list --bisect foo ^bar ^baz' outputs 'midpoint', the output
> +of 'git-rev-list foo ^midpoint' and 'git-rev-list midpoint ^bar ^baz'
<snip>

This causes a mismatch in <emphasis> and <superscript> tags, one way of fixing it is having no more than one caret symbol per line, which is the only solution I found in the asciidoc documentation. Ugly, but it works.

Signed-off-by: Peter Hagervall <hager@cs.umu.se>
---
diff --git a/Documentation/git-rev-list.txt b/Documentation/git-rev-list.txt
--- a/Documentation/git-rev-list.txt
+++ b/Documentation/git-rev-list.txt
@@ -32,8 +32,11 @@ I have the commit object 'bar', but not 
 
 The *--bisect* flag limits output to the one commit object which is
 roughly halfway between the included and excluded commits. Thus,
-if 'git-rev-list --bisect foo ^bar ^baz' outputs 'midpoint', the output
-of 'git-rev-list foo ^midpoint' and 'git-rev-list midpoint ^bar ^baz'
+if 'git-rev-list --bisect foo ^bar
+^baz' outputs 'midpoint', the output
+of 'git-rev-list foo ^midpoint' and 'git-rev-list midpoint
+^bar
+^baz'
 would be of roughly the same length. Finding the change which introduces
 a regression is thus reduced to a binary search: repeatedly generate and
 test new 'midpoint's until the commit chain is of length one.
Junio C Hamano· Sep 16, 2005, 16:31 UTC · re: Peter Hagervall · lore

Re: PATCH Documentation/git-rev-list.txt typo fix

Peter Hagervall <hager@cs.umu.se> writes:
> This causes a mismatch in <emphasis> and <superscript> tags, one way of
> fixing it is having no more than one caret symbol per line, which is the
> only solution I found in the asciidoc documentation. Ugly, but it works.
Thanks.
Sigh...
Chris Wright· Sep 16, 2005, 20:02 UTC · re: Junio C Hamano · lore

Re: PATCH Documentation/git-rev-list.txt typo fix

* Junio C Hamano (junkio@cox.net) wrote:
Show 7 quoted lines
> Peter Hagervall <hager@cs.umu.se> writes:
> 
> > This causes a mismatch in <emphasis> and <superscript> tags, one way of
> > fixing it is having no more than one caret symbol per line, which is the
> > only solution I found in the asciidoc documentation. Ugly, but it works.
> 
> Thanks.
This is breaking the build.  Reverting fixes the build...

[chrisw@vas Documentation]$ make git-rev-list.1 asciidoc -b docbook -d manpage git-rev-list.txt xmlto man git-rev-list.xml xmlto: input does not validate (status 1) /home/chrisw/git/git/git/Documentation/git-rev-list.xml:38: parser error : Opening and ending tag mismatch: superscript line 38 and emphasis of <emphasis>git-rev-list foo <superscript>midpoint</emphasis> and <emphasis>git ^ /home/chrisw/git/git/git/Documentation/git-rev-list.xml:38: parser error : Opening and ending tag mismatch: emphasis line 38 and superscript perscript>midpoint</emphasis> and <emphasis>git-rev-list midpoint </superscript> ^make: *** [git-rev-list.1] Error 1 rm git-rev-list.xml

thanks, -chris

Chris Wright· Sep 16, 2005, 20:06 UTC · re: Chris Wright · lore

Re: PATCH Documentation/git-rev-list.txt typo fix

* Chris Wright (chrisw@osdl.org) wrote:
Show 10 quoted lines
> * Junio C Hamano (junkio@cox.net) wrote:
> > Peter Hagervall <hager@cs.umu.se> writes:
> > 
> > > This causes a mismatch in <emphasis> and <superscript> tags, one way of
> > > fixing it is having no more than one caret symbol per line, which is the
> > > only solution I found in the asciidoc documentation. Ugly, but it works.
> > 
> > Thanks.
> 
> This is breaking the build.  Reverting fixes the build...

Err, ignore me. I was one patch behind. That patch from Peter fixes the broken build introduced by Jon.

thanks, -chris

← back to recent threads