Makefile revision 18117
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh# Makefile for generateing man page tarballs that are used in each of the
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh# SUNW*.spec files
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh# Generates : $(PACKAGE)-manpages-$(MANPAGE_VERSION).tar.gz
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh# e.g. sun-manpage-tarballs/*.tar.gz
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh# "make" : Rebuilds all man page tarballs
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh# "make check-used" : Outputs list of man pages not being used.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh# "make check-version" : Prints current man page tarball version
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh# "make $(PACKAGE)-manpages-$(MANPAGE_VERSION).tar.gz
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh# will only generate SUNWgnome-panel's man page tarball
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh# For each package that contains man pages.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh# - Ensure all relevant man pages for your package are located under the
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh# correct man page section dir i.e.
658280b6253b61dbb155f43d0e3cbcffa85ccb90David Hollister# entities/man1/man1m/man3/man3tiff/man4/man5
33f5ff17089e3a43e6e730bf80384c233123dbd9Milan Jurik# - Add Package name to PACKAGES Variable
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh# e.g. PACKAGES = \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh# SUNWgnome-panel \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh# SUNWyour-package
f7aef0b0ce0e9a2c3da9c2e3aa9122f3642c1459Reed# - Add two package specific variables
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh# PACKAGE_PAGES - Full path of all manpages for this package
c3bc407cfbd238a18e4728ad5f36f39cecdb062fdh# e.g. SUNWgnome-panel_PAGES = man1/gnome-panel.1 etc...
f7aef0b0ce0e9a2c3da9c2e3aa9122f3642c1459Reed# PACKAGE.PAGES - Assigned to $(PACKAGE_PAGES).
f7aef0b0ce0e9a2c3da9c2e3aa9122f3642c1459Reed# e.g. SUNWgnome-panel.PAGES: $(SUNWgnome-panel_PAGES)
9719310a57482091af0a7f0ee31b5e2eec35f154David Hollister# To Add new man pages to existing packages
9719310a57482091af0a7f0ee31b5e2eec35f154David Hollister# -----------------------------------------
9719310a57482091af0a7f0ee31b5e2eec35f154David Hollister# Put very simply, all that is required from engineers is to make some changes
9719310a57482091af0a7f0ee31b5e2eec35f154David Hollister# and commit in SVN.
9719310a57482091af0a7f0ee31b5e2eec35f154David Hollister# - Ensure the man page exists in SVN under the relevant man page section sub
f7aef0b0ce0e9a2c3da9c2e3aa9122f3642c1459Reed# - Add man page to the SUNW<package>_PAGES Makefile variable
f7aef0b0ce0e9a2c3da9c2e3aa9122f3642c1459Reed# e.g. For a new gnome-panel man page it would be added to
f7aef0b0ce0e9a2c3da9c2e3aa9122f3642c1459Reed# SUNWgnome-panel_PAGES
f7aef0b0ce0e9a2c3da9c2e3aa9122f3642c1459Reed# - Remake tarballs
f7aef0b0ce0e9a2c3da9c2e3aa9122f3642c1459Reed# This will re-generate all man page tarballs.
f7aef0b0ce0e9a2c3da9c2e3aa9122f3642c1459Reed# - Copy newly generated tarball from sun-manpage-tarballs to package build
f7aef0b0ce0e9a2c3da9c2e3aa9122f3642c1459Reed# sources e.g. /jds/packages/SOURCES, and ensure package builds and manpages
658280b6253b61dbb155f43d0e3cbcffa85ccb90David Hollister# install correctly.
658280b6253b61dbb155f43d0e3cbcffa85ccb90David Hollister# - New man page tarball will be generated by RE for each nightly, and for each
658280b6253b61dbb155f43d0e3cbcffa85ccb90David Hollister# milestone build.
658280b6253b61dbb155f43d0e3cbcffa85ccb90David Hollister# - Commit change back to subverison, e.g. new/amended man pagees,
658280b6253b61dbb155f43d0e3cbcffa85ccb90David Hollister# Solaris/manpages/Makefile, Solaris/S*.spec files if affected.
658280b6253b61dbb155f43d0e3cbcffa85ccb90David Hollister# MANPAGE_VERSION is maintained by RE and only gets bumped when spec-files gets
658280b6253b61dbb155f43d0e3cbcffa85ccb90David Hollister# branched. PLEASE do not change this.
f7aef0b0ce0e9a2c3da9c2e3aa9122f3642c1459ReedSUNWevolution-exchange.PAGES: $(SUNWevolution-exchange_PAGES)
f7aef0b0ce0e9a2c3da9c2e3aa9122f3642c1459ReedSUNWevolution-data-server.PAGES: $(SUNWevolution-data-server_PAGES)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhSUNWgnome-a11y-dasher.PAGES: $(SUNWgnome-a11y-dasher_PAGES)
601c90f161ff0319c1b4a2c3362b466043a65d8dSrikanth, RamanaSUNWgnome-a11y-libs.PAGES: $(SUNWgnome-a11y-libs_PAGES)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhSUNWgnome-a11y-mousetweaks.PAGES: $(SUNWgnome-a11y-mousetweaks_PAGES)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhSUNWgnome-a11y-reader.PAGES: $(SUNWgnome-a11y-reader_PAGES)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhSUNWgnome-a11y-speech.PAGES: $(SUNWgnome-a11y-speech_PAGES)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhSUNWgnome-archive-mgr.PAGES: $(SUNWgnome-archive-mgr_PAGES)
c3bc407cfbd238a18e4728ad5f36f39cecdb062fdhSUNWgnome-base-libs-java.PAGES: $(SUNWgnome-base-libs-java_PAGES)
c3bc407cfbd238a18e4728ad5f36f39cecdb062fdhSUNWgnome-character-map.PAGES: $(SUNWgnome-character-map_PAGES)
c3bc407cfbd238a18e4728ad5f36f39cecdb062fdhSUNWgnome-common-devel.PAGES: $(SUNWgnome-common-devel_PAGES)
14d6cf0a831fafb130183d4a32c30acbe84b9f4bdhSUNWgnome-config-editor.PAGES: $(SUNWgnome-config-editor_PAGES)
14d6cf0a831fafb130183d4a32c30acbe84b9f4bdhSUNWgnome-crash-report.PAGES: $(SUNWgnome-crash-report_PAGES)
14d6cf0a831fafb130183d4a32c30acbe84b9f4bdhSUNWgnome-desktop-prefs.PAGES: $(SUNWgnome-desktop-prefs_PAGES)
1f81b46471e38fdeb9ab74c25510b2f903f8af12David HollisterSUNWgnome-dialog.PAGES: $(SUNWgnome-dialog_PAGES)
1f81b46471e38fdeb9ab74c25510b2f903f8af12David HollisterSUNWgnome-display-mgr.PAGES: $(SUNWgnome-display-mgr_PAGES)
1f81b46471e38fdeb9ab74c25510b2f903f8af12David HollisterSUNWgnome-file-mgr.PAGES: $(SUNWgnome-file-mgr_PAGES)
1f81b46471e38fdeb9ab74c25510b2f903f8af12David HollisterSUNWgnome-gtksourceview.PAGES: $(SUNWgnome-gtksourceview_PAGES)
1f81b46471e38fdeb9ab74c25510b2f903f8af12David HollisterSUNWgnome-gvfs.PAGES: $(SUNWgnome-gvfs_PAGES)
1f81b46471e38fdeb9ab74c25510b2f903f8af12David HollisterSUNWgnome-help-viewer.PAGES: $(SUNWgnome-help-viewer_PAGES)
1f81b46471e38fdeb9ab74c25510b2f903f8af12David HollisterSUNWgnome-hex-editor.PAGES: $(SUNWgnome-hex-editor_PAGES)
1f81b46471e38fdeb9ab74c25510b2f903f8af12David HollisterSUNWgnome-im-client.PAGES: $(SUNWgnome-im-client_PAGES)
1f81b46471e38fdeb9ab74c25510b2f903f8af12David HollisterSUNWgnome-meeting.PAGES: $(SUNWgnome-meeting_PAGES)
1f81b46471e38fdeb9ab74c25510b2f903f8af12David HollisterSUNWgnome-img-viewer.PAGES: $(SUNWgnome-img-viewer_PAGES)
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollister man1/scrollkeeper-get-extended-content-list.1 \
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollister man1/scrollkeeper-get-index-from-docpath.1 \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhSUNWgnome-media-player.PAGES: $(SUNWgnome-media-player_PAGES)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhSUNWgnome-menu-editor.PAGES: $(SUNWgnome-menu-editor_PAGES)
2ac4abe882db38ef90020f7c5ca28586e3d57258David HollisterSUNWgnome-panel.PAGES: $(SUNWgnome-panel_PAGES)
2ac4abe882db38ef90020f7c5ca28586e3d57258David HollisterSUNWgnome-pdf-viewer.PAGES: $(SUNWgnome-pdf-viewer_PAGES)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhSUNWgnome-removable-media.PAGES: $(SUNWgnome-removable-media_PAGES)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhSUNWgnome-remote-desktop.PAGES: $(SUNWgnome-remote-desktop_PAGES)
b18a19c275d2531444fcd2f66664cbe3c6897f6aJesse ButlerSUNWgnome-system-tools.PAGES: $(SUNWgnome-system-tools_PAGES)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhSUNWgnome-system-monitor.PAGES: $(SUNWgnome-system-monitor_PAGES)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhSUNWgnome-text-editor.PAGES: $(SUNWgnome-text-editor_PAGES)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhSUNWgnome-ui-designer.PAGES: $(SUNWgnome-ui-designer_PAGES)
14d6cf0a831fafb130183d4a32c30acbe84b9f4bdhSUNWgnome-power-manager.PAGES: $(SUNWgnome-power-manager_PAGES)
14d6cf0a831fafb130183d4a32c30acbe84b9f4bdhSUNWxdg-user-dirs-gtk.PAGES: $(SUNWxdg-user-dirs-gtk_PAGES)
658280b6253b61dbb155f43d0e3cbcffa85ccb90David HollisterSUNWlibcanberra.PAGES: $(SUNWlibcanberra_PAGES)
658280b6253b61dbb155f43d0e3cbcffa85ccb90David HollisterSUNWlibgpg-error.PAGES: $(SUNWlibgpg-error_PAGES)
658280b6253b61dbb155f43d0e3cbcffa85ccb90David HollisterSUNWgnome-camera.PAGES: $(SUNWgnome-camera_PAGES)
658280b6253b61dbb155f43d0e3cbcffa85ccb90David HollisterSUNWgnome-nettool.PAGES: $(SUNWgnome-nettool_PAGES)
658280b6253b61dbb155f43d0e3cbcffa85ccb90David HollisterSUNWnwam-manager.PAGES: $(SUNWnwam-manager_PAGES)
658280b6253b61dbb155f43d0e3cbcffa85ccb90David HollisterSUNWdesktop-search.PAGES: $(SUNWdesktop-search_PAGES)
14d6cf0a831fafb130183d4a32c30acbe84b9f4bdhTARBALLS = $(TARBALL_DIR)/$(addsuffix -$(MANPAGE_VERSION).tar.bz2, $(PACKAGES))
14d6cf0a831fafb130183d4a32c30acbe84b9f4bdh @test -x $(SGML2ROFF) || echo "sgml2roff utility not found"
14d6cf0a831fafb130183d4a32c30acbe84b9f4bdh $(MAKE) MAKE=\"$(MAKE)\" $$package-manpages-$(MANPAGE_VERSION).tar.gz; \
14d6cf0a831fafb130183d4a32c30acbe84b9f4bdh @if test -f $(TARBALL_DIR)/$@; then \
14d6cf0a831fafb130183d4a32c30acbe84b9f4bdh @echo "Converting manpages for $@"
14d6cf0a831fafb130183d4a32c30acbe84b9f4bdh $(SGML2ROFF) $$manpage > $(MANPAGE_DIR)/$$base_manpage; \
14d6cf0a831fafb130183d4a32c30acbe84b9f4bdh idx1 = index($$0, "ARC "); \
14d6cf0a831fafb130183d4a32c30acbe84b9f4bdh idx2 = index($$0, "-->"); \
14d6cf0a831fafb130183d4a32c30acbe84b9f4bdh if (idx1 > 0 && idx2 > 0) { \
14d6cf0a831fafb130183d4a32c30acbe84b9f4bdh print "...\\\" " substr($$0, idx1+6, idx2-(idx1+6)); \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh echo "MAN"$$mantype"PAGES = \\" >> $(MANPAGE_DIR)/Makefile; \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh if (length(saved_page) > 0) \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh print " " saved_page " \\"; \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh saved_page=$$0; \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh print " " saved_page; \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh }' $(MANPAGE_DIR)/$$mantype >> $(MANPAGE_DIR)/Makefile; \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh echo " install -d \$$(DESTDIR)\$$(MAN"$$mantype"DIR)" >> $(MANPAGE_DIR)/Makefile; \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh echo " for mp in \$$(MAN"$$mantype"PAGES); do \\" >> $(MANPAGE_DIR)/Makefile; \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh echo " install --mode=0644 \$$\$$mp \$$(DESTDIR)\$$(MAN"$$mantype"DIR); \\" >> $(MANPAGE_DIR)/Makefile; \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh @tarball=`basename "$@" .gz`; echo "Making tarball $$tarball"; \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh @test -d check-used-manpages || mkdir -p "check-used-manpages"
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh @test -d check-all-manpages || mkdir -p "check-all-manpages"
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh @if test -f unused-manpages.txt; then \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh echo "Following Manpages are not being used in any SUNW package :"; \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh echo "All man pages are being used"; \