Files
coreutils/man/local.mk
T
Stefano Lattarini 48536bfe8f build: man page generation: degrade gracefully when perl is lacking
Since commit v8.19-118-g57da212, our 'dist-hook' rule tweaked the
distributed Makefile.in to make each man page 'man/foo.1' depend
on the corresponding source 'src/foo.c' rather than the corresponding
program 'src/foo'.  That was done to accommodate systems without
perl, which cannot run help2man to regenerate the manpage after
its corresponding program has been built.

This seems a right and proper graceful degradation, in that the
man pages dependencies are still 100% correct in a git checkout,
while being more lax but "more portable" in a distribution tarball.
Alas, that is not the case in practice, as it turns out the tweaked
Makefile makes the building of man pages unreliable and potentially
incorrect!

In fact, assume that instead of the correct a dependency:

    man/ls.1: src/ls

we have the laxer one:

    man/ls.1: src/ls.c

and think of what happens if a user modifies, say, 'src/ls.c', and then
runs "make -j4" to rebuild everything.  The make process will see that
it has to rebuild the man page 'man/ls.1' (because its prerequisite
'src/ls.c' has changed), but won't see that it has to rebuild 'src/ls'
*before* re-running 'help2man' to generate that man page; so, if
'man/ls.1' is rebuilt before 'src/ls' (which can happen with concurrent
make), our user will get either a build error (if 'src/ls' did non
exist) or, worse, a man page with an up-to-date timestamp but an
out-of-date content.  And what's even worse in all of this is that
this problem will be present also for users who have perl installed:
this is not a "graceful degradation" at all!

In our situation, the best and simplest way to implement a graceful
degradation it to keep the correct dependencies for man pages (that
is, "man/ls.1: src/ls"), and if perl is not present, just generate
dummy man pages reporting that built-time issue and redirecting the
user back to either the info documentation or the '--help' output.

As a consequence of this change, we also stop distributing man pages,
since they will now be generated unconditionally.

* Makefile.am (do-not-require-help2man): Remove.
(dist-hook): Don't depend on it.
* man/local.mk: Remove an obsolete comment.
(EXTRA_DIST): Stop distributing generated man pages.
($(EXTRA_MANS)): This no longer needs to depend on $(all_programs).
(MAINTAINERCLEANFILES): $(ALL_MANS) Do not list it here, and ...
(CLEANFILES): ... list it here, instead.
(.x.1): Instead of warning if perl is missing, but then trying to run
'help2man' unconditionally, simply run ...
(run_help2man): ... the command referenced by this new variable, that
expands to a proper invocation of 'help2man' if perl is present, and
to an invocation of a shell script generating a dummy manpage if it
is not.
(EXTRA_DIST): Distribute that shell script.
* man/dummy-man: New shell script.
* NEWS (Build-related): Mention this.
Fixes coreutils http://bugs.gnu.org/12715.
2012-10-26 12:04:12 +02:00

196 lines
5.9 KiB
Makefile

