1
0
mirror of https://github.com/moparisthebest/pacman synced 2024-12-22 07:48:50 -05:00

Attempt to idiot-proof making and refreshing docs

I mess this up more often than not, and maybe this will do the trick. Remove
the --enable-asciidoc option as it has been superseded by the --disable-doc
option in usefulness. If you want to skip building docs, you skip building
all docs which is much easier when it comes to ensuring the make 'dist' and
'distcheck' targets will always build the manpages and always build the most
up to date manpages.

Developers shouldn't be affected in their normal builds, nor should end
users of the source tarball.

Signed-off-by: Dan McGee <dan@archlinux.org>
This commit is contained in:
Dan McGee 2008-08-05 21:03:59 -05:00
parent 927ce2b7a5
commit d7e502a467
3 changed files with 15 additions and 33 deletions

View File

@ -3,6 +3,9 @@ if WANT_DOC
SUBDIRS += doc SUBDIRS += doc
endif endif
# Make sure we test and build manpages when doing distcheck
DISTCHECK_CONFIGURE_FLAGS = --enable-doc --disable-git-version
# Some files automatically included, so they aren't specified below: # Some files automatically included, so they aren't specified below:
# AUTHORS, COPYING, NEWS, README # AUTHORS, COPYING, NEWS, README
EXTRA_DIST = HACKING EXTRA_DIST = HACKING

View File

