kc3-lang/automake/tests/man4.test

• Show log

  Commit

• Hash : 0fb020fa
  Author :
  Date : 2008-12-21T22:38:37
  

  Revamp semantics for `missing help2man' and manpage distribution.
  
  Previously, `missing help2man' would create a missing man page
  containing an error message, and exit 1.  This does not play
  well with `make': the next run will see this particular man page
  as being up to date, and will only error out on the next
  generated man page, if any; repeat until all pages are done.
  This patch changes `missing' to exit successfully in this case,
  but `make dist' will ensure that no such man pages are packaged.
  
  * lib/missing: Exit successfully even if we create a replacement
  page due to missing help2man.
  * automake.in (make_paragraphs): Define %HAVE-MANS% to be true
  if this makefile deals with man pages.
  * lib/am/distdir.am (distdir): If %INSTALL-MAN% and %HAVE-MANS%,
  check that no man page in $(MANS) contains the replacement text
  from `missing'.
  * tests/man4.test: New test.
  * tests/Makefile.am: Update.
  * NEWS: Reorder a bit, update.
  * THANKS: Update.
  Report by Werner Lemberg and Karl Berry.
  
  Signed-off-by: Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
  

Download

• tests/man4.test

• #! /bin/sh
  # Copyright (C) 2008  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, 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/>.
  
  # Ensure `make dist' fails when help2man replacement man pages are created.
  #
  # The assumption here is the following: if the developer uses help2man to
  # generate man pages from --help output, then these man pages may not be
  # stored in VCS.  However, they should be distributed, so that the end user
  # that receives the tarball doesn't have to install help2man.  If they are
  # not distributed, then the developer should make help2man a prerequisite
  # to building the package from a tarball, e.g., with a configure check for
  # help2man that errors out if it is unavailable.  In both cases it is
  # sufficient to check only distributed man pages.
  #
  # Idea of this whole shenanigan is to allow somebody to check out sources from
  # a VCS and build and install them without needing help2man installed.  The
  # installed man pages will be bogus in this case.  Typically, this happens
  # when developers ask users to try out a fix from VCS; the developers themselves
  # will usually have help2man installed (or should install it).
  
  . ./defs || Exit 1
  
  set -e
  
  cat > Makefile.am << 'END'
  dist_man_MANS = $(srcdir)/foo.1 bar.1
  dist_bin_SCRIPTS = foo bar
  $(srcdir)/foo.1:
  	$(HELP2MAN) --output=$@ $(srcdir)/foo
  bar.1:
  	$(HELP2MAN) --output=$(srcdir)/bar.1 $(srcdir)/bar
  
  ## It is a bug that we need to list $(srcdir)/bar.1 explicitly here.
  MAINTAINERCLEANFILES = $(dist_man_MANS) $(srcdir)/bar.1
  END
  
  cat >>configure.in <<'END'
  AM_MISSING_PROG([HELP2MAN], [help2man])
  AC_OUTPUT
  END
  
  cat > foo <<'END'
  #! /bin/sh
  while test $# -gt 0; do
    case $1 in
      -h | --help) echo "usage: $0 [OPTIONS]..."; exit 0;;
      -v | --version) echo "$0 1.0"; exit 0;;
    esac
    shift
  done
  END
  
  cp foo bar
  
  cat > help2man <<'END'
  #! /bin/sh
  # fake help2man script that lets `missing' think it is not installed
  exit 127
  END
  
  chmod +x foo bar help2man
  save_PATH=$PATH
  PATH=`pwd`:$PATH
  
  $ACLOCAL
  $AUTOMAKE
  $AUTOCONF
  ./configure
  $MAKE
  $MAKE dist && Exit 1
  $MAKE distcheck && Exit 1
  $MAKE distclean
  
  mkdir build
  cd build
  ../configure
  $MAKE
  $MAKE dist 2>stderr && { cat stderr >&2; Exit 1; }
  cat stderr >&2
  grep 'install help2man' stderr
  $MAKE distcheck 2>stderr && { cat stderr >&2; Exit 1; }
  cat stderr >&2
  grep 'install help2man' stderr
  
  rm -f ../help2man
  PATH=$save_PATH
  export PATH
  
  # If help2man is installed, then ensure that the recommendation works.
  if (help2man --version) >/dev/null 2>&1; then
    $MAKE maintainer-clean
    ../configure
    $MAKE
    $MAKE distcheck
  fi
  :
  

Download