xen-project/xen
1
0 Fork 1
mirror of https://github.com/xen-project/xen.git synced 2026-10-29 10:40:03 +01:00
Code Issues Activity
8,056 Commits 53 Branches 377 Tags
963d9e8fdfd367f6389ff69adbf2640deedf2bbc
Commit Graph
13 Commits
Author SHA1 Message Date
dan@localhost.localdomain 26937cc111 First stab at a xend-config.sxp man page. 2005-11-20 15:01:15 +01:00
sean@dague.net 1443ca6d8c updates to xmdomain.cfg.5 man page to document most used options, and 
provide a basic template for examples
 2005-11-18 13:01:30 +01:00
sean@dague.net 829e31bad5 added block device content, including finding a few more bugs in xen 2005-11-18 12:58:16 +01:00
emellor@leeni.uk.xensource.com 8add0c9fed This patch explains network-* options in xm.1, including the bits that are 
currently not really working.

Signed off by: Sean Dague <sean@dague.net>
 2005-11-17 12:01:13 +01:00
emellor@leeni.uk.xensource.com cb248d6b16 The following patch removes every (hopefully) reference to network-limit. 
Upon further investigation it sets Device parameters that don't exist any
longer, thus causing exceptions.  As it looks like this is completely
obsolete, and no one is actively working on it, we should just rip it out to
end the confusion.

Signed-off-by: Sean Dague <sean@dague.net>
 2005-11-16 11:31:57 +01:00
emellor@leeni.uk.xensource.com 0e9ceb580a This patch is largely stylistic, and gets rid of StuddlyCaps formatting in 
all the param variables, make consistant use of bold and italics in the the
man pages to make it easier to read, and adds a few minor content additions.
It makes actually reading the man page a lot easier.

Signed-off-by: Sean Dague <sean@dague.net>
 2005-11-15 15:36:42 +01:00
emellor@leeni.uk.xensource.com 92c71aea0d This patch adds more content around the scheduler portions of the xm.1 man 
page.  Most of this content came from the xensource wiki or the sedf doc in
the Xen tree.  It still needs more work, but it is a good first start.

Signed-off-by: Sean Dague <sean@dague.net>
 2005-11-15 15:27:48 +01:00
emellor@leeni.uk.xensource.com c7509dd6cc This patch is another in the continued effort to flesh out the man pages, it 
adds pretty reasonable text to most of the code xen domain and host commands
(device and scheduler will come in the future).

Signed-off-by: Sean Dague <sean@dague.net>
 2005-11-15 15:26:37 +01:00
emellor@leeni.uk.xensource.com aeedebd423 Further changes to xm.1 man page. 
Signed-off-by: Sean Dague <sean@dague.net>
 2005-11-12 18:52:16 +01:00
emellor@leeni.uk.xensource.com 23b53644ac The following patch is work in progress to add more meat to the xm.1 man 
page.  Expect more content to trickle in over time.

Signed-off-by: Sean Dague <sean@dague.net>
 2005-11-12 18:32:19 +01:00
emellor@leeni.uk.xensource.com 1455bb4870 Added description of the behaviour of rename-restart. 
Signed-off-by: Ewan Mellor <ewan@xensource.com>
 2005-11-07 15:06:00 +01:00
kaf24@firebug.cl.cam.ac.uk d5dce3e452 The following patch adds a section for SHUTDOWN OPTIONS for the xmdomain.cfg 
man page.  It documents the new set of options introduced over the last few
weeks.

Signed-off-by: Sean Dague <sean@dague.net>
 2005-11-01 10:36:19 +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