aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Makefile
Commit message (Collapse)AuthorAgeFilesLines
* docs: xen-headers: Annotate typedefsIan Jackson2012-03-011-1/+1
| | | | | | | | | | | | Parse (some) typedef statements. (Make type names links to the underlying struct if there is one, rather than to just the typedef.) Also, exclude the new arch-arm headers. Signed-off-by: Ian Jackson <Ian.Jackson@eu.citrix.com> Cc: Ian Campbell <Ian.Campbell@citrix.com> Acked-by: Ian Campbell <ian.campbell@citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* docs: Remove outdated LaTex documentation.Keir Fraser2012-01-251-43/+3
| | | | Signed-off-by: Keir Fraser <keir@xen.org>
* docs/html/: Arrange for automatic build of hypercall docsIan Jackson2011-11-291-3/+6
| | | | | | | | | | - Use index.html rather than a stamp file. - Automatically generate dependencies. - Wire into the docs build system Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com> Acked-by: Ian Campbell <ian.campbell@citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* docs/html/: Annotations for two hypercallsIan Jackson2011-11-291-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | Add annotations for a couple of the hypercalls: HYPERVISOR_set_trap_table HYPERVISOR_mmu_update We do this by * annotating the list of #defines for hypercall numbers * annotating the list of error values * providing a function prototype for the systematically-named functions The header generator does the rest. This exercise revealed a couple of infelicities: * In the actual source code, do_mmu_update is defined to return an int and do_set_trap_table a long. However both functions return either -Efoo (on error) or 0 for success. * The error numbers are defined only in the private header file xen/include/xen/errno.h and then only with names which will typically clash with other projects. It would be nice to include a public version of this header which defines XEN_E*. But for now we run xen-headers on errno.h too. Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com> Acked-by: Ian Campbell <ian.campbell@citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* docs/html/: Initial cut of header documentation massagerIan Jackson2011-11-291-0/+8
| | | | | | | | | | | | | "xen-headers" generates HTML from header files. So far this generates just some type cross-references, if you say make -C docs html/hypercall/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@eu.citrix.com> Acked-by: Ian Campbell <ian.campbell@citrix.com> Committed-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
* docs: install txt files as htmlIan Campbell2011-11-291-1/+6
| | | | | | | | A browser will display them just fine. Signed-off-by: Ian Campbell <ian.campbell@citrix.com> Committed-by: Ian Jackson <ian.jackson.citrix.com> Acked-by: Ian Jackson <ian.jackson.citrix.com>
* docs: move user and interface .tex documents under reference.Ian Campbell2011-11-291-4/+4
| | | | | | | | | | | | | | Taking over the top level "user" entry with a relatively obsolete document is a bit of an annoyance but these docs are not so out of date that they should be deleted. Move them out of the top-level instead. (the original motivation here was to allow for user/xl-domain-cfg.markdown but we have since decided to go with man/xl.cfg.pod.5 instead so perhaps this is a waste of time) Signed-off-by: Ian Campbell <ian.campbell@citrix.com> Committed-by: Ian Jackson <ian.jackson.citrix.com> Acked-by: Ian Jackson <ian.jackson.citrix.com>
* docs: generate an index for the html outputIan Campbell2011-11-291-1/+4
| | | | | | | | nb: I'm not a Perl wizard... Signed-off-by: Ian Campbell <ian.campbell@citrix.com> Committed-by: Ian Jackson <ian.jackson.citrix.com> Acked-by: Ian Jackson <ian.jackson.citrix.com>
* docs: install html and txt versions of manpagesIan Campbell2011-11-291-3/+28
| | | | | | Signed-off-by: Ian Campbell <ian.campbell@citrix.com> Committed-by: Ian Jackson <ian.jackson.citrix.com> Acked-by: Ian Jackson <ian.jackson.citrix.com>
* docs: report if we do not build a doc due to lack of the necessary toolIan Campbell2011-11-141-3/+6
| | | | | | | | Previously only some targets did this. An alternative would be to make a hard dependency on these tools, this might make more sense especially for markdown? Signed-off-by: Ian Campbell <ian.campbell@citrix.com> Committed-by: Ian Jackson <ian.jackson@eu.citrix.com>
* docs: install text documentationIan Campbell2011-10-271-1/+17
| | | | | | | | Including markdown docs. Signed-off-by: Ian Campbell <ian.campbell@citrix.com> Acked-by: Ian Jackson <ian.jackson.citrix.com> Committed-by: Ian Jackson <ian.jackson.citrix.com>
* docs: add some scaffolding for building HTML docs from markdownIan Campbell2011-10-261-7/+15
| | | | | | Signed-off-by: Ian Campbell <ian.campbell@citrix.com> Acked-by: Ian Jackson <ian.jackson.citrix.com> Committed-by: Ian Jackson <ian.jackson.citrix.com>
* build: Make XEN_ROOT an absolute path.Keir Fraser2011-03-171-1/+1
| | | | | | | | Otherwise make can search the path relative to certain standard paths such as /usr/include (e.g., the line '-include $(XEN_ROOT)/.config' in Config.mk suffers from this). Signed-off-by: Keir Fraser <keir@xen.org>
* install more documentation to /usr/share/doc/xen and /etc/xenKeir Fraser2008-08-061-8/+8
| | | | | | Also resync xmexample3 with xmexample1 and 2. Signed-off-by: Samuel Thibault <samuel.thibault@eu.citrix.com>
* Fix some build system error handling.Keir Fraser2007-12-201-1/+1
| | | | Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
* Integrate the Xen-API doc into the build.Ewan Mellor2007-01-271-11/+8
| | | | Signed-off-by: Ewan Mellor <ewan@xensource.com>
* Clean up duplication of 'install' macros in the Makefiles.kfraser@localhost.localdomain2006-10-171-2/+3
| | | | Signed-off-by: John Levon <john.levon@sun.com>
* [BUILD] Add distclean build target to xen directory: cleans out tags.kaf24@firebug.cl.cam.ac.uk2006-06-271-0/+3
| | | | | Signed-off-by: Horms <horms@verge.net.au>
* build: Clean up use of .PHONYkaf24@firebug.cl.cam.ac.uk2006-04-101-2/+11
| | | | | | | | | | | | * Move .PHONY directives next to targets, this makes them a lot harder to miss * Add missing .PHONY directives * Remove nonexistent .PHONY directives * Hopefully I didn'T miss anything... Signed-Off-By: Horms <horms@verge.net.au>
* --- xen-unstable.hg.copy/docs/Makefile 2005-10-28 18:36:33.000000000 -0700emellor@leeni.uk.xensource.com2005-10-301-1/+27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +++ xen-unstable.hg/docs/Makefile 2005-10-28 14:58:18.000000000 -0700 @@ -1,5 +1,6 @@ #!/usr/bin/make -f +VERSION = xen-unstable INSTALL = install INSTALL_DIR = $(INSTALL) -d -m0755 @@ -9,9 +10,15 @@ FIG2DEV := fig2dev LATEX2HTML := latex2html DOXYGEN := doxygen +POD2MAN := pod2man pkgdocdir := /usr/share/doc/xen +mandir := /usr/share/man +DOC_MAN5SRC := $(wildcard man/*.pod.5) +DOC_MAN1SRC := $(wildcard man/*.pod.1) +DOC_MAN1 := $(patsubst man/%.pod.1,man1/%.1,$(DOC_MAN1SRC)) +DOC_MAN5 := $(patsubst man/%.pod.5,man5/%.5,$(DOC_MAN5SRC)) DOC_TEX := src/user.tex src/interface.tex DOC_PS := $(patsubst src/%.tex,ps/%.ps,$(DOC_TEX)) DOC_PDF := $(patsubst src/%.tex,pdf/%.pdf,$(DOC_TEX)) @@ -22,7 +29,7 @@ .PHONY: all build dev-docs python-dev-docs ps pdf html clean install all: build -build: ps pdf html +build: ps pdf html man-pages rm -f *.aux *.dvi *.bbl *.blg *.glo *.idx *.ilg *.log *.ind *.toc dev-docs: python-dev-docs @@ -43,17 +50,36 @@ $(MAKE) -C api/tools/python/latex ; else \ echo "Doxygen not installed; skipping python-dev-docs."; fi +man-pages: + @if which $(POD2MAN) 1>/dev/null 2>/dev/null; then \ + $(MAKE) $(DOC_MAN1) $(DOC_MAN5); fi + +man1/%.1: man/%.pod.1 Makefile + $(INSTALL_DIR) $(@D) + $(POD2MAN) --release=$(VERSION) --name=`echo $@ | sed 's/^man1.//'| \ + sed 's/.1//'` -s 1 -c "Xen" $< $@ + +man5/%.5: man/%.pod.5 Makefile + $(INSTALL_DIR) $(@D) + $(POD2MAN) --release=$(VERSION) --name=`echo $@ | sed 's/^man5.//'| \ + sed 's/.5//'` -s 5 -c "Xen" $< $@ + clean: rm -rf .word_count *.aux *.dvi *.bbl *.blg *.glo *.idx *~ rm -rf *.ilg *.log *.ind *.toc *.bak core rm -rf $(GFX) ps pdf html rm -rf api + rm -rf man5 + rm -rf man1 install: all rm -rf $(DESTDIR)$(pkgdocdir) $(INSTALL_DIR) $(DESTDIR)$(pkgdocdir) cp -dR ps $(DESTDIR)$(pkgdocdir) cp -dR pdf $(DESTDIR)$(pkgdocdir) + $(INSTALL_DIR) $(DESTDIR)$(mandir) + cp -dR man1 $(DESTDIR)$(mandir) + cp -dR man5 $(DESTDIR)$(mandir) [ ! -d html ] || cp -dR html $(DESTDIR)$(pkgdocdir) pdf/%.pdf: ps/%.ps
* Split up docs. Signed-off-by: Robb Romans <3r@us.ibm.com>kaf24@firebug.cl.cam.ac.uk2005-09-201-1/+1
|
* Issue warning if doxygen is not installed.emellor@ewan2005-09-171-2/+3
| | | | | Signed-off-by: Ewan Mellor<ewan@xensource.com>
* Added dev-docs target to build the Python Tools' API documentation.ewan@linford.intra2005-09-111-0/+13
|
* bitkeeper revision 1.1159.270.3 (42330ae8efsd9SdlhNX6EpksrtV6oQ)doogie@brainfood.com[kaf24]2005-03-121-1/+2
| | | | | | | | | [PATCH] add-build.patch Add build targets to all makefiles. Debian does builds as non-root, so it's better to do as much as possible before requiring root privs. Signed-off-by: Adam Heath <doogie@brainfood.com>
* bitkeeper revision 1.1159.270.1 (423308766_Mxiqyj1XF-m4OxnLnExA)kaf24@viper.(none)2005-03-121-2/+4
| | | | | | | | No longer require latex2html (bizarrely considered 'non-free' by Debian maintainers) to build docs. Instead we still build PS/PDF docs, but skip HTML docs. Signed-off-by: Keir Fraser <keir.fraser@cl.cam.ac.uk>
* bitkeeper revision 1.1159.258.18 (4226f857ltmzeYRsvtnlD8t5FVTvhw)cl349@firebug.cl.cam.ac.uk2005-03-031-6/+1
| | | | | | | Remove support for tgif as a tool. We don't use it and it's hard to find as and rpm. Signed-off-by: cl349@cl.cam.ac.uk
* bitkeeper revision 1.1159.223.40 (41f676cbajLGqFeWFqajtJ3X4OkgoA)kaf24@scramble.cl.cam.ac.uk2005-01-251-4/+1
| | | | | | Build system fixes. Signed-off-by: keir.fraser@cl.cam.ac.uk
* bitkeeper revision 1.1159.223.26 (41f2cdb6LNpheOtPoAKEUn-czlZFig)iap10@labyrinth.cl.cam.ac.uk2005-01-221-6/+7
| | | | | | | | | | | | | Description: use DESTDIR correctly Standard makefiles always attempt to install to the root(/). Setting DESTDIR is the normal way to install to an alternative location. Setting prefix has the possibility of breaking programs, as the prefix may have been embedded inside a compiled binary. From: Adam Heath <doogie@brainfood.com> Signed-off-by: ian.pratt@cl.cam.ac.uk
* bitkeeper revision 1.1159.223.20 (41f2c8174klQJ8mMgM3YDtJ6GQBXjw)iap10@labyrinth.cl.cam.ac.uk2005-01-221-4/+6
| | | | | | | | | | | Missing prat of earlier patch. Description: use INSTALL everywhere Use install(by way of INSTALL variables) to create directories, install programs, and install data files. From: Adam Heath <doogie@brainfood.com> Signed-off-by: ian.pratt@cl.cam.ac.uk
* bitkeeper revision 1.1159.223.17 (41f2c67c7vKsSLIzqLuYY24HOjsC5w)iap10@labyrinth.cl.cam.ac.uk2005-01-221-18/+35
| | | | | | | | | | | | Description: Use vars for complex programs It's generally standard to call complex programs indirectly thru make variables. This allows them to be replaced easily with alternative versions, without editting each makefile. Additionally, this patch makes use of $(pkgdocdir) in docs/Makefile. From: Adam Heath <doogie@brainfood.com> Signed-off-by: ian.pratt@cl.cam.ac.uk
* bitkeeper revision 1.1159.1.388 (418cd911S4GHR23WmcIAsrA5z4WmNg)kaf24@freefall.cl.cam.ac.uk2004-11-061-1/+2
| | | | | Better latex2html options.
* bitkeeper revision 1.1159.1.346 (4188d882FwpqRabp9rhXLwbR2fAQjQ)iap10@labyrinth.cl.cam.ac.uk2004-11-031-0/+1
| | | | | build system cleanups
* bitkeeper revision 1.1159.152.3 (418897a4CxX9i8wXDd9o1ZAah8MBmQ)kaf24@freefall.cl.cam.ac.uk2004-11-031-2/+2
| | | | | | | Fix parallel make problems (some rules had multiple dependencies which themselves were inter-dependent). Fix netbsd build when 'uname -i' is unavailable -- default to i386.
* bitkeeper revision 1.1159.1.338 (4187ca95yoh3y8SwBJw4uTmgIxLCTw)kaf24@freefall.cl.cam.ac.uk2004-11-021-3/+3
| | | | | | | | | | A new install script to install from the intermediate 'install' subdir. Also now a bit more careful in use of 'cp -a'. When installing to system-wide directories we probably do not want to preserve ownership of the random unprivileged user that originally built the binaries. The user who does the install (probably root) is the correct person to own the target files.
* bitkeeper revision 1.1159.1.283 (417e6005a9xNBX3S_W5XwwXTWIldyA)kaf24@freefall.cl.cam.ac.uk2004-10-261-2/+2
| | | | | latex2html tweaks
* bitkeeper revision 1.1159.1.282 (417e5b60oXUOPTWl81d5zD6oq1tOTQ)kaf24@freefall.cl.cam.ac.uk2004-10-261-26/+29
| | | | | Clean up docs dir layout.
* bitkeeper revision 1.1159.12.1 (4117f0d1EjfQrr7cjM82SS7qdzq81A)iap10@labyrinth.cl.cam.ac.uk2004-08-091-1/+1
| | | | | Build xend manual plus latex fixes
* bitkeeper revision 1.1108.56.1 (410faf5emvfslB-BTjuTK5EQwf6sxQ)kaf24@scramble.cl.cam.ac.uk2004-08-031-3/+3
| | | | | Fix LaTeX source.
* bitkeeper revision 1.1108.43.1 (410a5973b_ww-XNociMt5BotV87vBQ)mwilli2@equilibrium.research.intel-research.net2004-07-301-2/+6
| | | | | Tweaks.
* bitkeeper revision 1.1108.1.28 (41054bc8T8MzSNX7N4JkfGe7gTpO9g)mwilli2@equilibrium.research.intel-research.net2004-07-261-1/+1
| | | | | More user manual stuff.
* bitkeeper revision 1.824 (40601cf9uRnKyyagj6umr4Oaf_-gWQ)kaf24@scramble.cl.cam.ac.uk2004-03-231-1/+1
| | | | | | | | | | | | Many files: xeno -> xen renames. xen_proc.c: Rename: xenolinux-2.4.25-sparse/arch/xen/lib/xeno_proc.c -> xenolinux-2.4.25-sparse/arch/xen/lib/xen_proc.c xen_proc.h: Rename: xenolinux-2.4.25-sparse/include/asm-xen/xeno_proc.h -> xenolinux-2.4.25-sparse/include/asm-xen/xen_proc.h Xen-HOWTO.txt: Rename: docs/Xeno-HOWTO.txt -> docs/Xen-HOWTO.txt
* bitkeeper revision 1.761 (40446b53iVC1lWMdd8aC4YbIBLbvLg)kaf24@scramble.cl.cam.ac.uk2004-03-021-3/+10
| | | | | | Makefile: Installation fixes from Adam Heath.
* bitkeeper revision 1.534 (3f9e7d6cDzOy5qVNkizn9WE_oKdsiA)kaf24@scramble.cl.cam.ac.uk2003-10-281-0/+35
dummy, xenlogo.eps, xenstyle.cls, style.tex, interface.tex, Makefile: new file
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-26 02:47:20 +0000