mirror of
https://github.com/xen-project/xen.git
synced 2026-10-28 10:11:27 +01:00
Andrew Cooper
7dbfc2f8b0
If a user has specified --disable-xend, they wont want the manpages either.
Propagating this parameters requires reorganising the way in which the
makefile chooses which documents to build.
There is now a split of {MAN1,MAN5,MARKDOWN,TXT}SRC-y to select which
documentation to build, which is separate from the patsubst section which
generates appropriate paths to trigger the later rules.
The manpages are quite easy to split between xend, xl and xenstore, and have
been. Items from misc/ are much harder and been left.
Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
Acked-by: Ian Campbell <Ian.Campbell@citrix.com>
CC: Ian Jackson <Ian.Jackson@eu.citrix.com>
[ ijc -- reran autogen.sh as requested. ]
183 lines
4.7 KiB
Makefile
183 lines
4.7 KiB
Makefile
XEN_ROOT=$(CURDIR)/..
|
|
include $(XEN_ROOT)/Config.mk
|
|
-include $(XEN_ROOT)/config/Docs.mk
|
|
|
|
VERSION := $(shell $(MAKE) -C $(XEN_ROOT)/xen --no-print-directory xenversion)
|
|
|
|
DOC_ARCHES := arm x86_32 x86_64
|
|
|
|
# Documentation sources to build
|
|
MAN1SRC-y := $(wildcard man/xl*.pod.1)
|
|
MAN1SRC-y += $(wildcard man/xenstore*.pod.1)
|
|
MAN1SRC-$(CONFIG_XEND) += man/xm.pod.1
|
|
|
|
MAN5SRC-y := $(wildcard man/xl*.pod.5)
|
|
MAN5SRC-$(CONFIG_XEND) += man/xend-config.sxp.pod.5 man/xmdomain.cfg.pod.5
|
|
|
|
MARKDOWNSRC-y := $(wildcard misc/*.markdown)
|
|
|
|
TXTSRC-y := $(wildcard misc/*.txt)
|
|
|
|
|
|
DOC_MAN1 := $(patsubst man/%.pod.1,man1/%.1,$(MAN1SRC-y))
|
|
DOC_MAN5 := $(patsubst man/%.pod.5,man5/%.5,$(MAN5SRC-y))
|
|
DOC_HTML := $(patsubst %.markdown,html/%.html,$(MARKDOWNSRC-y)) \
|
|
$(patsubst man/%.pod.1,html/man/%.1.html,$(MAN1SRC-y)) \
|
|
$(patsubst man/%.pod.5,html/man/%.5.html,$(MAN5SRC-y)) \
|
|
$(patsubst %.txt,html/%.txt,$(TXTSRC-y)) \
|
|
$(patsubst %,html/hypercall/%/index.html,$(DOC_ARCHES))
|
|
DOC_TXT := $(patsubst %.txt,txt/%.txt,$(TXTSRC-y)) \
|
|
$(patsubst %.markdown,txt/%.txt,$(MARKDOWNSRC-y)) \
|
|
$(patsubst man/%.pod.1,txt/man/%.1.txt,$(MAN1SRC-y)) \
|
|
$(patsubst man/%.pod.5,txt/man/%.5.txt,$(MAN5SRC-y))
|
|
|
|
.PHONY: all
|
|
all: build
|
|
|
|
.PHONY: build
|
|
build: html txt man-pages figs
|
|
|
|
.PHONY: html
|
|
html: $(DOC_HTML) html/index.html
|
|
|
|
.PHONY: txt
|
|
txt:
|
|
ifdef POD2TEXT
|
|
$(MAKE) $(DOC_TXT)
|
|
else
|
|
@echo "pod2text not installed; skipping text outputs."
|
|
endif
|
|
|
|
.PHONY: figs
|
|
figs:
|
|
ifdef FIG2DEV
|
|
set -x; $(MAKE) -C figs
|
|
else
|
|
@echo "fig2dev (transfig) not installed; skipping figs."
|
|
endif
|
|
|
|
.PHONY: man-pages
|
|
man-pages:
|
|
ifdef POD2MAN
|
|
$(MAKE) $(DOC_MAN1) $(DOC_MAN5)
|
|
else
|
|
@echo "pod2man not installed; skipping man-pages."
|
|
endif
|
|
|
|
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 figs clean
|
|
rm -rf .word_count *.aux *.dvi *.bbl *.blg *.glo *.idx *~
|
|
rm -rf *.ilg *.log *.ind *.toc *.bak *.tmp core
|
|
rm -rf html txt
|
|
rm -rf man5
|
|
rm -rf man1
|
|
|
|
.PHONY: distclean
|
|
distclean: clean
|
|
rm -rf $(XEN_ROOT)/config/Docs.mk config.log config.status config.cache \
|
|
autom4te.cache
|
|
|
|
.PHONY: install
|
|
install: all
|
|
rm -rf $(DESTDIR)$(DOCDIR)
|
|
$(INSTALL_DIR) $(DESTDIR)$(DOCDIR)
|
|
|
|
$(INSTALL_DIR) $(DESTDIR)$(MANDIR)
|
|
cp -R man1 $(DESTDIR)$(MANDIR)
|
|
cp -R man5 $(DESTDIR)$(MANDIR)
|
|
[ ! -d html ] || cp -R html $(DESTDIR)$(DOCDIR)
|
|
|
|
html/index.html: $(DOC_HTML) $(CURDIR)/gen-html-index INDEX
|
|
$(PERL) -w -- $(CURDIR)/gen-html-index -i INDEX html $(DOC_HTML)
|
|
|
|
html/%.html: %.markdown
|
|
$(INSTALL_DIR) $(@D)
|
|
ifdef MARKDOWN
|
|
@echo "Running markdown to generate $*.html ... "
|
|
$(MARKDOWN) $< > $@.tmp ; \
|
|
$(call move-if-changed,$@.tmp,$@)
|
|
else
|
|
@echo "markdown not installed; skipping $*.html."
|
|
endif
|
|
|
|
html/%.txt: %.txt
|
|
$(INSTALL_DIR) $(@D)
|
|
cp $< $@
|
|
|
|
html/man/%.1.html: man/%.pod.1 Makefile
|
|
$(INSTALL_DIR) $(@D)
|
|
ifdef POD2HTML
|
|
$(POD2HTML) --infile=$< --outfile=$@.tmp
|
|
$(call move-if-changed,$@.tmp,$@)
|
|
else
|
|
@echo "pod2html not installed; skipping $<."
|
|
endif
|
|
|
|
html/man/%.5.html: man/%.pod.5 Makefile
|
|
$(INSTALL_DIR) $(@D)
|
|
ifdef POD2HTML
|
|
$(POD2HTML) --infile=$< --outfile=$@.tmp
|
|
$(call move-if-changed,$@.tmp,$@)
|
|
else
|
|
@echo "pod2html not installed; skipping $<."
|
|
endif
|
|
|
|
# For non-x86 arches exclude the subarch whole x86 arch.
|
|
$(foreach i,$(filter-out x86_32 x86_64,$(DOC_ARCHES)),html/hypercall/$(i)/index.html): EXTRA_EXCLUDE := -X arch-x86
|
|
|
|
html/hypercall/%/index.html: $(CURDIR)/xen-headers Makefile
|
|
rm -rf $(@D)
|
|
$(INSTALL_DIR) $(@D)
|
|
$(PERL) -w $(CURDIR)/xen-headers -O $(@D) \
|
|
-T 'arch-$* - Xen public headers' \
|
|
$(patsubst %,-X arch-%,$(filter-out $*,$(DOC_ARCHES))) \
|
|
$(patsubst %,-X xen-%,$(filter-out $*,$(DOC_ARCHES))) \
|
|
$(EXTRA_EXCLUDE) \
|
|
$(XEN_ROOT)/xen include/public include/xen/errno.h
|
|
|
|
-include $(wildcard html/hypercall/*/.deps)
|
|
|
|
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)
|
|
ifdef POD2TEXT
|
|
$(POD2TEXT) $< $@.tmp
|
|
$(call move-if-changed,$@.tmp,$@)
|
|
else
|
|
@echo "pod2text not installed; skipping $<."
|
|
endif
|
|
|
|
txt/man/%.5.txt: man/%.pod.5 Makefile
|
|
$(INSTALL_DIR) $(@D)
|
|
ifdef POD2TEXT
|
|
$(POD2TEXT) $< $@.tmp
|
|
$(call move-if-changed,$@.tmp,$@)
|
|
else
|
|
@echo "pod2text not installed; skipping $<."
|
|
endif
|
|
|
|
ifeq (,$(findstring clean,$(MAKECMDGOALS)))
|
|
$(XEN_ROOT)/config/Docs.mk:
|
|
$(error You have to run ./configure before building docs)
|
|
endif
|