1
1

Some more work on the man pages:

* Make the creation of the build dir for the man pages a bit more
   robust (thanks to suggestions from Ralf W.).
 * Only distribute the .Xin files, not the .X man pages themselves.
 * Make the .X files depend on opal_config.h so that if you re-run
   configure and change opal_config.h (e.g., a new version), the man
   pages should get rebuilt.
 * Man pages are now cleaned with "distclean", not "maintainer-clean".
 * Fix a typo in opal_crs.7in.
 * Udpate make_dist_tarball to update "date" in the VERSION file.
 * Make make_dist_tarball a bit friendlier to hg checkouts.

This commit was SVN r19219.
This commit is contained in:
Jeff Squyres 2008-08-07 19:20:40 +00:00
parent 9a75ed0059
commit 797ec531aa
23 changed files with 171 additions and 74 deletions

View File

@ -10,7 +10,6 @@
.1in.1:
@ echo Creating $@ man page...
-@$(mkdir_p) `dirname $@`
@ sed -e 's/#PACKAGE_NAME#/@PACKAGE_NAME@/g' \
-e 's/#PACKAGE_VERSION#/@PACKAGE_VERSION@/g' \
-e 's/#OMPI_DATE#/@OMPI_RELEASE_DATE@/g' \
@ -18,7 +17,6 @@
.3in.3:
@ echo Creating $@ man page...
-@$(mkdir_p) `dirname $@`
@ sed -e 's/#PACKAGE_NAME#/@PACKAGE_NAME@/g' \
-e 's/#PACKAGE_VERSION#/@PACKAGE_VERSION@/g' \
-e 's/#OMPI_DATE#/@OMPI_RELEASE_DATE@/g' \
@ -26,7 +24,6 @@
.7in.7:
@ echo Creating $@ man page...
-@$(mkdir_p) `dirname $@`
@ sed -e 's/#PACKAGE_NAME#/@PACKAGE_NAME@/g' \
-e 's/#PACKAGE_VERSION#/@PACKAGE_VERSION@/g' \
-e 's/#OMPI_DATE#/@OMPI_RELEASE_DATE@/g' \

View File

@ -10,6 +10,7 @@
# University of Stuttgart. All rights reserved.
# Copyright (c) 2004-2005 The Regents of the University of California.
# All rights reserved.
# Copyright (c) 2008 Cisco Systems, Inc. All rights reserved.
# $COPYRIGHT$
#
# Additional copyrights may follow
@ -125,26 +126,39 @@ fi
#
# Do svn up and all that
#
echo "*** Removing old VERSION files..."
find . -name VERSION -exec rm -f {} \; -print
echo "*** Removing old VERSION file..."
rm -f VERSION
echo "*** Running svn up..."
svn up
if test ! "$?" = "0"; then
echo "SVN update failed. Aborting"
exit 1
if test -d .svn; then
echo "*** Running svn up..."
svn up
if test ! "$?" = "0"; then
echo "SVN update failed. Aborting"
exit 1
fi
elif test -d .hg; then
echo "*** Running hg up..."
hg revert VERSION
hg up
if test ! "$?" = "0"; then
echo "SVN update failed. Aborting"
exit 1
fi
fi
#
# Ditch "svn" from all version numbers
# Ditch "svn/hg" from all version numbers
#
echo "*** Removing svn version numbers..."
svn_r="r`svnversion .`"
version_files="`find . -name VERSION`"
version_files=VERSION
release_date=`date '+%b %d, %Y'`
for file in $version_files; do
echo " - $file"
sed -e 's/^want_svn=.*/want_svn=0/' \
-e 's/^svn_r=.*/'svn_r=$svn_r/ $file > $file.new
-e 's/^svn_r=.*/'svn_r=$svn_r/ \
-e "s/^date=.*/date=\"$release_date\"/" \
$file > $file.new
cp -f $file.new $file
rm $file.new
done

View File

