mirror of
https://github.com/xen-project/xen.git
synced 2026-10-28 02:01:24 +01:00
Ian Jackson
262e118a37
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>
185 lines
5.2 KiB
Makefile
185 lines
5.2 KiB
Makefile
#!/usr/bin/make -f
|
|
|
|
XEN_ROOT=$(CURDIR)/..
|
|
include $(XEN_ROOT)/Config.mk
|
|
include $(XEN_ROOT)/docs/Docs.mk
|
|
|
|
VERSION = xen-unstable
|
|
|
|
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_MARKDOWN := $(wildcard misc/*.markdown)
|
|
DOC_PS := $(patsubst src/%.tex,ps/%.ps,$(DOC_TEX))
|
|
DOC_PDF := $(patsubst src/%.tex,pdf/%.pdf,$(DOC_TEX))
|
|
DOC_HTML := $(patsubst src/%.tex,html/reference/%/index.html,$(DOC_TEX)) \
|
|
$(patsubst %.markdown,html/%.html,$(DOC_MARKDOWN)) \
|
|
$(patsubst man/%.pod.1,html/man/%.1.html,$(DOC_MAN1SRC)) \
|
|
$(patsubst man/%.pod.5,html/man/%.5.html,$(DOC_MAN5SRC)) \
|
|
$(patsubst %.txt,html/%.txt,$(wildcard misc/*.txt))
|
|
DOC_TXT := $(patsubst %.txt,txt/%.txt,$(wildcard misc/*.txt)) \
|
|
$(patsubst %.markdown,txt/%.txt,$(DOC_MARKDOWN)) \
|
|
$(patsubst man/%.pod.1,txt/man/%.1.txt,$(DOC_MAN1SRC)) \
|
|
$(patsubst man/%.pod.5,txt/man/%.5.txt,$(DOC_MAN5SRC))
|
|
|
|
GFX = $(patsubst %.fig, %.eps, $(wildcard figs/*.fig))
|
|
|
|
.PHONY: all
|
|
all: build
|
|
|
|
.PHONY: build
|
|
build: ps pdf html txt man-pages
|
|
@if which $(DOT) 1>/dev/null 2>/dev/null ; then \
|
|
$(MAKE) -C xen-api build ; else \
|
|
echo "Graphviz (dot) not installed; skipping xen-api." ; fi
|
|
rm -f *.aux *.dvi *.bbl *.blg *.glo *.idx *.ilg *.log *.ind *.toc
|
|
|
|
.PHONY: dev-docs
|
|
dev-docs: python-dev-docs
|
|
|
|
.PHONY: ps
|
|
ps: $(DOC_PS)
|
|
|
|
.PHONY: pdf
|
|
pdf: $(DOC_PDF)
|
|
|
|
.PHONY: html
|
|
html: $(DOC_HTML) html/index.html
|
|
|
|
.PHONY: txt
|
|
txt: $(DOC_TXT)
|
|
|
|
.PHONY: python-dev-docs
|
|
python-dev-docs:
|
|
@mkdir -v -p api/tools/python
|
|
@set -e ; if which $(DOXYGEN) 1>/dev/null 2>/dev/null; then \
|
|
echo "Running doxygen to generate Python tools APIs ... "; \
|
|
$(DOXYGEN) Doxyfile; \
|
|
$(MAKE) -C api/tools/python/latex ; else \
|
|
echo "Doxygen not installed; skipping python-dev-docs."; fi
|
|
|
|
.PHONY: man-pages
|
|
man-pages:
|
|
@if which $(POD2MAN) 1>/dev/null 2>/dev/null; then \
|
|
$(MAKE) $(DOC_MAN1) $(DOC_MAN5); else \
|
|
echo "pod2man not installed; skipping man-pages."; 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" $< $@
|
|
|
|
.PHONY: clean
|
|
clean:
|
|
$(MAKE) -C xen-api 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 txt
|
|
rm -rf api
|
|
rm -rf man5
|
|
rm -rf man1
|
|
|
|
.PHONY: distclean
|
|
distclean: clean
|
|
|
|
.PHONY: install
|
|
install: all
|
|
rm -rf $(DESTDIR)$(DOCDIR)
|
|
$(INSTALL_DIR) $(DESTDIR)$(DOCDIR)
|
|
|
|
$(MAKE) -C xen-api install
|
|
|
|
cp -dR ps $(DESTDIR)$(DOCDIR)
|
|
cp -dR pdf $(DESTDIR)$(DOCDIR)
|
|
$(INSTALL_DIR) $(DESTDIR)$(MANDIR)
|
|
cp -dR man1 $(DESTDIR)$(MANDIR)
|
|
cp -dR man5 $(DESTDIR)$(MANDIR)
|
|
[ ! -d html ] || cp -dR html $(DESTDIR)$(DOCDIR)
|
|
|
|
pdf/%.pdf: ps/%.ps
|
|
$(INSTALL_DIR) $(@D)
|
|
$(PS2PDF) $< $@.new
|
|
mv $@.new $@
|
|
|
|
ps/%.ps: %.dvi
|
|
$(INSTALL_DIR) $(@D)
|
|
$(DVIPS) -Ppdf -G0 -o $@.new $<
|
|
mv $@.new $@
|
|
|
|
%.dvi: src/%.tex $(GFX)
|
|
$(LATEX) $< >/dev/null
|
|
if [ -e $*.toc ] ; then $(LATEX) $< >/dev/null ; fi
|
|
|
|
%.eps: %.fig
|
|
$(FIG2DEV) -L eps $< $@
|
|
|
|
html/reference/%/index.html: src/%.tex
|
|
@$(INSTALL_DIR) $(@D)
|
|
@set -e ; if which $(LATEX2HTML) 1>/dev/null 2>/dev/null; then \
|
|
echo "Running latex2html to generate reference/$*/index.html ... "; \
|
|
$(LATEX2HTML) -split 0 -show_section_numbers -toc_depth 3 -nonavigation \
|
|
-numbered_footnotes -local_icons -noinfo -math -dir $(@D) \
|
|
$< 1>/dev/null 2>/dev/null ; else \
|
|
echo "latex2html not installed; skipping reference/$*."; fi
|
|
|
|
html/index.html: $(DOC_HTML) ./gen-html-index INDEX
|
|
perl -w -- ./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 \
|
|
echo "Running markdown to generate $*.html ... "; \
|
|
$(MARKDOWN) $< > $@.tmp ; \
|
|
$(call move-if-changed,$@.tmp,$@) ; else \
|
|
echo "markdown not installed; skipping $*.html."; fi
|
|
|
|
html/%.txt: %.txt
|
|
@$(INSTALL_DIR) $(@D)
|
|
cp $< $@
|
|
|
|
html/man/%.1.html: man/%.pod.1 Makefile
|
|
$(INSTALL_DIR) $(@D)
|
|
$(POD2HTML) --infile=$< --outfile=$@.tmp
|
|
$(call move-if-changed,$@.tmp,$@)
|
|
|
|
html/man/%.5.html: man/%.pod.5 Makefile
|
|
$(INSTALL_DIR) $(@D)
|
|
$(POD2HTML) --infile=$< --outfile=$@.tmp
|
|
$(call move-if-changed,$@.tmp,$@)
|
|
|
|
html/hypercall/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 include/xen/errno.h
|
|
touch $@
|
|
|
|
txt/%.txt: %.txt
|
|
$(INSTALL_DIR) $(@D)
|
|
cp $< $@.tmp
|
|
$(call move-if-changed,$@.tmp,$@)
|
|
|
|
txt/%.txt: %.markdown
|
|
$(INSTALL_DIR) $(@D)
|
|
cp $< $@.tmp
|
|
$(call move-if-changed,$@.tmp,$@)
|
|
|
|
txt/man/%.1.txt: man/%.pod.1 Makefile
|
|
$(INSTALL_DIR) $(@D)
|
|
$(POD2TEXT) $< $@.tmp
|
|
$(call move-if-changed,$@.tmp,$@)
|
|
|
|
txt/man/%.5.txt: man/%.pod.5 Makefile
|
|
$(INSTALL_DIR) $(@D)
|
|
$(POD2TEXT) $< $@.tmp
|
|
$(call move-if-changed,$@.tmp,$@)
|
|
|