All of lore.kernel.org
 help / color / mirror / Atom feed
From: David Greaves <david@dgreaves.com>
To: Junio C Hamano <junkio@cox.net>
Cc: Petr Baudis <pasky@ucw.cz>, git@vger.kernel.org
Subject: [BUG] in asciidoc was Re: [FILES] core-git documentation update
Date: Sun, 08 May 2005 22:25:36 +0100	[thread overview]
Message-ID: <427E83D0.5040607@dgreaves.com> (raw)
In-Reply-To: <7vpsw15xdf.fsf@assigned-by-dhcp.cox.net>

Junio C Hamano wrote:

>>>>>>"DG" == David Greaves <david@dgreaves.com> writes:
>>>>>>            
>>>>>>
>
>DG> it just makes across the board changes easier and at the minute the
>DG> stuff I've been doing is systemic.
>DG> I have no problems with breaking it up - hence the script...
>
>Monolithic version is easier to work with when there is only one
>or very few people working on it but when the document matures
>enough to describe the current state of affairs accurately
>enough, further changes would come almost solely from changing
>the programs the document describes.  At that point having
>separate files describing each program is easier to work with,
>and I think that point is now.
>  
>
I was waiting for comments on this set in case there were comments like:
every document should have 'x' or change all 'y' to 'z'
I fully intend to split it out...

I will send patches next time.

One thing I failed to mention.
There's a minor bug in asciidoc for which I've submitted a patch to the
author. IIRC the bug causes problems with the -man option and is
cosmetically wrong with the html.

>From the asciidoc docs:
The first manpage section is mandatory and must be called /NAME/ and
contain a single paragraph (usually a single line) consisting of a list
of one or more comma separated command name(s) separated from the
command purpose by a dash character. **The dash must have at least one
white space character on either side.**

However this is not enforced (or indeed possible) at the moment - the
NAME section seems to split on the first hyphen.

This patch fixes that for me.

--- /usr/bin/asciidoc.orig      2005-05-08 17:03:42.666249974 +0100
+++ /usr/bin/asciidoc   2005-05-08 16:56:00.518923960 +0100
@@ -1067,7 +1067,7 @@
                     error('malformed NAME section body')
                 lines = reader.read_until(r'^$')
                 s = string.join(lines)
-                mo = re.match(r'^(?P<manname>.*?)-(?P<manpurpose>.*)$',s)
+                mo =
re.match(r'^(?P<manname>.*?)\s+-\s+(?P<manpurpose>.*)$',s)
                 if not mo:
                     error('malformed NAME section body')
                 attrs['manname'] = string.strip(mo.group('manname'))



      reply	other threads:[~2005-05-08 21:18 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2005-05-08 17:22 [FILES] core-git documentation update David Greaves
2005-05-08 17:31 ` Petr Baudis
2005-05-08 17:42   ` David Greaves
2005-05-08 19:30     ` Junio C Hamano
2005-05-08 21:25       ` David Greaves [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=427E83D0.5040607@dgreaves.com \
    --to=david@dgreaves.com \
    --cc=git@vger.kernel.org \
    --cc=junkio@cox.net \
    --cc=pasky@ucw.cz \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.