xen-project/xen
1
0 Fork 0
mirror of https://github.com/xen-project/xen.git synced 2026-10-28 02:01:24 +01:00
Code Issues Activity

docs: check for documentation generation tools in docs/configure.

Browse Source 
It is sometimes hard to discover all the optional tools that should be
on a system to build all available Xen documentation. By checking for
documentation generation tools at ./configure time and displaying a
warning, Xen packagers will more easily learn about new optional build
dependencies, like markdown, when they are introduced.

Based on a patch by Matt Wilson. Changed to use a separate
docs/configure which is called from the top-level in the same manner
as stubdoms.

Rerun autogen.sh and "git add docs/configure" after applying this patch.

Signed-off-by: Matt Wilson <msw@amazon.com>
Signed-off-by: Ian Campbell <ian.campbell@citrix.com>
Acked-by: Matt Wilson <msw@amazon.com>
  (For the change to introduce docs/configure)
Acked-by: Roger Pau Monné <roger.pau@citrix.com>
Committed-by: Ian Campbell <ian.campbell@citrix.com>
This commit is contained in:
Ian Campbell committed 2013-01-25 09:03:37 +00:00
1 parent 5806093a20
commit 9db0ad0f46
10 files changed
+116 -27
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

.gitignore
+4
View File
@@ -35,6 +35,9 @@ config/Toplevel.mk
build-*
dist/*
docs/autom4te.cache/
docs/config.log
docs/config.status
docs/*.aux
docs/*.dvi
docs/*.log
@@ -132,6 +135,7 @@ tools/config.status
tools/config.cache
config/Tools.mk
config/Stubdom.mk
config/Docs.mk
tools/blktap2/daemon/blktapctrl
tools/blktap2/drivers/img2qcow
tools/blktap2/drivers/lock-util
.hgignore
+6
View File
@@ -32,6 +32,10 @@
^config/Toplevel\.mk
^build-.*$
^dist/.*$
^docs/autom4te\.cache$
^docs/config\.log$
^docs/config\.status
^docs/config/Toplevel\.mk
^docs/.*\.aux$
^docs/.*\.dvi$
^docs/.*\.log$
@@ -322,6 +326,8 @@
^tools/config\.status$
^tools/config\.cache$
^config/Tools\.mk$
^config/Stubdom\.mk$
^config/Docs\.mk$
^xen/\.banner.*$
^xen/BLOG$
^xen/System.map$
README
+1 -1
View File
@@ -57,7 +57,6 @@ provided by your OS distributor:
* GNU gettext
* 16-bit x86 assembler, loader and compiler (dev86 rpm or bin86 & bcc debs)
* ACPI ASL compiler (iasl)
* markdown
In addition to the above there are a number of optional build
prerequisites. Omitting these will cause the related features to be
@@ -66,6 +65,7 @@ disabled at compile time:
ocaml-findlib). Required to build ocaml components which
includes the alternative ocaml xenstored.
* cmake (if building vtpm stub domains)
* markdown
Second, you need to acquire a suitable kernel for use in domain 0. If
possible you should use a kernel provided by your OS distributor. If
autogen.sh
+7 -2
View File
@@ -1,7 +1,12 @@
#!/bin/sh -e
autoconf
cd tools
( cd tools
autoconf
autoheader
cd ../stubdom
)
( cd stubdom
autoconf
)
( cd docs
autoconf
)
config/Docs.mk.in
+13
View File
@@ -0,0 +1,13 @@
# Prefix and install folder
prefix := @prefix@
PREFIX := $(prefix)
exec_prefix := @exec_prefix@
libdir := @libdir@
LIBDIR := $(libdir)
# Tools
FIG2DEV := @FIG2DEV@
POD2MAN := @POD2MAN@
POD2HTML := @POD2HTML@
POD2TEXT := @POD2TEXT@
MARKDOWN := @MARKDOWN@
docs/Docs.mk
-6
View File
@@ -1,6 +0,0 @@
FIG2DEV := fig2dev
LATEX2HTML := latex2html
POD2MAN := pod2man
POD2HTML := pod2html
POD2TEXT := pod2text
MARKDOWN := markdown
docs/Makefile
+47 -17
View File
@@ -2,7 +2,7 @@
XEN_ROOT=$(CURDIR)/..
include $(XEN_ROOT)/Config.mk
include $(XEN_ROOT)/docs/Docs.mk
-include $(XEN_ROOT)/config/Docs.mk
VERSION = xen-unstable
@@ -32,21 +32,27 @@ html: $(DOC_HTML) html/index.html
.PHONY: txt
txt:
@if which $(POD2TEXT) 1>/dev/null 2>/dev/null; then \
$(MAKE) $(DOC_TXT); else \
echo "pod2text not installed; skipping text outputs."; fi
ifdef POD2TEXT
$(MAKE) $(DOC_TXT)
else
@echo "pod2text not installed; skipping text outputs."
endif
.PHONY: figs
figs:
@set -e ; if which $(FIG2DEV) 1>/dev/null 2>/dev/null; then \
set -x; $(MAKE) -C figs ; else \
echo "fig2dev (transfig) not installed; skipping figs."; fi
ifdef FIG2DEV
set -x; $(MAKE) -C figs
else
@echo "fig2dev (transfig) not installed; skipping figs."
endif
.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
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)
@@ -69,6 +75,8 @@ clean:
.PHONY: distclean
distclean: clean
rm -rf ../config/Docs.mk config.log config.status config.cache \
autom4te.cache
.PHONY: install
install: all
@@ -84,30 +92,40 @@ 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 ... "; \
$(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."; fi
$(call move-if-changed,$@.tmp,$@)
else
@echo "markdown not installed; skipping $*.html."
endif
html/%.txt: %.txt
@$(INSTALL_DIR) $(@D)
$(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
html/hypercall/index.html: ./xen-headers
rm -rf $(@D)
@$(INSTALL_DIR) $(@D)
$(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 -X arch-arm \
@@ -127,11 +145,23 @@ txt/%.txt: %.markdown
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
docs/configure.ac
+20
View File
@@ -0,0 +1,20 @@
# -*- Autoconf -*-
# Process this file with autoconf to produce a configure script.
AC_PREREQ([2.67])
AC_INIT([Xen Hypervisor Documentation], m4_esyscmd([../version.sh ../xen/Makefile]),
[xen-devel@lists.xen.org], [xen], [http://www.xen.org/])
AC_CONFIG_SRCDIR([misc/xen-command-line.markdown])
AC_CONFIG_FILES([../config/Docs.mk])
AC_CONFIG_AUX_DIR([../])
# M4 Macro includes
m4_include([../m4/docs_tool.m4])
AX_DOCS_TOOL_PROG([FIG2DEV], [fig2dev])
AX_DOCS_TOOL_PROG([POD2MAN], [pod2man])
AX_DOCS_TOOL_PROG([POD2HTML], [pod2html])
AX_DOCS_TOOL_PROG([POD2TEXT], [pod2text])
AX_DOCS_TOOL_PROGS([MARKDOWN], [markdown], [markdown markdown_py])
AC_OUTPUT()
docs/figs/Makefile
+1 -1
View File
@@ -1,7 +1,7 @@
XEN_ROOT=$(CURDIR)/../..
include $(XEN_ROOT)/Config.mk
include $(XEN_ROOT)/docs/Docs.mk
-include $(XEN_ROOT)/config/Docs.mk
TARGETS= network-bridge.png network-basic.png
m4/docs_tool.m4
+17
View File
@@ -0,0 +1,17 @@
AC_DEFUN([AX_DOCS_TOOL_PROG], [
dnl
AC_ARG_VAR([$1], [Path to $2 tool])
AC_PATH_PROG([$1], [$2])
AS_IF([! test -x "$ac_cv_path_$1"], [
AC_MSG_WARN([$2 is not available so some documentation won't be built])
])
])
AC_DEFUN([AX_DOCS_TOOL_PROGS], [
dnl
AC_ARG_VAR([$1], [Path to $2 tool])
AC_PATH_PROGS([$1], [$3])
AS_IF([! test -x "$ac_cv_path_$1"], [
AC_MSG_WARN([$2 is not available so some documentation won't be built])
])
])
Reference in new issue
xen-project/xen
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.

The note is not visible to the blocked user.