From 6219e61cbac8f35138c213c4ad744646e97f2c82 Mon Sep 17 00:00:00 2001 From: "Richard W.M. Jones" Date: Wed, 21 Oct 2015 11:12:23 +0100 Subject: [PATCH] Move miscellaneous documentation from examples/ to docs/. Wasn't very logical putting these doc files in the examples directory. --- .gitignore | 16 ++-- Makefile.am | 2 +- configure.ac | 1 + docs/Makefile.am | 86 ++++++++++++++++++++++ docs/README | 11 +++ {examples => docs}/guestfs-faq.pod | 0 {examples => docs}/guestfs-performance.pod | 0 {examples => docs}/guestfs-recipes.pod | 0 {examples => docs}/guestfs-testing.pod | 0 examples/Makefile.am | 68 +---------------- po-docs/podfiles | 8 +- src/guestfs.pod | 4 + 12 files changed, 118 insertions(+), 78 deletions(-) create mode 100644 docs/Makefile.am create mode 100644 docs/README rename {examples => docs}/guestfs-faq.pod (100%) rename {examples => docs}/guestfs-performance.pod (100%) rename {examples => docs}/guestfs-recipes.pod (100%) rename {examples => docs}/guestfs-testing.pod (100%) diff --git a/.gitignore b/.gitignore index 2f571a392..d79b88943 100644 --- a/.gitignore +++ b/.gitignore @@ -130,6 +130,14 @@ Makefile.in /diff/stamp-virt-diff.pod /diff/virt-diff /diff/virt-diff.1 +/docs/guestfs-faq.1 +/docs/guestfs-performance.1 +/docs/guestfs-recipes.1 +/docs/guestfs-testing.1 +/docs/stamp-guestfs-faq.pod +/docs/stamp-guestfs-performance.pod +/docs/stamp-guestfs-recipes.pod +/docs/stamp-guestfs-testing.pod /edit/stamp-virt-*.pod /edit/virt-edit /edit/virt-edit.1 @@ -146,18 +154,10 @@ Makefile.in /examples/debug-logging /examples/display-icon /examples/guestfs-examples.3 -/examples/guestfs-faq.1 -/examples/guestfs-performance.1 -/examples/guestfs-recipes.1 -/examples/guestfs-testing.1 /examples/inspect-vm /examples/libvirt-auth /examples/mount-local /examples/stamp-guestfs-examples.pod -/examples/stamp-guestfs-faq.pod -/examples/stamp-guestfs-performance.pod -/examples/stamp-guestfs-recipes.pod -/examples/stamp-guestfs-testing.pod /examples/virt-dhcp-address /fish/cmds.c /fish/cmds-gperf.c diff --git a/Makefile.am b/Makefile.am index 1b3f63150..4ac7618f0 100644 --- a/Makefile.am +++ b/Makefile.am @@ -26,7 +26,7 @@ SUBDIRS += gnulib/tests endif # Basic source for the library. -SUBDIRS += tests/data generator src examples po +SUBDIRS += tests/data generator src docs examples po if ENABLE_DAEMON SUBDIRS += daemon diff --git a/configure.ac b/configure.ac index 6220365cb..4f6650e7d 100644 --- a/configure.ac +++ b/configure.ac @@ -1743,6 +1743,7 @@ AC_CONFIG_FILES([Makefile df/Makefile dib/Makefile diff/Makefile + docs/Makefile edit/Makefile erlang/Makefile erlang/examples/Makefile diff --git a/docs/Makefile.am b/docs/Makefile.am new file mode 100644 index 000000000..e82619828 --- /dev/null +++ b/docs/Makefile.am @@ -0,0 +1,86 @@ +# libguestfs documentation +# Copyright (C) 2010-2015 Red Hat Inc. +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# This program 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 General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +include $(top_srcdir)/subdir-rules.mk + +EXTRA_DIST = \ + guestfs-faq.pod \ + guestfs-performance.pod \ + guestfs-recipes.pod \ + guestfs-testing.pod \ + README + +CLEANFILES = \ + stamp-guestfs-faq.pod \ + stamp-guestfs-performance.pod \ + stamp-guestfs-recipes.pod \ + stamp-guestfs-testing.pod + +man_MANS = \ + guestfs-faq.1 \ + guestfs-performance.1 \ + guestfs-recipes.1 \ + guestfs-testing.1 +noinst_DATA = \ + $(top_builddir)/html/guestfs-faq.1.html \ + $(top_builddir)/html/guestfs-performance.1.html \ + $(top_builddir)/html/guestfs-recipes.1.html \ + $(top_builddir)/html/guestfs-testing.1.html + +guestfs-faq.1 $(top_builddir)/html/guestfs-faq.1.html: stamp-guestfs-faq.pod + +stamp-guestfs-faq.pod: guestfs-faq.pod + $(PODWRAPPER) \ + --section 1 \ + --man guestfs-faq.1 \ + --html $(top_builddir)/html/guestfs-faq.1.html \ + --license LGPLv2+ \ + $< + touch $@ + +guestfs-performance.1 $(top_builddir)/html/guestfs-performance.1.html: stamp-guestfs-performance.pod + +stamp-guestfs-performance.pod: guestfs-performance.pod + $(PODWRAPPER) \ + --section 1 \ + --man guestfs-performance.1 \ + --html $(top_builddir)/html/guestfs-performance.1.html \ + --license LGPLv2+ \ + $< + touch $@ + +guestfs-recipes.1 $(top_builddir)/html/guestfs-recipes.1.html: stamp-guestfs-recipes.pod + +stamp-guestfs-recipes.pod: guestfs-recipes.pod + $(PODWRAPPER) \ + --section 1 \ + --man guestfs-recipes.1 \ + --html $(top_builddir)/html/guestfs-recipes.1.html \ + --license examples \ + $< + touch $@ + +guestfs-testing.1 $(top_builddir)/html/guestfs-testing.1.html: stamp-guestfs-testing.pod + +stamp-guestfs-testing.pod: guestfs-testing.pod + $(PODWRAPPER) \ + --section 1 \ + --man guestfs-testing.1 \ + --html $(top_builddir)/html/guestfs-testing.1.html \ + --license LGPLv2+ \ + $< + touch $@ diff --git a/docs/README b/docs/README new file mode 100644 index 000000000..d149a8cae --- /dev/null +++ b/docs/README @@ -0,0 +1,11 @@ +This directory contains miscellaneous manual pages which don't fit +elsewhere. + +Most libguestfs documentation is in manual pages. The source for +those manual pages are POD files (*.pod), and they are normally +located next to the source files they relate to (eg. guestfish +documentation is in fish/guestfish.pod). + +All manual pages are available online at http://libguestfs.org/ + +The main API documentation is: http://libguestfs.org/guestfs.3.html \ No newline at end of file diff --git a/examples/guestfs-faq.pod b/docs/guestfs-faq.pod similarity index 100% rename from examples/guestfs-faq.pod rename to docs/guestfs-faq.pod diff --git a/examples/guestfs-performance.pod b/docs/guestfs-performance.pod similarity index 100% rename from examples/guestfs-performance.pod rename to docs/guestfs-performance.pod diff --git a/examples/guestfs-recipes.pod b/docs/guestfs-recipes.pod similarity index 100% rename from examples/guestfs-recipes.pod rename to docs/guestfs-recipes.pod diff --git a/examples/guestfs-testing.pod b/docs/guestfs-testing.pod similarity index 100% rename from examples/guestfs-testing.pod rename to docs/guestfs-testing.pod diff --git a/examples/Makefile.am b/examples/Makefile.am index 8b0abda58..06f5235cf 100644 --- a/examples/Makefile.am +++ b/examples/Makefile.am @@ -20,10 +20,6 @@ include $(top_srcdir)/subdir-rules.mk EXTRA_DIST = \ LICENSE \ guestfs-examples.pod \ - guestfs-faq.pod \ - guestfs-performance.pod \ - guestfs-recipes.pod \ - guestfs-testing.pod \ copy-over.c \ create-disk.c \ debug-logging.c \ @@ -34,11 +30,7 @@ EXTRA_DIST = \ virt-dhcp-address.c CLEANFILES = \ - stamp-guestfs-examples.pod \ - stamp-guestfs-faq.pod \ - stamp-guestfs-performance.pod \ - stamp-guestfs-recipes.pod \ - stamp-guestfs-testing.pod + stamp-guestfs-examples.pod noinst_PROGRAMS = create-disk debug-logging display-icon inspect-vm if HAVE_LIBVIRT @@ -139,18 +131,8 @@ virt_dhcp_address_LDADD = \ $(top_builddir)/src/libguestfs.la endif -man_MANS = \ - guestfs-examples.3 \ - guestfs-faq.1 \ - guestfs-performance.1 \ - guestfs-recipes.1 \ - guestfs-testing.1 -noinst_DATA = \ - $(top_builddir)/html/guestfs-examples.3.html \ - $(top_builddir)/html/guestfs-faq.1.html \ - $(top_builddir)/html/guestfs-performance.1.html \ - $(top_builddir)/html/guestfs-recipes.1.html \ - $(top_builddir)/html/guestfs-testing.1.html +man_MANS = guestfs-examples.3 +noinst_DATA = $(top_builddir)/html/guestfs-examples.3.html guestfs-examples.3 $(top_builddir)/html/guestfs-examples.3.html: stamp-guestfs-examples.pod @@ -170,47 +152,3 @@ stamp-guestfs-examples.pod: guestfs-examples.pod copy-over.c create-disk.c debug --license examples \ $< touch $@ - -guestfs-faq.1 $(top_builddir)/html/guestfs-faq.1.html: stamp-guestfs-faq.pod - -stamp-guestfs-faq.pod: guestfs-faq.pod - $(PODWRAPPER) \ - --section 1 \ - --man guestfs-faq.1 \ - --html $(top_builddir)/html/guestfs-faq.1.html \ - --license LGPLv2+ \ - $< - touch $@ - -guestfs-performance.1 $(top_builddir)/html/guestfs-performance.1.html: stamp-guestfs-performance.pod - -stamp-guestfs-performance.pod: guestfs-performance.pod - $(PODWRAPPER) \ - --section 1 \ - --man guestfs-performance.1 \ - --html $(top_builddir)/html/guestfs-performance.1.html \ - --license LGPLv2+ \ - $< - touch $@ - -guestfs-recipes.1 $(top_builddir)/html/guestfs-recipes.1.html: stamp-guestfs-recipes.pod - -stamp-guestfs-recipes.pod: guestfs-recipes.pod - $(PODWRAPPER) \ - --section 1 \ - --man guestfs-recipes.1 \ - --html $(top_builddir)/html/guestfs-recipes.1.html \ - --license examples \ - $< - touch $@ - -guestfs-testing.1 $(top_builddir)/html/guestfs-testing.1.html: stamp-guestfs-testing.pod - -stamp-guestfs-testing.pod: guestfs-testing.pod - $(PODWRAPPER) \ - --section 1 \ - --man guestfs-testing.1 \ - --html $(top_builddir)/html/guestfs-testing.1.html \ - --license LGPLv2+ \ - $< - touch $@ diff --git a/po-docs/podfiles b/po-docs/podfiles index 21f1cf1d9..e79b89719 100644 --- a/po-docs/podfiles +++ b/po-docs/podfiles @@ -13,13 +13,13 @@ ../df/virt-df.pod ../dib/virt-dib.pod ../diff/virt-diff.pod +../docs/guestfs-faq.pod +../docs/guestfs-performance.pod +../docs/guestfs-recipes.pod +../docs/guestfs-testing.pod ../edit/virt-edit.pod ../erlang/examples/guestfs-erlang.pod ../examples/guestfs-examples.pod -../examples/guestfs-faq.pod -../examples/guestfs-performance.pod -../examples/guestfs-recipes.pod -../examples/guestfs-testing.pod ../fish/guestfish-actions.pod ../fish/guestfish-commands.pod ../fish/guestfish-prepopts.pod diff --git a/src/guestfs.pod b/src/guestfs.pod index 349aa8d02..f8d7e2cdd 100644 --- a/src/guestfs.pod +++ b/src/guestfs.pod @@ -4458,6 +4458,10 @@ L command and documentation. L command and documentation. +=item F + +Miscellaneous manual pages. + =item F L command and documentation.