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