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