@ -127,7 +127,7 @@ include_HEADERS =
nobase_ompi_HEADERS =
dist_pkgdata_DATA =
libmpi_la_SOURCES += $(headers)
dist_man_MANS =
nodist_man_MANS =
# Conditionally install the header files
@ -156,5 +156,20 @@ include mpi/Makefile.am
include mpi/f77/base/Makefile.include
include mpi/man/man3/Makefile.extra
maintainer-clean-local:
rm -f $(dist_man_MANS)
# Ensure that the man page directory exists before we try to make man
# page files (because ompi/mpi/man/man3 has no config.status-generated
# Makefile)
dir_stamp = $(top_builddir)/$(subdir)/mpi/man/man3/.dir-stamp
# Also ensure that the man pages are rebuilt if the opal_config.h file
# changes (e.g., configure was run again, meaning that the release
# date or version may have changed)
$(nodist_man_MANS): $(dir_stamp) $(top_builddir)/opal/include/opal_config.h
$(dir_stamp):
$(mkdir_p) `dirname $@`
touch "$@"
# Remove the generated man pages
distclean-local:
rm -f $(nodist_man_MANS) $(dir_stamp)

View File

@ -32,8 +32,13 @@ headers = crcp.h
libmca_crcp_la_SOURCES += $(headers)
# Manual pages
dist_man_MANS = ompi_crcp.7
EXTRA_DIST = $(dist_man_MANS:.7=.7in)
nodist_man_MANS = ompi_crcp.7
EXTRA_DIST = $(nodist_man_MANS:.7=.7in)
# Ensure that the man pages are rebuilt if the opal_config.h file
# changes; a "good enough" way to know if configure was run again (and
# therefore the release date or version may have changed)
$(nodist_man_MANS): $(top_builddir)/opal/include/opal_config.h
# Conditionally install the header files
if WANT_INSTALL_HEADERS
@ -47,3 +52,4 @@ include base/Makefile.am
distclean-local:
rm -f base/static-components.h
rm -f $(nodist_man_MANS)

View File

@ -318,5 +318,5 @@ mpi_api_man_pages = \
mpi/man/man3/MPI_Wtime.3 \
mpi/man/man3/OpenMPI.3
dist_man_MANS += $(mpi_api_man_pages)
EXTRA_DIST += $(mpi_api_man_pages)
nodist_man_MANS += $(mpi_api_man_pages)
EXTRA_DIST += $(mpi_api_man_pages:.3=.3in)

View File

@ -21,7 +21,7 @@
include $(top_srcdir)/Makefile.man-page-rules
man_pages = ompi-server.1
EXTRA_DIST = $(man_pages) $(man_pages:.1=.1in)
EXTRA_DIST = $(man_pages:.1=.1in)
if OMPI_INSTALL_BINARIES
if !ORTE_DISABLE_FULL_SUPPORT
@ -30,7 +30,12 @@ bin_PROGRAMS = ompi-server
dist_pkgdata_DATA = help-ompi-server.txt
man_MANS = $(man_pages)
nodist_man_MANS = $(man_pages)
# Ensure that the man pages are rebuilt if the opal_config.h file
# changes; a "good enough" way to know if configure was run again (and
# therefore the release date or version may have changed)
$(nodist_man_MANS): $(top_builddir)/opal/include/opal_config.h
endif # !ORTE_DISABLE_FULL_SUPPORT
endif # OMPI_INSTALL_BINARIES
@ -38,5 +43,5 @@ endif # OMPI_INSTALL_BINARIES
ompi_server_SOURCES = ompi-server.c
ompi_server_LDADD = $(top_builddir)/ompi/libmpi.la
maintainer-clean-local:
distclean-local:
rm -f $(man_pages)

View File

@ -42,7 +42,7 @@ AM_CPPFLAGS = \
include $(top_srcdir)/Makefile.man-page-rules
man_pages = ompi_info.1
EXTRA_DIST = $(man_pages) $(man_pages:.1=.1in)
EXTRA_DIST = $(man_pages:.1=.1in)
if OMPI_INSTALL_BINARIES
@ -50,7 +50,12 @@ bin_PROGRAMS = ompi_info
dist_pkgdata_DATA = help-ompi_info.txt
man_MANS = $(man_pages)
nodist_man_MANS = $(man_pages)
# Ensure that the man pages are rebuilt if the opal_config.h file
# changes; a "good enough" way to know if configure was run again (and
# therefore the release date or version may have changed)
$(nodist_man_MANS): $(top_builddir)/opal/include/opal_config.h
endif
@ -66,5 +71,5 @@ ompi_info_LDADD = $(top_builddir)/ompi/libmpi.la
clean-local:
test -z "$(OMPI_CXX_TEMPLATE_REPOSITORY)" || $(RM) -rf $(OMPI_CXX_TEMPLATE_REPOSITORY)
maintainer-clean-local:
distclean-local:
rm -f $(man_pages)