@ -103,11 +103,6 @@ AC_ARG_ENABLE(doxygen,
AS_HELP_STRING([--enable-doxygen], [build your own API docs via Doxygen]), AS_HELP_STRING([--enable-doxygen], [build your own API docs via Doxygen]),
[wantdoxygen=$enableval], [wantdoxygen=no]) [wantdoxygen=$enableval], [wantdoxygen=no])
# Help line for asciidoc
AC_ARG_ENABLE(asciidoc,
AS_HELP_STRING([--enable-asciidoc], [build your own manpages with Asciidoc]),
[wantasciidoc=$enableval], [wantasciidoc=no])
# Help line for debug # Help line for debug
AC_ARG_ENABLE(debug, AC_ARG_ENABLE(debug,
AS_HELP_STRING([--enable-debug], [enable debugging support]), AS_HELP_STRING([--enable-debug], [enable debugging support]),
@ -273,23 +268,6 @@ else
fi fi
AM_CONDITIONAL(USE_DOXYGEN, test "x$usedoxygen" = "xyes") AM_CONDITIONAL(USE_DOXYGEN, test "x$usedoxygen" = "xyes")
# Check for asciidoc support and status
AC_CHECK_PROGS([ASCIIDOC], [asciidoc])
AC_MSG_CHECKING([for asciidoc])
if test "x$wantasciidoc" = "xyes" ; then
if test $ASCIIDOC ; then
AC_MSG_RESULT([yes])
useasciidoc=yes
else
AC_MSG_RESULT([no, asciidoc missing])
useasciidoc=no
fi
else
AC_MSG_RESULT([no, disabled by configure])
useasciidoc=no
fi
AM_CONDITIONAL(USE_ASCIIDOC, test "x$useasciidoc" = "xyes")
# Enable or disable debug code # Enable or disable debug code
AC_MSG_CHECKING(for debug mode request) AC_MSG_CHECKING(for debug mode request)
if test "x$debug" = "xyes" ; then if test "x$debug" = "xyes" ; then
@ -388,7 +366,6 @@ ${PACKAGE_NAME}:
Run make in doc/ dir : ${wantdoc} Run make in doc/ dir : ${wantdoc}
Use download library : ${internaldownload} Use download library : ${internaldownload}
Doxygen support : ${usedoxygen} Doxygen support : ${usedoxygen}
Asciidoc support : ${useasciidoc}
debug support : ${debug} debug support : ${debug}
" "

View File

@ -15,6 +15,7 @@ ASCIIDOC_MANS = \
DOXYGEN_MANS = $(wildcard man3/*.3) DOXYGEN_MANS = $(wildcard man3/*.3)
EXTRA_DIST = \ EXTRA_DIST = \
asciidoc.conf \
pacman.8.txt \ pacman.8.txt \
makepkg.8.txt \ makepkg.8.txt \
repo-add.8.txt \ repo-add.8.txt \
@ -29,8 +30,12 @@ EXTRA_DIST = \
$(DOXYGEN_MANS) $(DOXYGEN_MANS)
# Files that should be removed, but which Automake does not know. # Files that should be removed, but which Automake does not know.
MOSTLYCLEANFILES = *.xml MOSTLYCLEANFILES = *.xml $(ASCIIDOC_MANS)
MAINTAINERCLEANFILES = $(ASCIIDOC_MANS)
# Ensure manpages are fresh when building a dist tarball
dist-hook:
$(MAKE) $(AM_MAKEFLAGS) clean
$(MAKE) $(AM_MAKEFLAGS) all
if USE_GIT_VERSION if USE_GIT_VERSION
GIT_VERSION := $(shell sh -c 'git describe --abbrev=4 | sed s/^v//')-dirty GIT_VERSION := $(shell sh -c 'git describe --abbrev=4 | sed s/^v//')-dirty
@ -39,20 +44,18 @@ else
REAL_PACKAGE_VERSION = $(PACKAGE_VERSION) REAL_PACKAGE_VERSION = $(PACKAGE_VERSION)
endif endif
man_MANS = man_MANS =
dist_man_MANS = $(ASCIIDOC_MANS) repo-remove.8 dist_man_MANS = $(ASCIIDOC_MANS) repo-remove.8
if USE_DOXYGEN if USE_DOXYGEN
man_MANS += $(DOXYGEN_MANS) man_MANS += $(DOXYGEN_MANS)
all: doxygen.in all-local: doxygen.in
doxygen.in: doxygen.in:
$(DOXYGEN) $(srcdir)/Doxyfile $(DOXYGEN) $(srcdir)/Doxyfile
endif endif
if USE_ASCIIDOC
ASCIIDOC_OPTS = \ ASCIIDOC_OPTS = \
-f asciidoc.conf \ -f asciidoc.conf \
-a pacman_version="$(REAL_PACKAGE_VERSION)" \ -a pacman_version="$(REAL_PACKAGE_VERSION)" \
@ -64,11 +67,10 @@ A2X_OPTS = \
--xsltproc-opts='-param man.endnotes.list.enabled 0' \ --xsltproc-opts='-param man.endnotes.list.enabled 0' \
--xsltproc-opts='-param man.endnotes.are.numbered 0' --xsltproc-opts='-param man.endnotes.are.numbered 0'
$(ASCIIDOC_MANS):
a2x $(A2X_OPTS) --asciidoc-opts="$(ASCIIDOC_OPTS)" $@.txt
# These rules are due to the includes and files of the asciidoc text # These rules are due to the includes and files of the asciidoc text
$(ASCIIDOC_MANS): asciidoc.conf footer.txt $(ASCIIDOC_MANS): asciidoc.conf footer.txt
a2x $(A2X_OPTS) --asciidoc-opts="$(ASCIIDOC_OPTS)" $@.txt
pacman.8: pacman.8.txt pacman.8: pacman.8.txt
makepkg.8: makepkg.8.txt makepkg.8: makepkg.8.txt
repo-add.8: repo-add.8.txt repo-add.8: repo-add.8.txt
@ -78,7 +80,7 @@ pacman.conf.5: pacman.conf.5.txt
libalpm.3: libalpm.3.txt libalpm.3: libalpm.3.txt
# this one is just a symlink # this one is just a symlink
repo-remove.8: repo-add.8 repo-remove.8: repo-add.8
ln -s repo-add.8 repo-remove.8 rm -f repo-remove.8
endif $(LN_S) repo-add.8 repo-remove.8
# vim:set ts=2 sw=2 noet: # vim:set ts=2 sw=2 noet: