Makefile revision 15929
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User# Makefile for generateing man page tarballs that are used in each of the
75c0816e8295e180f4bc7f10db3d0d880383bc1cMark Andrews# SUNW*.spec files
4a14ce5ba00ab7bc55c99ffdcf59c7a4ab902721Automatic Updater# Generates : $(PACKAGE)-manpages-$(MANPAGE_VERSION).tar.gz
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# e.g. sun-manpage-tarballs/*.tar.gz
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# "make" : Rebuilds all man page tarballs
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# "make check-used" : Outputs list of man pages not being used.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# "make check-version" : Prints current man page tarball version
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# "make $(PACKAGE)-manpages-$(MANPAGE_VERSION).tar.gz
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# e.g. "make SUNWgnome-panel-manpages-0.1.tar.gz"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# will only generate SUNWgnome-panel's man page tarball
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# For each package that contains man pages.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - Ensure all relevant man pages for your package are located under the
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# correct man page section dir i.e.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - Add Package name to PACKAGES Variable
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# e.g. PACKAGES = \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# SUNWgnome-panel \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# SUNWyour-package
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - Add two package specific variables
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# PACKAGE_PAGES - Full path of all manpages for this package
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews# e.g. SUNWgnome-panel_PAGES = man1/gnome-panel.1 etc...
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# PACKAGE.PAGES - Assigned to $(PACKAGE_PAGES).
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# e.g. SUNWgnome-panel.PAGES: $(SUNWgnome-panel_PAGES)
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# To Add new man pages to existing packages
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# -----------------------------------------
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# Put very simply, all that is required from engineers is to make some changes
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# and commit in SVN.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - Ensure the man page exists in SVN under the relevant man page section sub
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# - Add man page to the SUNW<package>_PAGES Makefile variable
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# e.g. For a new gnome-panel man page it would be added to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# SUNWgnome-panel_PAGES
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - Remake tarballs
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# This will re-generate all man page tarballs.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# - Copy newly generated tarball from sun-manpage-tarballs to package build
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# sources e.g. /jds/packages/SOURCES, and ensure package builds and manpages
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# install correctly.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# - New man page tarball will be generated by RE for each nightly, and for each
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# milestone build.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# - Commit change back to subverison, e.g. new/amended man pagees,
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# Solaris/manpages/Makefile, Solaris/S*.spec files if affected.
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# MANPAGE_VERSION is maintained by RE and only gets bumped when spec-files gets
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews# branched. PLEASE do not change this.
SUNWw3m \
SUNWdia \
SUNWbabl \
SUNWTiff_PAGES = \
SUNWcheese_PAGES = \
SUNWdbus_PAGES = \
SUNWjpg_PAGES = \
SUNWpng_PAGES = \
SUNWfsexam_PAGES = \
SUNWgamin_PAGES = \
SUNWglibmm_PAGES = \
SUNWsigcpp_PAGES = \
SUNWgnutls_PAGES = \
SUNWgtkmm_PAGES = \
SUNWespeak_PAGES = \
SUNWw3m_PAGES = \
SUNWlibgsf_PAGES = \
SUNWdia_PAGES = \
SUNWdrivel_PAGES = \
SUNWbabl_PAGES = \
SUNWgegl_PAGES = \
@if test -f $(TARBALL_DIR)/$@; then \
echo " $$base_manpage"; \
echo " install --mode=0644 \$$\$$mp \$$(DESTDIR)\$$(MAN"$$mantype"DIR); \\" >> $(MANPAGE_DIR)/Makefile; \
@if test -f unused-manpages.txt; then \
@echo $(MANPAGE_VERSION)