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