Makefile revision 10139
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User# Makefile for generateing man page tarballs that are used in each of the
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# SUNW*.spec files
4a14ce5ba00ab7bc55c99ffdcf59c7a4ab902721Automatic Updater# Generates : $(PACKAGE)-manpages-$(MANPAGE_VERSION).tar.gz
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# e.g. sun-manpage-tarballs/*.tar.gz
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# "make" : Rebuilds all man page tarballs
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# "make check-used" : Outputs list of man pages not being used.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# "make check-version" : Prints current man page tarball version
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# "make $(PACKAGE)-manpages-$(MANPAGE_VERSION).tar.gz
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# e.g. "make SUNWgnome-panel-manpages-0.1.tar.gz"
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User# 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
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# correct man page section dir i.e.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# - Add Package name to PACKAGES Variable
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# e.g. PACKAGES = \
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# SUNWgnome-panel \
9b469e3c59015b1a4899c9d8395168126fe094fdAutomatic Updater# 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)
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# To Add new man pages to existing packages
9b469e3c59015b1a4899c9d8395168126fe094fdAutomatic Updater# -----------------------------------------
9b469e3c59015b1a4899c9d8395168126fe094fdAutomatic Updater# Put very simply, all that is required from engineers is to make some changes
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# and commit in SVN.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# - Ensure the man page exists in SVN under the relevant man page section sub
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# - Add man page to the SUNW<package>_PAGES Makefile variable
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# e.g. For a new gnome-panel man page it would be added to
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# SUNWgnome-panel_PAGES
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# - Remake tarballs
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# This will re-generate all man page tarballs.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# - Copy newly generated tarball from sun-manpage-tarballs to package build
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# sources e.g. /jds/packages/SOURCES, and ensure package builds and manpages
b2f07642fd712c8fda81a116bcdde229ab291f33Tinderbox User# install correctly.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# - New man page tarball will be generated by RE for each nightly, and for each
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# milestone build.
11e9368a226272085c337e9e74b79808c16fbdbaTinderbox User# - Commit change back to subverison, e.g. new/amended man pagees,
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# Solaris/manpages/Makefile, Solaris/S*.spec files if affected.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# MANPAGE_VERSION is maintained by RE and only gets bumped when spec-files gets
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews# branched. PLEASE do not change this.
SUNWjpg_PAGES = \
SUNWpng_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)