View File

@ -18,12 +18,11 @@
#
man_pages = mpirun.1 mpiexec.1 ompi-ps.1 ompi-clean.1
EXTRA_DIST = $(man_pages)
if OMPI_INSTALL_BINARIES
if !ORTE_DISABLE_FULL_SUPPORT
man_MANS = $(man_pages)
nodist_man_MANS = $(man_pages)
install-exec-hook:
(cd $(DESTDIR)$(bindir); rm -f mpirun$(EXEEXT); $(LN_S) orterun$(EXEEXT) mpirun$(EXEEXT))
@ -61,5 +60,5 @@ $(top_builddir)/orte/tools/orte-clean/orte-clean.1:
ompi-clean.1: $(top_builddir)/orte/tools/orte-clean/orte-clean.1
cp -f $(top_builddir)/orte/tools/orte-clean/orte-clean.1 ompi-clean.1
maintainer-clean-local:
distclean-local:
rm -f $(man_pages)

View File

@ -18,7 +18,6 @@
#
man_pages = mpicc.1 mpic++.1 mpicxx.1 mpif77.1 mpif90.1
EXTRA_DIST = $(man_pages)
if OMPI_WANT_SCRIPT_WRAPPER_COMPILERS
@ -109,7 +108,7 @@ endif # OMPI_WANT_SHELL_WRAPPER_COMPILERS
# Man page generation / handling
#
########################################################
maintainer-clean-local:
distclean-local:
rm -f $(man_pages)
$(top_builddir)/opal/tools/wrappers/generic_wrapper.1:

View File

@ -32,8 +32,13 @@ headers = crs.h
libmca_crs_la_SOURCES += $(headers)
# Manual pages
dist_man_MANS = opal_crs.7
EXTRA_DIST = $(dist_man_MANS:.7=.7in)
nodist_man_MANS = opal_crs.7
EXTRA_DIST = $(nodist_man_MANS:.7=.7in)
# Ensure that the man pages are rebuilt if the opal_config.h file
# changes; a "good enough" way to know if configure was run again (and
# therefore the release date or version may have changed)
$(nodist_man_MANS): $(top_builddir)/opal/include/opal_config.h
# Conditionally install the header files
if WANT_INSTALL_HEADERS
@ -46,4 +51,5 @@ endif
include base/Makefile.am
distclean-local:
rm -f base/static-components.h
rm -f base/static-components.h
rm -f $(nodist_man_MANS)

View File

@ -6,7 +6,7 @@
.\" Man page for OPAL's CRS Functionality
.\"
.\" .TH name section center-footer left-footer center-header
.TH OPAL_CRS 7 "#OMPI_DATE#" "#PACKAGE_VERSION" "#PACKAGE_NAME#"
.TH OPAL_CRS 7 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
.\" **************************
.\" Name Section

View File

@ -21,13 +21,18 @@
include $(top_srcdir)/Makefile.man-page-rules
man_pages = opal-checkpoint.1
EXTRA_DIST = $(man_pages) $(man_pages:.1=.1in)
EXTRA_DIST = $(man_pages:.1=.1in)
if OMPI_INSTALL_BINARIES
bin_PROGRAMS = opal-checkpoint
man_MANS = $(man_pages)
nodist_man_MANS = $(man_pages)
# Ensure that the man pages are rebuilt if the opal_config.h file
# changes; a "good enough" way to know if configure was run again (and
# therefore the release date or version may have changed)
$(nodist_man_MANS): $(top_builddir)/opal/include/opal_config.h
dist_pkgdata_DATA = help-opal-checkpoint.txt
@ -36,5 +41,5 @@ endif # OMPI_INSTALL_BINARIES
opal_checkpoint_SOURCES = opal-checkpoint.c
opal_checkpoint_LDADD = $(top_builddir)/opal/libopen-pal.la
maintainer-clean-local:
distclean-local:
rm -f $(man_pages)

View File

