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