Re: [Xen-devel] [PATCH 13 of 17] docs: generate an index for the html output

[Roger Pau Monnà <roger.pau@xxxxxxxxxxxxx>]

2011/11/17 Ian Campbell <ian.campbell@xxxxxxxxxx>:
> # HG changeset patch
> # User Ian Campbell <ian.campbell@xxxxxxxxxx>
> # Date 1321542075 0
> # Node ID 8f2404eef8fac8020528b408b3a958d81cbb73c0
> # Parent Âc1f8406da50743cd0597b93c4b5b8b6ff03ede42
> docs: generate an index for the html output
>
> nb: I'm not a Perl wizard...
>
> Signed-off-by: Ian Campbell <ian.campbell@xxxxxxxxxx>
>
> diff -r c1f8406da507 -r 8f2404eef8fa docs/INDEX
> --- /dev/null  Thu Jan 01 00:00:00 1970 +0000
> +++ b/docs/INDEX Â Â Â ÂThu Nov 17 15:01:15 2011 +0000
> @@ -0,0 +1,5 @@
> +misc/hvm-emulated-unplug    Xen HVM emulated device unplug protocol
> +
> +# These are not all that useful anymore, hide them from the index
> +interface/index            ÂNO-INDEX
> +user/index           NO-INDEX
> diff -r c1f8406da507 -r 8f2404eef8fa docs/Makefile
> --- a/docs/Makefile   Thu Nov 17 14:54:38 2011 +0000
> +++ b/docs/Makefile   Thu Nov 17 15:01:15 2011 +0000
> @@ -45,7 +45,7 @@ ps: $(DOC_PS)
> Âpdf: $(DOC_PDF)
>
> Â.PHONY: html
> -html: $(DOC_HTML)
> +html: $(DOC_HTML) html/index.html
>
> Â.PHONY: txt
> Âtxt: $(DOC_TXT)
> @@ -128,6 +128,9 @@ html/%/index.html: src/%.tex
> Â Â Â Â$< 1>/dev/null 2>/dev/null ; else \
> Â Â Â Âecho "latex2html not installed; skipping $*."; fi
>
> +html/index.html: $(DOC_HTML) ./gen-html-index INDEX
> + Â Â Â ./gen-html-index -i INDEX html $(DOC_HTML)
> +
> Âhtml/%.html: %.markdown
> Â Â Â Â@$(INSTALL_DIR) $(@D)
> Â Â Â Â@set -e ; if which $(MARKDOWN) 1>/dev/null 2>/dev/null; then \
> diff -r c1f8406da507 -r 8f2404eef8fa docs/gen-html-index
> --- /dev/null  Thu Jan 01 00:00:00 1970 +0000
> +++ b/docs/gen-html-index    Thu Nov 17 15:01:15 2011 +0000
> @@ -0,0 +1,129 @@
> +#!/usr/bin/perl -w

Please use "/usr/bin/env perl" or call the script from the Makefile
with "perl ./..." (as Ian Jackson has done in his patch to import
queue.h)

_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxxxxxxxx
http://lists.xensource.com/xen-devel