@ -21,13 +21,18 @@
include $(top_srcdir)/Makefile.man-page-rules
man_pages = opal-restart.1
EXTRA_DIST = $(man_pages) $(man_pages:.1=.1in)
EXTRA_DIST = $(man_pages:.1=.1in)
if OMPI_INSTALL_BINARIES
bin_PROGRAMS = opal-restart
man_MANS = $(man_pages)
nodist_man_MANS = $(man_pages)
# Ensure that the man pages are rebuilt if the opal_config.h file
# changes; a "good enough" way to know if configure was run again (and
# therefore the release date or version may have changed)
$(nodist_man_MANS): $(top_builddir)/opal/include/opal_config.h
dist_pkgdata_DATA = help-opal-restart.txt
@ -36,5 +41,5 @@ endif # OMPI_INSTALL_BINARIES
opal_restart_SOURCES = opal-restart.c
opal_restart_LDADD = $(top_builddir)/opal/libopen-pal.la
maintainer-clean-local:
distclean-local:
rm -f $(man_pages)

View File

@ -21,7 +21,7 @@
DEFS="-DEXEEXT=\"$(EXEEXT)\""
real_man_pages = generic_wrapper.1 opal_wrapper.1
EXTRA_DIST = $(real_man_pages) $(real_man_pages:1.=.1in)
EXTRA_DIST = $(real_man_pages:.1=.1in)
include $(top_srcdir)/Makefile.man-page-rules
@ -30,7 +30,7 @@ if OMPI_INSTALL_BINARIES
bin_PROGRAMS = opal_wrapper
man_MANS = opal_wrapper.1
nodist_man_MANS = opal_wrapper.1
dist_pkgdata_DATA = help-opal-wrapper.txt
@ -41,7 +41,7 @@ nodist_pkgdata_DATA = \
opalcc-wrapper-data.txt \
opalc++-wrapper-data.txt
man_MANS += opalcc.1 opalc++.1
nodist_man_MANS += opalcc.1 opalc++.1
install-exec-hook:
(cd $(DESTDIR)$(bindir); rm -f opalcc$(EXEEXT); $(LN_S) opal_wrapper opalcc)
@ -59,8 +59,10 @@ endif # OMPI_WANT_SCRIPT_WRAPPER_COMPILERS
opal_wrapper_SOURCES = opal_wrapper.c
opal_wrapper_LDADD = $(top_builddir)/opal/libopen-pal.la
maintainer-clean-local:
rm -f $(real_man_pages) opalcc.1 opalc++.1
# Ensure that the man pages are rebuilt if the opal_config.h file
# changes; a "good enough" way to know if configure was run again (and
# therefore the release date or version may have changed)
$(real_man_pages): $(top_builddir)/opal/include/opal_config.h
opalcc.1: generic_wrapper.1
rm -f opalcc.1
@ -70,3 +72,5 @@ opalc++.1: generic_wrapper.1
rm -f opalc++.1
sed -e 's/#COMMAND#/opalc++/g' -e 's/#PROJECT#/Open PAL/g' -e 's/#PROJECT_SHORT#/OPAL/g' -e 's/#LANGUAGE#/C++/g' < $(top_builddir)/opal/tools/wrappers/generic_wrapper.1 > opalc++.1
distclean-local:
rm -f $(real_man_pages) opalcc.1 opalc++.1

View File

@ -32,8 +32,13 @@ headers = filem.h
libmca_filem_la_SOURCES += $(headers)
# Manual pages
dist_man_MANS = orte_filem.7
EXTRA_DIST = $(dist_man_MANS:.7=.7in)
nodist_man_MANS = orte_filem.7
EXTRA_DIST = $(nodist_man_MANS:.7=.7in)
# Ensure that the man pages are rebuilt if the opal_config.h file
# changes; a "good enough" way to know if configure was run again (and
# therefore the release date or version may have changed)
$(nodist_man_MANS): $(top_builddir)/opal/include/opal_config.h
# Conditionally install the header files
if WANT_INSTALL_HEADERS
@ -47,3 +52,4 @@ include base/Makefile.am
distclean-local:
rm -f base/static-components.h
rm -f $(nodist_man_MANS)

View File