# Make coreutils man pages. -*-Makefile-*-
# This is included by the top-level Makefile.am.
# Copyright (C) 2002-2012 Free Software Foundation, Inc.
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
EXTRA_DIST += man/help2man man/dummy-man
## Graceful degradation for systems lacking perl.
if HAVE_PERL
run_help2man = $(PERL) -- $(srcdir)/man/help2man
else
run_help2man = $(SHELL) $(srcdir)/man/dummy-man
endif
man1_MANS = @man1_MANS@
EXTRA_DIST += $(man1_MANS:.1=.x)
EXTRA_MANS = @EXTRA_MANS@
EXTRA_DIST += $(EXTRA_MANS:.1=.x)
ALL_MANS = $(man1_MANS) $(EXTRA_MANS)
CLEANFILES += $(ALL_MANS)
# This is required because we have subtle inter-directory dependencies:
# in order to generate all man pages, even those for which we don't
# install a binary, require that all programs be built at distribution
# time. We can't use 'dist-hook' for this, since it would run too late:
# the manpages must be generated before the distdir is created and filled.
$(EXTRA_MANS): $(all_programs)
# This is a kludge to remove generated 'man/*.1' from a non-srcdir build.
# Without this, "make distcheck" might fail.
distclean-local:
test x$(srcdir) = x$(builddir) || rm -f $(ALL_MANS)
# Dependencies common to all man pages. Updated below.
mandeps =
# Depend on this to get version number changes.
mandeps += .version
# This is required so that changes to e.g., emit_bug_reporting_address
# provoke regeneration of all the manpages.
mandeps += $(top_srcdir)/src/system.h
$(ALL_MANS): $(mandeps)
# Most prog.1 man pages depend on src/prog. List the exceptions:
# Note that dir and vdir are exceptions only if you consider the name
# of the .c file upon which they depend: ls.c.
man/arch.1: src/uname
man/dir.1: src/dir
man/install.1: src/ginstall
man/vdir.1: src/vdir
man/base64.1: src/base64
man/basename.1: src/basename
man/cat.1: src/cat
man/chcon.1: src/chcon
man/chgrp.1: src/chgrp
man/chmod.1: src/chmod
man/chown.1: src/chown
man/chroot.1: src/chroot
man/cksum.1: src/cksum
man/comm.1: src/comm
man/cp.1: src/cp
man/csplit.1: src/csplit
man/cut.1: src/cut
man/date.1: src/date
man/dd.1: src/dd
man/df.1: src/df
man/dircolors.1: src/dircolors
man/dirname.1: src/dirname
man/du.1: src/du
man/echo.1: src/echo
man/env.1: src/env
man/expand.1: src/expand
man/expr.1: src/expr
man/factor.1: src/factor
man/false.1: src/false
man/fmt.1: src/fmt
man/fold.1: src/fold
man/groups.1: src/groups
man/head.1: src/head
man/hostid.1: src/hostid
man/hostname.1: src/hostname
man/id.1: src/id
man/join.1: src/join
man/kill.1: src/kill
man/link.1: src/link
man/ln.1: src/ln
man/logname.1: src/logname
man/ls.1: src/ls
man/md5sum.1: src/md5sum
man/mkdir.1: src/mkdir
man/mkfifo.1: src/mkfifo
man/mknod.1: src/mknod
man/mktemp.1: src/mktemp
man/mv.1: src/mv
man/nice.1: src/nice
man/nl.1: src/nl
man/nohup.1: src/nohup
man/nproc.1: src/nproc
man/od.1: src/od
man/paste.1: src/paste
man/pathchk.1: src/pathchk
man/pinky.1: src/pinky
man/pr.1: src/pr
man/printenv.1: src/printenv
man/printf.1: src/printf
man/ptx.1: src/ptx
man/pwd.1: src/pwd
man/readlink.1: src/readlink
man/realpath.1: src/realpath
man/rm.1: src/rm
man/rmdir.1: src/rmdir
man/runcon.1: src/runcon
man/seq.1: src/seq
man/sha1sum.1: src/md5sum
man/sha224sum.1: src/md5sum
man/sha256sum.1: src/md5sum
man/sha384sum.1: src/md5sum
man/sha512sum.1: src/md5sum
man/shred.1: src/shred
man/shuf.1: src/shuf
man/sleep.1: src/sleep
man/sort.1: src/sort
man/split.1: src/split
man/stat.1: src/stat
man/stdbuf.1: src/stdbuf
man/stty.1: src/stty
man/sum.1: src/sum
man/sync.1: src/sync
man/tac.1: src/tac
man/tail.1: src/tail
man/tee.1: src/tee
man/test.1: src/test
man/timeout.1: src/timeout
man/touch.1: src/touch
man/tr.1: src/tr
man/true.1: src/true
man/truncate.1: src/truncate
man/tsort.1: src/tsort
man/tty.1: src/tty
man/uname.1: src/uname
man/unexpand.1: src/unexpand
man/uniq.1: src/uniq
man/unlink.1: src/unlink
man/uptime.1: src/uptime
man/users.1: src/users
man/wc.1: src/wc
man/who.1: src/who
man/whoami.1: src/whoami
man/yes.1: src/yes
.x.1:
$(AM_V_GEN)name=`echo $@ | sed 's|.*/||; s|\.1$$||'` || exit 1; \
## Ensure that help2man runs the 'src/ginstall' binary as 'install' when
## creating 'install.1'. Similarly, ensure that it uses the 'src/[' binary
## to create 'test.1'.
case $$name in \
install) prog='ginstall';; \
test) prog='[';; \
*) prog=$$name;; \
esac; \
## Note the use of $$t/$*, rather than just '$*' as in other packages.
## That is necessary to avoid failures for programs that are also shell
## built-in functions like echo, false, printf, pwd.
rm -f $@ $@-t \
&& t=$*.td \
&& rm -rf $$t \
&& $(MKDIR_P) $$t \
&& (cd $$t && $(LN_S) '$(abs_top_builddir)/src/'$$prog $$name) \
&& $(run_help2man) \
--source='$(PACKAGE_STRING)' \
--include=$(srcdir)/man/$$name.x \
--output=$$t/$$name.1 $$t/$$name \
&& sed 's|$*\.td/||g' $$t/$$name.1 > $@-t \
&& rm -rf $$t \
&& chmod -w $@-t \
&& mv $@-t $@