[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] Re: [Xen-devel] [PATCH 1/4] docs/html/hcall: Initial cut of header documentation massager
On Sun, 2011-11-13 at 19:21 +0000, Ian Jackson wrote: > "xen-headers" generates HTML from header files. So far this generates > just some type cross-references, if you say > make -C docs html/hcall/stamp > > An index page, proper wiring into the build system, and a few more > annotations in the headers, and will be forthcoming. > > Signed-off-by: Ian Jackson <ian.jackson@xxxxxxxxxxxxx> > --- > docs/Makefile | 8 ++ > docs/xen-headers | 281 > ++++++++++++++++++++++++++++++++++++++++++++++++++++++ > 2 files changed, 289 insertions(+), 0 deletions(-) > create mode 100755 docs/xen-headers > > diff --git a/docs/Makefile b/docs/Makefile > index 2054541..fc42859 100644 > --- a/docs/Makefile > +++ b/docs/Makefile > @@ -129,6 +129,14 @@ html/%.html: %.markdown > $(MARKDOWN) $< > $@.tmp ; \ > $(call move-if-changed,$@.tmp,$@) ; fi > > +html/hcall/stamp: > + @$(INSTALL_DIR) $(@D) > + ./xen-headers -O $(@D) \ > + -T 'arch-x86_64 - Xen public headers' \ > + -X arch-ia64 -X arch-x86_32 -X xen-x86_32 \ > + ../xen include/public > + touch $@ > + > txt/%.txt: %.txt > $(INSTALL_DIR) $(@D) > cp $< $@.tmp > diff --git a/docs/xen-headers b/docs/xen-headers > new file mode 100755 > index 0000000..6918380 > --- /dev/null > +++ b/docs/xen-headers > @@ -0,0 +1,281 @@ > +#!/usr/bin/perl -w > +# usage: xen-headers [ -X GLOB -I GLOB ... [-D...] ] \ > +# -O HTML-DIR PUBLIC-INCLUDE-DIR No "-T"? Also for PUBLIC-INCLUDE-DIR you appear to pass "../xen include/public" so my guess is that it is slightly more complicated? Looks like "BASE-PUBLIC-INCLUDE-DIR PUBLIC-INCLUDE-FILE [ PUBLIC-INCLUDE-FILE ... ] [...] > + s/\&/\&/g; > + s/\</\</g; > + s/\>/\>/g; There must be a perl lib for this? Ian. _______________________________________________ Xen-devel mailing list Xen-devel@xxxxxxxxxxxxxxxxxxx http://lists.xensource.com/xen-devel
|
Lists.xenproject.org is hosted with RackSpace, monitoring our |