@ -32,8 +32,13 @@ headers = snapc.h
libmca_snapc_la_SOURCES += $(headers)
# Manual pages
dist_man_MANS = orte_snapc.7
EXTRA_DIST = $(dist_man_MANS:.7=.7in)
nodist_man_MANS = orte_snapc.7
EXTRA_DIST = $(nodist_man_MANS:.7=.7in)
# Ensure that the man pages are rebuilt if the opal_config.h file
# changes; a "good enough" way to know if configure was run again (and
# therefore the release date or version may have changed)
$(nodist_man_MANS): $(top_builddir)/opal/include/opal_config.h
# Conditionally install the header files
if WANT_INSTALL_HEADERS
@ -47,3 +52,4 @@ include base/Makefile.am
distclean-local:
rm -f base/static-components.h
rm -f $(nodist_man_MANS)

View File

@ -20,10 +20,8 @@
include $(top_srcdir)/Makefile.man-page-rules
# Bug in AM 1.10.1: need to list man pages because dist_man_MANS is
# not picked up inside of an AM_CONDITIONAL
man_pages = orte-checkpoint.1 ompi-checkpoint.1
EXTRA_DIST = $(man_pages) orte-checkpoint.1in
EXTRA_DIST = orte-checkpoint.1in
if !ORTE_DISABLE_FULL_SUPPORT
if WANT_FT
@ -31,7 +29,12 @@ if OMPI_INSTALL_BINARIES
bin_PROGRAMS = orte-checkpoint
man_MANS = $(man_pages)
nodist_man_MANS = $(man_pages)
# Ensure that the man pages are rebuilt if the opal_config.h file
# changes; a "good enough" way to know if configure was run again (and
# therefore the release date or version may have changed)
$(nodist_man_MANS): $(top_builddir)/opal/include/opal_config.h
dist_pkgdata_DATA = help-orte-checkpoint.txt
@ -52,5 +55,5 @@ endif # !ORTE_DISABLE_FULL_SUPPORT
ompi-checkpoint.1: $(top_builddir)/orte/tools/orte-checkpoint/orte-checkpoint.1
cp -f $(top_builddir)/orte/tools/orte-checkpoint/orte-checkpoint.1 ompi-checkpoint.1
maintainer-clean-local:
distclean-local:
rm -f $(man_pages)

View File

@ -21,14 +21,19 @@
include $(top_srcdir)/Makefile.man-page-rules
man_pages = orte-clean.1
EXTRA_DIST = $(man_pages) $(man_pages:.1=.1in)
EXTRA_DIST = $(man_pages:.1=.1in)
if !ORTE_DISABLE_FULL_SUPPORT
if OMPI_INSTALL_BINARIES
bin_PROGRAMS = orte-clean
man_MANS = $(man_pages)
nodist_man_MANS = $(man_pages)
# Ensure that the man pages are rebuilt if the opal_config.h file
# changes; a "good enough" way to know if configure was run again (and
# therefore the release date or version may have changed)
$(nodist_man_MANS): $(top_builddir)/opal/include/opal_config.h
dist_pkgdata_DATA = help-orte-clean.txt
@ -39,5 +44,5 @@ orte_clean_LDADD = $(top_builddir)/orte/libopen-rte.la
endif # !ORTE_DISABLE_FULL_SUPPORT
maintainer-clean-local:
distclean-local:
rm -f $(man_pages)

View File

@ -21,14 +21,19 @@
include $(top_srcdir)/Makefile.man-page-rules
man_pages = orte-ps.1
EXTRA_DIST = $(man_pages) $(man_pages:.1=.1in)
EXTRA_DIST = $(man_pages:.1=.1in)
if !ORTE_DISABLE_FULL_SUPPORT
if OMPI_INSTALL_BINARIES
bin_PROGRAMS = orte-ps
dist_man_MANS = $(man_pages)
nodist_man_MANS = $(man_pages)
# Ensure that the man pages are rebuilt if the opal_config.h file
# changes; a "good enough" way to know if configure was run again (and
# therefore the release date or version may have changed)
$(nodist_man_MANS): $(top_builddir)/opal/include/opal_config.h
dist_pkgdata_DATA = help-orte-ps.txt
@ -39,5 +44,5 @@ orte_ps_LDADD = $(top_builddir)/orte/libopen-rte.la
endif # !ORTE_DISABLE_FULL_SUPPORT
maintainer-clean-local:
distclean-local:
rm -f $(man_pages)

View File

