Makefile revision 13360
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User# Makefile for generateing man page tarballs that are used in each of the
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# SUNW*.spec files
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User# Generates : $(PACKAGE)-manpages-$(MANPAGE_VERSION).tar.gz
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User# e.g. sun-manpage-tarballs/*.tar.gz
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# "make" : Rebuilds all man page tarballs
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User# "make check-used" : Outputs list of man pages not being used.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt# "make check-version" : Prints current man page tarball version
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User# "make $(PACKAGE)-manpages-$(MANPAGE_VERSION).tar.gz
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User# e.g. "make SUNWgnome-panel-manpages-0.1.tar.gz"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# will only generate SUNWgnome-panel's man page tarball
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# For each package that contains man pages.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# - Ensure all relevant man pages for your package are located under the
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User# correct man page section dir i.e.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# - Add Package name to PACKAGES Variable
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# e.g. PACKAGES = \
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# SUNWgnome-panel \
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# SUNWyour-package
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# - Add two package specific variables
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# PACKAGE_PAGES - Full path of all manpages for this package
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# e.g. SUNWgnome-panel_PAGES = man1/gnome-panel.1 etc...
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# PACKAGE.PAGES - Assigned to $(PACKAGE_PAGES).
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# e.g. SUNWgnome-panel.PAGES: $(SUNWgnome-panel_PAGES)
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# To Add new man pages to existing packages
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# -----------------------------------------
af40ebed6257e4ac1996144530b3de317cf4da11Tinderbox User# Put very simply, all that is required from engineers is to make some changes
af40ebed6257e4ac1996144530b3de317cf4da11Tinderbox User# and commit in SVN.
af40ebed6257e4ac1996144530b3de317cf4da11Tinderbox User# - Ensure the man page exists in SVN under the relevant man page section sub
af40ebed6257e4ac1996144530b3de317cf4da11Tinderbox User# - Add man page to the SUNW<package>_PAGES Makefile variable
af40ebed6257e4ac1996144530b3de317cf4da11Tinderbox User# e.g. For a new gnome-panel man page it would be added to
af40ebed6257e4ac1996144530b3de317cf4da11Tinderbox User# SUNWgnome-panel_PAGES
af40ebed6257e4ac1996144530b3de317cf4da11Tinderbox User# - Remake tarballs
af40ebed6257e4ac1996144530b3de317cf4da11Tinderbox User# This will re-generate all man page tarballs.
af40ebed6257e4ac1996144530b3de317cf4da11Tinderbox User# - Copy newly generated tarball from sun-manpage-tarballs to package build
af40ebed6257e4ac1996144530b3de317cf4da11Tinderbox User# sources e.g. /jds/packages/SOURCES, and ensure package builds and manpages
af40ebed6257e4ac1996144530b3de317cf4da11Tinderbox User# install correctly.
af40ebed6257e4ac1996144530b3de317cf4da11Tinderbox User# - New man page tarball will be generated by RE for each nightly, and for each
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# milestone build.
af40ebed6257e4ac1996144530b3de317cf4da11Tinderbox User# - Commit change back to subverison, e.g. new/amended man pagees,
af40ebed6257e4ac1996144530b3de317cf4da11Tinderbox User# Solaris/manpages/Makefile, Solaris/S*.spec files if affected.
af40ebed6257e4ac1996144530b3de317cf4da11Tinderbox User# MANPAGE_VERSION is maintained by RE and only gets bumped when spec-files gets
af40ebed6257e4ac1996144530b3de317cf4da11Tinderbox User# branched. PLEASE do not change this.
SUNWdbus_PAGES = \
SUNWjpg_PAGES = \
SUNWpng_PAGES = \
SUNWfsexam_PAGES = \
SUNWgamin_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)