From: Dan McGee <dpmcgee@gmail.com>
To: Eric Hanchrow <offby1@blarg.net>
Cc: git@vger.kernel.org
Subject: Re: generated HTML contains broken links
Date: Fri, 28 Dec 2007 21:01:17 -0600 [thread overview]
Message-ID: <4775B87D.4010507@gmail.com> (raw)
In-Reply-To: <87sl1mqt10.fsf@offby1.atm01.sea.blarg.net>
On 12/28/2007 05:49 PM, Eric Hanchrow wrote:
> I'm just starting to play with git, and have checked it out (with "git
> clone git://git.kernel.org/pub/scm/git/git.git"), and built the
> documentation (cd Documentation; make), on Cygwin. I notice that the
> generated HTML docs are full of broken links -- for example, my file
> C:/cygwin/usr/local/src/git/Documentation/git.html includes this:
>
> git<a href="git-instaweb">1</a>
>
> but there is no document named "git-instaweb" on my disk; instead,
> it's named "git-instaweb.html".
>
> I'm using asciidoc version 8.2.4, if it matters.
We noticed this with the upgrade from Asciidoc 8.2.2 -> 8.2.3 on our project. It is broken in both the manpages and the HTML generated documentation. I've included an example below. So far, I haven't had luck tracking down the reason but I am looking into trying to fix this tonight. If anyone else is better with this stuff, it would be great if you could take a look.
Relevant email on the pacman-dev list [1]:
On Nov 9, 2007 4:05 PM, Andrew Fyfe <andrew@neptune-one.net> wrote:
> Did little digging, the breakage/change is in now asciidoc converts from asciidoc to xml (so it's
> not docbook-xsl). In 8.2.2 manlink:pacman.conf[5] expands to
>
> <citerefentry><refentrytitle>pacman.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
>
> in 8.2.3 it expands to
>
> man<ulink url="pacman.conf">5</ulink>,
Note that manlink is basically just a renamed gitlink, and can be found here:
<http://projects.archlinux.org/git/?p=pacman.git;a=blob;f=doc/asciidoc.conf>
-Dan
[1] <http://archlinux.org/pipermail/pacman-dev/2007-November/009937.html>
Generated man pages from Junio:
HOOKS
This command can run commit-msg, pre-commit, and post-commit hooks. See
[1]hooks for more information.
SEE ALSO
git-add(1), git-rm(1), git-mv(1), git-merge(1), git-commit-tree(1)
AUTHOR
Written by Linus Torvalds <torvalds@osdl.org> and Junio C Hamano
<junkio@cox.net>
GIT
Part of the git(7) suite
Man pages generated locally (with Asciidoc 8.2.3 or 8.2.5):
HOOKS
This command can run commit-msg, pre-commit, and post-commit hooks. See
hooks[5] for more information.
SEE ALSO
git1[1], git1[2], git1[8], git1[6], git1[9]
AUTHOR
Written by Linus Torvalds <torvalds@osdl.org> and Junio C Hamano
<junkio@cox.net>
GIT
Part of the git7[10] suite
next prev parent reply other threads:[~2007-12-29 3:01 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2007-12-28 23:49 generated HTML contains broken links Eric Hanchrow
2007-12-29 3:01 ` Dan McGee [this message]
2007-12-29 15:57 ` Miklos Vajna
2007-12-29 16:24 ` Dan McGee
2007-12-29 16:34 ` [PATCH] Documentation: rename gitlink macro to linkgit Dan McGee
2008-01-03 21:01 ` Junio C Hamano
2008-01-04 5:22 ` Yannick Gingras
2008-01-04 5:50 ` Junio C Hamano
2008-01-04 6:11 ` Yannick Gingras
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=4775B87D.4010507@gmail.com \
--to=dpmcgee@gmail.com \
--cc=git@vger.kernel.org \
--cc=offby1@blarg.net \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).