@ -20,10 +20,8 @@
include $(top_srcdir)/Makefile.man-page-rules
# Bug in AM 1.10.1: need to list man pages because dist_man_MANS is
# not picked up inside of an AM_CONDITIONAL
man_pages = orte-restart.1 ompi-restart.1
EXTRA_DIST = $(man_pages) orte-restart.1in
EXTRA_DIST = orte-restart.1in
if !ORTE_DISABLE_FULL_SUPPORT
if WANT_FT
@ -31,7 +29,12 @@ if OMPI_INSTALL_BINARIES
bin_PROGRAMS = orte-restart
man_MANS = $(man_pages)
nodist_man_MANS = $(man_pages)
# Ensure that the man pages are rebuilt if the opal_config.h file
# changes; a "good enough" way to know if configure was run again (and
# therefore the release date or version may have changed)
$(nodist_man_MANS): $(top_builddir)/opal/include/opal_config.h
dist_pkgdata_DATA = help-orte-restart.txt
@ -52,5 +55,5 @@ endif # ORTE_DISABLE_FULL_SUPPORT
ompi-restart.1: $(top_builddir)/orte/tools/orte-restart/orte-restart.1
cp -f $(top_builddir)/orte/tools/orte-restart/orte-restart.1 ompi-restart.1
maintainer-clean-local:
distclean-local:
rm -f $(man_pages)

View File

@ -21,14 +21,19 @@
include $(top_srcdir)/Makefile.man-page-rules
man_pages = orted.1
EXTRA_DIST = $(man_pages) $(man_pages:.1=.1in)
EXTRA_DIST = $(man_pages:.1=.1in)
if !ORTE_DISABLE_FULL_SUPPORT
if OMPI_INSTALL_BINARIES
bin_PROGRAMS = orted
man_MANS = $(man_pages)
nodist_man_MANS = $(man_pages)
# Ensure that the man pages are rebuilt if the opal_config.h file
# changes; a "good enough" way to know if configure was run again (and
# therefore the release date or version may have changed)
$(nodist_man_MANS): $(top_builddir)/opal/include/opal_config.h
endif # OMPI_INSTALL_BINARIES
@ -44,5 +49,5 @@ orted_LDADD = $(top_builddir)/orte/libopen-rte.la
endif # !ORTE_DISABLE_FULL_SUPPORT
maintainer-clean-local:
distclean-local:
rm -f $(man_pages)

View File

@ -30,14 +30,19 @@ CFLAGS = $(CFLAGS_WITHOUT_OPTFLAGS) $(TOTALVIEW_DEBUG_FLAGS)
include $(top_srcdir)/Makefile.man-page-rules
man_pages = orterun.1
EXTRA_DIST = $(man_pages) $(man_pages:.1=.1in)
EXTRA_DIST = $(man_pages:.1=.1in)
if !ORTE_DISABLE_FULL_SUPPORT
if OMPI_INSTALL_BINARIES
bin_PROGRAMS = orterun
dist_man_MANS = $(man_pages)
nodist_man_MANS = $(man_pages)
# Ensure that the man pages are rebuilt if the opal_config.h file
# changes; a "good enough" way to know if configure was run again (and
# therefore the release date or version may have changed)
$(nodist_man_MANS): $(top_builddir)/opal/include/opal_config.h
dist_pkgdata_DATA = help-orterun.txt
@ -54,5 +59,5 @@ orterun_LDADD = $(top_builddir)/orte/libopen-rte.la
endif # !ORTE_DISABLE_FULL_SUPPORT
maintainer-clean-local:
distclean-local:
rm -f $(man_pages)

View File

@ -18,7 +18,6 @@
#
man_pages = ortecc.1 ortec++.1
EXTRA_DIST = $(man_pages)
if !ORTE_DISABLE_FULL_SUPPORT
if !OMPI_WANT_SCRIPT_WRAPPER_COMPILERS
@ -46,7 +45,7 @@ endif # OMPI_INSTALL_BINARIES
endif # WANT_INSTALL_HEADERS
endif # OMPI_WANT_SCRIPT_WRAPPER_COMPILERS
maintainer-clean-local:
distclean-local:
rm -f $(man_pages)
ortecc.1: $(top_builddir)/opal/tools/wrappers/generic_wrapper.1