Commit Graph
32 Commits
Author SHA1 Message Date
Ian Campbell eee42df5c1 docs: add some scaffolding for building HTML docs from markdown
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>
2011-10-26 17:23:37 +01:00
Keir Fraser 547cb1849c build: Make XEN_ROOT an absolute path.
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>
2011-03-17 10:36:25 +00:00
Keir Fraser 66e56e754b install more documentation to /usr/share/doc/xen and /etc/xen
Also resync xmexample3 with xmexample1 and 2.

Signed-off-by: Samuel Thibault <samuel.thibault@eu.citrix.com>
2008-08-06 09:34:55 +01:00
Keir Fraser 53f48ca221 Fix some build system error handling.
Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
2007-12-20 13:16:21 +00:00
Ewan Mellor 8359e64538 Integrate the Xen-API doc into the build.
Signed-off-by: Ewan Mellor <ewan@xensource.com>
2007-01-27 18:26:41 +00:00
kfraser@localhost.localdomain 6311dc03da Clean up duplication of 'install' macros in the Makefiles.
Signed-off-by: John Levon <john.levon@sun.com>
2006-10-17 15:57:05 +01:00
kaf24@firebug.cl.cam.ac.uk 956c0afa80 [BUILD] Add distclean build target to xen directory: cleans out tags.
Signed-off-by: Horms <horms@verge.net.au>
2006-06-27 11:50:57 +01:00
kaf24@firebug.cl.cam.ac.uk b5fa90ac8e build: Clean up use of .PHONY
* 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>
2006-04-10 17:02:49 +01:00
emellor@leeni.uk.xensource.com 94608ed8f3 --- xen-unstable.hg.copy/docs/Makefile 2005-10-28 18:36:33.000000000 -0700
+++ 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
2005-10-30 17:20:09 +01:00
kaf24@firebug.cl.cam.ac.uk 3466017825 Split up docs. Signed-off-by: Robb Romans <3r@us.ibm.com> 2005-09-20 09:17:33 +00:00
emellor@ewan 3f5123b9de Issue warning if doxygen is not installed.
Signed-off-by: Ewan Mellor<ewan@xensource.com>
2005-09-17 13:59:35 +01:00
ewan@linford.intra 700f66a7ed Added dev-docs target to build the Python Tools' API documentation. 2005-09-11 21:12:40 +01:00
doogie@brainfood.com[kaf24] be7913c187 bitkeeper revision 1.1159.270.3 (42330ae8efsd9SdlhNX6EpksrtV6oQ)
[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>
2005-03-12 15:29:44 +00:00
kaf24@viper.(none) 7adbe03e19 bitkeeper revision 1.1159.270.1 (423308766_Mxiqyj1XF-m4OxnLnExA)
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>
2005-03-12 15:19:18 +00:00
cl349@firebug.cl.cam.ac.uk 7554eb1321 bitkeeper revision 1.1159.258.18 (4226f857ltmzeYRsvtnlD8t5FVTvhw)
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
2005-03-03 11:43:19 +00:00
kaf24@scramble.cl.cam.ac.uk 3279b48916 bitkeeper revision 1.1159.223.40 (41f676cbajLGqFeWFqajtJ3X4OkgoA)
Build system fixes.
Signed-off-by: keir.fraser@cl.cam.ac.uk
2005-01-25 16:41:47 +00:00
iap10@labyrinth.cl.cam.ac.uk d2f5d53621 bitkeeper revision 1.1159.223.26 (41f2cdb6LNpheOtPoAKEUn-czlZFig)
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
2005-01-22 22:03:34 +00:00
iap10@labyrinth.cl.cam.ac.uk 273e434815 bitkeeper revision 1.1159.223.20 (41f2c8174klQJ8mMgM3YDtJ6GQBXjw)
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
2005-01-22 21:39:35 +00:00
iap10@labyrinth.cl.cam.ac.uk dbaf99ecd4 bitkeeper revision 1.1159.223.17 (41f2c67c7vKsSLIzqLuYY24HOjsC5w)
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
2005-01-22 21:32:44 +00:00
kaf24@freefall.cl.cam.ac.uk e555800f04 bitkeeper revision 1.1159.1.388 (418cd911S4GHR23WmcIAsrA5z4WmNg)
Better latex2html options.
2004-11-06 14:00:49 +00:00
iap10@labyrinth.cl.cam.ac.uk 4214aa2cf5 bitkeeper revision 1.1159.1.346 (4188d882FwpqRabp9rhXLwbR2fAQjQ)
build system cleanups
2004-11-03 13:09:22 +00:00
kaf24@freefall.cl.cam.ac.uk 149abe0ab4 bitkeeper revision 1.1159.152.3 (418897a4CxX9i8wXDd9o1ZAah8MBmQ)
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.
2004-11-03 08:32:36 +00:00
kaf24@freefall.cl.cam.ac.uk e81e528835 bitkeeper revision 1.1159.1.338 (4187ca95yoh3y8SwBJw4uTmgIxLCTw)
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.
2004-11-02 17:57:41 +00:00
kaf24@freefall.cl.cam.ac.uk a34175ab46 bitkeeper revision 1.1159.1.283 (417e6005a9xNBX3S_W5XwwXTWIldyA)
latex2html tweaks
2004-10-26 14:32:37 +00:00
kaf24@freefall.cl.cam.ac.uk cadf3eafb2 bitkeeper revision 1.1159.1.282 (417e5b60oXUOPTWl81d5zD6oq1tOTQ)
Clean up docs dir layout.
2004-10-26 14:12:48 +00:00
iap10@labyrinth.cl.cam.ac.uk 3d05d635fc bitkeeper revision 1.1159.12.1 (4117f0d1EjfQrr7cjM82SS7qdzq81A)
Build xend manual plus latex fixes
2004-08-09 21:46:57 +00:00
kaf24@scramble.cl.cam.ac.uk ef4ba176d8 bitkeeper revision 1.1108.56.1 (410faf5emvfslB-BTjuTK5EQwf6sxQ)
Fix LaTeX source.
2004-08-03 15:29:34 +00:00
mwilli2@equilibrium.research.intel-research.net d1e21bfee1 bitkeeper revision 1.1108.43.1 (410a5973b_ww-XNociMt5BotV87vBQ)
Tweaks.
2004-07-30 14:21:39 +00:00
mwilli2@equilibrium.research.intel-research.net a61052ced7 bitkeeper revision 1.1108.1.28 (41054bc8T8MzSNX7N4JkfGe7gTpO9g)
More user manual stuff.
2004-07-26 18:22:00 +00:00
kaf24@scramble.cl.cam.ac.uk f914ededc5 bitkeeper revision 1.824 (40601cf9uRnKyyagj6umr4Oaf_-gWQ)
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
2004-03-23 11:18:17 +00:00
kaf24@scramble.cl.cam.ac.uk e854ed8a05 bitkeeper revision 1.761 (40446b53iVC1lWMdd8aC4YbIBLbvLg)
Makefile:
  Installation fixes from Adam Heath.
2004-03-02 11:09:07 +00:00
kaf24@scramble.cl.cam.ac.uk 3a82e2bb87 bitkeeper revision 1.534 (3f9e7d6cDzOy5qVNkizn9WE_oKdsiA)
dummy, xenlogo.eps, xenstyle.cls, style.tex, interface.tex, Makefile:
  new file
2003-10-28 14:30:04 +00:00