From 313b4720e8b76abf8b7840e79a7a8a0662a82edb Mon Sep 17 00:00:00 2001 From: Colin Walters Date: Wed, 27 Jan 2016 12:51:07 -0500 Subject: [PATCH] build: Move man pages into man/ This is preparation for having 3 separate doc build systems (whee): - xsltproc for the man pages - gtk-doc for the API docs - mkdocs for a real manual --- Makefile-man.am | 54 +++++++++++++++++++++++ Makefile.am | 1 + configure.ac | 1 + doc/Makefile.am | 36 --------------- {doc => man}/ostree-admin-cleanup.xml | 0 {doc => man}/ostree-admin-config-diff.xml | 0 {doc => man}/ostree-admin-deploy.xml | 0 {doc => man}/ostree-admin-init-fs.xml | 0 {doc => man}/ostree-admin-instutil.xml | 0 {doc => man}/ostree-admin-os-init.xml | 0 {doc => man}/ostree-admin-set-origin.xml | 0 {doc => man}/ostree-admin-status.xml | 0 {doc => man}/ostree-admin-switch.xml | 0 {doc => man}/ostree-admin-undeploy.xml | 0 {doc => man}/ostree-admin-upgrade.xml | 0 {doc => man}/ostree-admin.xml | 0 {doc => man}/ostree-cat.xml | 0 {doc => man}/ostree-checkout.xml | 0 {doc => man}/ostree-checksum.xml | 0 {doc => man}/ostree-commit.xml | 0 {doc => man}/ostree-config.xml | 0 {doc => man}/ostree-diff.xml | 0 {doc => man}/ostree-fsck.xml | 0 {doc => man}/ostree-gpg-sign.xml | 0 {doc => man}/ostree-init.xml | 0 {doc => man}/ostree-log.xml | 0 {doc => man}/ostree-ls.xml | 0 {doc => man}/ostree-prune.xml | 0 {doc => man}/ostree-pull-local.xml | 0 {doc => man}/ostree-pull.xml | 0 {doc => man}/ostree-refs.xml | 0 {doc => man}/ostree-remote.xml | 0 {doc => man}/ostree-reset.xml | 0 {doc => man}/ostree-rev-parse.xml | 0 {doc => man}/ostree-show.xml | 0 {doc => man}/ostree-static-delta.xml | 0 {doc => man}/ostree-summary.xml | 0 {doc => man}/ostree-trivial-httpd.xml | 0 {doc => man}/ostree.repo-config.xml | 0 {doc => man}/ostree.repo.xml | 0 {doc => man}/ostree.xml | 0 41 files changed, 56 insertions(+), 36 deletions(-) create mode 100644 Makefile-man.am rename {doc => man}/ostree-admin-cleanup.xml (100%) rename {doc => man}/ostree-admin-config-diff.xml (100%) rename {doc => man}/ostree-admin-deploy.xml (100%) rename {doc => man}/ostree-admin-init-fs.xml (100%) rename {doc => man}/ostree-admin-instutil.xml (100%) rename {doc => man}/ostree-admin-os-init.xml (100%) rename {doc => man}/ostree-admin-set-origin.xml (100%) rename {doc => man}/ostree-admin-status.xml (100%) rename {doc => man}/ostree-admin-switch.xml (100%) rename {doc => man}/ostree-admin-undeploy.xml (100%) rename {doc => man}/ostree-admin-upgrade.xml (100%) rename {doc => man}/ostree-admin.xml (100%) rename {doc => man}/ostree-cat.xml (100%) rename {doc => man}/ostree-checkout.xml (100%) rename {doc => man}/ostree-checksum.xml (100%) rename {doc => man}/ostree-commit.xml (100%) rename {doc => man}/ostree-config.xml (100%) rename {doc => man}/ostree-diff.xml (100%) rename {doc => man}/ostree-fsck.xml (100%) rename {doc => man}/ostree-gpg-sign.xml (100%) rename {doc => man}/ostree-init.xml (100%) rename {doc => man}/ostree-log.xml (100%) rename {doc => man}/ostree-ls.xml (100%) rename {doc => man}/ostree-prune.xml (100%) rename {doc => man}/ostree-pull-local.xml (100%) rename {doc => man}/ostree-pull.xml (100%) rename {doc => man}/ostree-refs.xml (100%) rename {doc => man}/ostree-remote.xml (100%) rename {doc => man}/ostree-reset.xml (100%) rename {doc => man}/ostree-rev-parse.xml (100%) rename {doc => man}/ostree-show.xml (100%) rename {doc => man}/ostree-static-delta.xml (100%) rename {doc => man}/ostree-summary.xml (100%) rename {doc => man}/ostree-trivial-httpd.xml (100%) rename {doc => man}/ostree.repo-config.xml (100%) rename {doc => man}/ostree.repo.xml (100%) rename {doc => man}/ostree.xml (100%) diff --git a/Makefile-man.am b/Makefile-man.am new file mode 100644 index 00000000..d2f31ca0 --- /dev/null +++ b/Makefile-man.am @@ -0,0 +1,54 @@ +# Makefile for man/ +# +# Copyright (C) 2016 Colin Walters +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the +# Free Software Foundation, Inc., 59 Temple Place - Suite 330, +# Boston, MA 02111-1307, USA. + +man1_files = ostree.1 ostree-admin-cleanup.1 ostree-admin-config-diff.1 ostree-admin-deploy.1 ostree-admin-init-fs.1 ostree-admin-instutil.1 ostree-admin-os-init.1 ostree-admin-status.1 ostree-admin-set-origin.1 ostree-admin-switch.1 ostree-admin-undeploy.1 ostree-admin-upgrade.1 ostree-admin.1 ostree-cat.1 ostree-checkout.1 ostree-checksum.1 ostree-commit.1 ostree-gpg-sign.1 ostree-config.1 ostree-diff.1 ostree-fsck.1 ostree-init.1 ostree-log.1 ostree-ls.1 ostree-prune.1 ostree-pull-local.1 ostree-pull.1 ostree-refs.1 ostree-remote.1 ostree-reset.1 ostree-rev-parse.1 ostree-show.1 ostree-summary.1 ostree-static-delta.1 ostree-trivial-httpd.1 + +man5_files = ostree.repo.5 ostree.repo-config.5 + +man1_MANS = $(addprefix man/,$(man1_files)) +man5_MANS = $(addprefix man/,$(man5_files)) + +EXTRA_DIST += $(man1_MANS) $(man5_MANS) + +if ENABLE_XSLTPROC + +XSLT_STYLESHEET = http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl + +XSLTPROC_FLAGS = \ + --nonet \ + --stringparam man.output.quietly 1 \ + --stringparam funcsynopsis.style ansi \ + --stringparam man.th.extra1.suppress 1 \ + --stringparam man.authors.section.enabled 0 \ + --stringparam man.copyright.section.enabled 0 + +XSLTPROC_MAN = $(XSLTPROC) $(XSLTPROC_FLAGS) + +%.1: %.xml + $(AM_V_GEN) $(XSLTPROC_MAN) --output $@ $(XSLT_STYLESHEET) $< + +%.5: %.xml + $(AM_V_GEN) $(XSLTPROC_MAN) --output $@ $(XSLT_STYLESHEET) $< + +CLEANFILES += \ + $(man1_MANS) \ + $(man5_MANS) \ + $(NULL) + +endif # ENABLE_GTK_DOC diff --git a/Makefile.am b/Makefile.am index cc44166a..172af0b2 100644 --- a/Makefile.am +++ b/Makefile.am @@ -70,6 +70,7 @@ include Makefile-ostree.am include Makefile-switchroot.am include Makefile-tests.am include Makefile-boot.am +include Makefile-man.am release-tag: git tag -m "Release $(VERSION)" v$(VERSION) diff --git a/configure.ac b/configure.ac index b5bc1e56..46b77fbf 100644 --- a/configure.ac +++ b/configure.ac @@ -127,6 +127,7 @@ AM_CONDITIONAL([ENABLE_GTK_DOC], false) ]) AC_PATH_PROG([XSLTPROC], [xsltproc]) +AM_CONDITIONAL([ENABLE_XSLTPROC], test -n "${XSLTPROC}") AC_ARG_WITH(libarchive, AS_HELP_STRING([--without-libarchive], [Do not use libarchive]), diff --git a/doc/Makefile.am b/doc/Makefile.am index 9406f3ef..c40057e0 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -126,43 +126,7 @@ version.xml: # This includes the standard gtk-doc make rules, copied by gtkdocize. include $(top_srcdir)/gtk-doc.make -man1_MANS = ostree.1 ostree-admin-cleanup.1 ostree-admin-config-diff.1 ostree-admin-deploy.1 ostree-admin-init-fs.1 ostree-admin-instutil.1 ostree-admin-os-init.1 ostree-admin-status.1 ostree-admin-set-origin.1 ostree-admin-switch.1 ostree-admin-undeploy.1 ostree-admin-upgrade.1 ostree-admin.1 ostree-cat.1 ostree-checkout.1 ostree-checksum.1 ostree-commit.1 ostree-gpg-sign.1 ostree-config.1 ostree-diff.1 ostree-fsck.1 ostree-init.1 ostree-log.1 ostree-ls.1 ostree-prune.1 ostree-pull-local.1 ostree-pull.1 ostree-refs.1 ostree-remote.1 ostree-reset.1 ostree-rev-parse.1 ostree-show.1 ostree-summary.1 ostree-static-delta.1 ostree-trivial-httpd.1 - -man5_MANS = ostree.repo.5 ostree.repo-config.5 - -if ENABLE_GTK_DOC - -XSLTPROC_FLAGS = \ - --nonet \ - --stringparam man.output.quietly 1 \ - --stringparam funcsynopsis.style ansi \ - --stringparam man.th.extra1.suppress 1 \ - --stringparam man.authors.section.enabled 0 \ - --stringparam man.copyright.section.enabled 0 - -XSLTPROC_MAN = \ - $(XSLTPROC) $(XSLTPROC_FLAGS) http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl - -.xml.1: - $(AM_V_GEN) $(XSLTPROC_MAN) $< -.xml.5: - $(AM_V_GEN) $(XSLTPROC_MAN) $< - -CLEANFILES += \ - $(man1_MANS) \ - $(man5_MANS) \ - $(NULL) - -endif # ENABLE_GTK_DOC - -MAN_IN_FILES = \ - $(man1_MANS:.1=.xml) \ - $(man5_MANS:.5=.xml) \ - $(NULL) - EXTRA_DIST += \ - $(MAN_IN_FILES) \ version.xml \ - ostree.xml \ ostree-sections.txt \ $(NULL) diff --git a/doc/ostree-admin-cleanup.xml b/man/ostree-admin-cleanup.xml similarity index 100% rename from doc/ostree-admin-cleanup.xml rename to man/ostree-admin-cleanup.xml diff --git a/doc/ostree-admin-config-diff.xml b/man/ostree-admin-config-diff.xml similarity index 100% rename from doc/ostree-admin-config-diff.xml rename to man/ostree-admin-config-diff.xml diff --git a/doc/ostree-admin-deploy.xml b/man/ostree-admin-deploy.xml similarity index 100% rename from doc/ostree-admin-deploy.xml rename to man/ostree-admin-deploy.xml diff --git a/doc/ostree-admin-init-fs.xml b/man/ostree-admin-init-fs.xml similarity index 100% rename from doc/ostree-admin-init-fs.xml rename to man/ostree-admin-init-fs.xml diff --git a/doc/ostree-admin-instutil.xml b/man/ostree-admin-instutil.xml similarity index 100% rename from doc/ostree-admin-instutil.xml rename to man/ostree-admin-instutil.xml diff --git a/doc/ostree-admin-os-init.xml b/man/ostree-admin-os-init.xml similarity index 100% rename from doc/ostree-admin-os-init.xml rename to man/ostree-admin-os-init.xml diff --git a/doc/ostree-admin-set-origin.xml b/man/ostree-admin-set-origin.xml similarity index 100% rename from doc/ostree-admin-set-origin.xml rename to man/ostree-admin-set-origin.xml diff --git a/doc/ostree-admin-status.xml b/man/ostree-admin-status.xml similarity index 100% rename from doc/ostree-admin-status.xml rename to man/ostree-admin-status.xml diff --git a/doc/ostree-admin-switch.xml b/man/ostree-admin-switch.xml similarity index 100% rename from doc/ostree-admin-switch.xml rename to man/ostree-admin-switch.xml diff --git a/doc/ostree-admin-undeploy.xml b/man/ostree-admin-undeploy.xml similarity index 100% rename from doc/ostree-admin-undeploy.xml rename to man/ostree-admin-undeploy.xml diff --git a/doc/ostree-admin-upgrade.xml b/man/ostree-admin-upgrade.xml similarity index 100% rename from doc/ostree-admin-upgrade.xml rename to man/ostree-admin-upgrade.xml diff --git a/doc/ostree-admin.xml b/man/ostree-admin.xml similarity index 100% rename from doc/ostree-admin.xml rename to man/ostree-admin.xml diff --git a/doc/ostree-cat.xml b/man/ostree-cat.xml similarity index 100% rename from doc/ostree-cat.xml rename to man/ostree-cat.xml diff --git a/doc/ostree-checkout.xml b/man/ostree-checkout.xml similarity index 100% rename from doc/ostree-checkout.xml rename to man/ostree-checkout.xml diff --git a/doc/ostree-checksum.xml b/man/ostree-checksum.xml similarity index 100% rename from doc/ostree-checksum.xml rename to man/ostree-checksum.xml diff --git a/doc/ostree-commit.xml b/man/ostree-commit.xml similarity index 100% rename from doc/ostree-commit.xml rename to man/ostree-commit.xml diff --git a/doc/ostree-config.xml b/man/ostree-config.xml similarity index 100% rename from doc/ostree-config.xml rename to man/ostree-config.xml diff --git a/doc/ostree-diff.xml b/man/ostree-diff.xml similarity index 100% rename from doc/ostree-diff.xml rename to man/ostree-diff.xml diff --git a/doc/ostree-fsck.xml b/man/ostree-fsck.xml similarity index 100% rename from doc/ostree-fsck.xml rename to man/ostree-fsck.xml diff --git a/doc/ostree-gpg-sign.xml b/man/ostree-gpg-sign.xml similarity index 100% rename from doc/ostree-gpg-sign.xml rename to man/ostree-gpg-sign.xml diff --git a/doc/ostree-init.xml b/man/ostree-init.xml similarity index 100% rename from doc/ostree-init.xml rename to man/ostree-init.xml diff --git a/doc/ostree-log.xml b/man/ostree-log.xml similarity index 100% rename from doc/ostree-log.xml rename to man/ostree-log.xml diff --git a/doc/ostree-ls.xml b/man/ostree-ls.xml similarity index 100% rename from doc/ostree-ls.xml rename to man/ostree-ls.xml diff --git a/doc/ostree-prune.xml b/man/ostree-prune.xml similarity index 100% rename from doc/ostree-prune.xml rename to man/ostree-prune.xml diff --git a/doc/ostree-pull-local.xml b/man/ostree-pull-local.xml similarity index 100% rename from doc/ostree-pull-local.xml rename to man/ostree-pull-local.xml diff --git a/doc/ostree-pull.xml b/man/ostree-pull.xml similarity index 100% rename from doc/ostree-pull.xml rename to man/ostree-pull.xml diff --git a/doc/ostree-refs.xml b/man/ostree-refs.xml similarity index 100% rename from doc/ostree-refs.xml rename to man/ostree-refs.xml diff --git a/doc/ostree-remote.xml b/man/ostree-remote.xml similarity index 100% rename from doc/ostree-remote.xml rename to man/ostree-remote.xml diff --git a/doc/ostree-reset.xml b/man/ostree-reset.xml similarity index 100% rename from doc/ostree-reset.xml rename to man/ostree-reset.xml diff --git a/doc/ostree-rev-parse.xml b/man/ostree-rev-parse.xml similarity index 100% rename from doc/ostree-rev-parse.xml rename to man/ostree-rev-parse.xml diff --git a/doc/ostree-show.xml b/man/ostree-show.xml similarity index 100% rename from doc/ostree-show.xml rename to man/ostree-show.xml diff --git a/doc/ostree-static-delta.xml b/man/ostree-static-delta.xml similarity index 100% rename from doc/ostree-static-delta.xml rename to man/ostree-static-delta.xml diff --git a/doc/ostree-summary.xml b/man/ostree-summary.xml similarity index 100% rename from doc/ostree-summary.xml rename to man/ostree-summary.xml diff --git a/doc/ostree-trivial-httpd.xml b/man/ostree-trivial-httpd.xml similarity index 100% rename from doc/ostree-trivial-httpd.xml rename to man/ostree-trivial-httpd.xml diff --git a/doc/ostree.repo-config.xml b/man/ostree.repo-config.xml similarity index 100% rename from doc/ostree.repo-config.xml rename to man/ostree.repo-config.xml diff --git a/doc/ostree.repo.xml b/man/ostree.repo.xml similarity index 100% rename from doc/ostree.repo.xml rename to man/ostree.repo.xml diff --git a/doc/ostree.xml b/man/ostree.xml similarity index 100% rename from doc/ostree.xml rename to man/ostree.xml