threads / bug / 43264

doc bug?

Subject: doc bug?

## tl;dr

5 messages between Dec 8, 2006 and Dec 11, 2006.

replies: 4people: 3as markdown or json

Han-Wen Nienhuys· Dec 8, 2006, 17:07 UTC · lore

Hi,

while messing with GIT's build system, I got

**
asciidoc -b docbook -d manpage -f ../Documentation/asciidoc.conf ../Documentation/git-tools.txt
ERROR: git-tools.txt: line 2: malformed manpage title
ERROR: git-tools.txt: line 6: first section must be named NAME
ERROR: git-tools.txt: line 9: malformed NAME section body
FAILED: /home/lilydev/vc/git/Documentation/git-tools.txt: line 9: unexpected error:
------------------------------------------------------------
Traceback (most recent call last):
  File "/usr/bin/asciidoc", line 3639, in asciidoc
    document.translate()
  File "/usr/bin/asciidoc", line 966, in translate
    Header.translate()
  File "/usr/bin/asciidoc", line 1123, in translate
    attrs['manname'] = string.strip(mo.group('manname'))
AttributeError: 'NoneType' object has no attribute 'group'
------------------------------------------------------------
**

is this a new problem?  I'm on FC6, with  asciidoc 7.0.2

-- 
 Han-Wen Nienhuys - hanwen@xs4all.nl - http://www.xs4all.nl/~hanwen

Jonas Fonseca· Dec 9, 2006, 17:30 UTC · re: Han-Wen Nienhuys · lore

Re: doc bug?

On 12/8/06, Han-Wen Nienhuys <hanwen@xs4all.nl> wrote:

> Hi,

Hello,

Show 12 quoted lines

> while messing with GIT's build system, I got
>
> **
> asciidoc -b docbook -d manpage -f ../Documentation/asciidoc.conf ../Documentation/git-tools.txt
> ERROR: git-tools.txt: line 2: malformed manpage title
> ERROR: git-tools.txt: line 6: first section must be named NAME
> ERROR: git-tools.txt: line 9: malformed NAME section body
> FAILED: /home/lilydev/vc/git/Documentation/git-tools.txt: line 9: unexpected error:
> [traceback]
> **
>
> is this a new problem?  I'm on FC6, with  asciidoc 7.0.2

The git-tools.txt document is not intended to be a man page (there is no git-tools command) so it cannot be converted into a man page. You should be able to make a HTML document out of it, although the AsciiDoc formatting is not "optimal".

Han-Wen Nienhuys· Dec 9, 2006, 18:04 UTC · re: Jonas Fonseca · lore

Re: doc bug?

Jonas Fonseca escreveu:

>> is this a new problem?  I'm on FC6, with  asciidoc 7.0.2
> 
> The git-tools.txt document is not intended to be a man page

So why does the doc try make one for it? This is a bug, no?

Junio C Hamano· Dec 9, 2006, 18:42 UTC · re: Han-Wen Nienhuys · lore

Re: doc bug?

Han-Wen Nienhuys <hanwen@xs4all.nl> writes:

Show 8 quoted lines

> while messing with GIT's build system, I got
>
> **
> asciidoc -b docbook -d manpage -f ../Documentation/asciidoc.conf ../Documentation/git-tools.txt
> ERROR: git-tools.txt: line 2: malformed manpage title
> ERROR: git-tools.txt: line 6: first section must be named NAME
> ERROR: git-tools.txt: line 9: malformed NAME section body
> FAILED: /home/lilydev/vc/git/Documentation/git-tools.txt: line 9: unexpected error:

That is interesting. git-tools is listed on ARTICLES which is excluded from MAN1_TXT so the Makefile should not even try to run the above commandline that says 'manpage'.

At least that is what our Makefile intends to do.

So that means you may have found a bug in our Makefile, or your make (by the way I think we pretty much requires GNU make to build git), or perhaps both.

But I do not see an obvious breakage in our Makefile in this area...

Han-Wen Nienhuys· Dec 11, 2006, 13:54 UTC · re: Junio C Hamano · lore

Junio C Hamano escreveu:

Show 5 quoted lines

>> asciidoc -b docbook -d manpage -f ../Documentation/asciidoc.conf ../Documentation/git-tools.txt
>> ERROR: git-tools.txt: line 2: malformed manpage title
>> ERROR: git-tools.txt: line 6: first section must be named NAME
>> ERROR: git-tools.txt: line 9: malformed NAME section body
>> FAILED: /home/lilydev/vc/git/Documentation/git-tools.txt: line 9: unexpected error:

> So that means you may have found a bug in our Makefile, or your
> make (by the way I think we pretty much requires GNU make to
> build git), or perhaps both.

Hi,

it was my bad, caused by me tweaking the Makefiles. I will be posting the last version of my separate builddir patch separately, with support for the documentation as well. Can you have a look so I know whether it's worth investing any more time in?

Unfortunately, asciidoc doesn't seem to support a --include-path option or similar, so I can't get the documentation support to work completely.