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