mirrors/libguestfs
1
0
Fork 0
mirror of https://github.com/libguestfs/libguestfs.git synced 2026-03-21 22:53:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Move miscellaneous documentation from examples/ to docs/.

Browse Source 
Wasn't very logical putting these doc files in the examples directory.
This commit is contained in:
Richard W.M. Jones
2015-10-21 11:12:23 +01:00
parent eb36df827b
commit 6219e61cba
12 changed files with 118 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
.gitignore vendored
View File

@@ -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

2
Makefile.am
View File

@@ -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

1
configure.ac
View File

@@ -1743,6 +1743,7 @@ AC_CONFIG_FILES([Makefile
df/Makefile
dib/Makefile
diff/Makefile
docs/Makefile
edit/Makefile
erlang/Makefile
erlang/examples/Makefile

86
docs/Makefile.am Normal file
View File

@@ -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 $@

11
docs/README Normal file
View File

@@ -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

0
examples/guestfs-faq.pod → docs/guestfs-faq.pod
View File

0
examples/guestfs-performance.pod → docs/guestfs-performance.pod
View File

0
examples/guestfs-recipes.pod → docs/guestfs-recipes.pod
View File

0
examples/guestfs-testing.pod → docs/guestfs-testing.pod
View File

68
examples/Makefile.am
View File

@@ -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 $@

8
po-docs/podfiles
View File

@@ -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

4
src/guestfs.pod
View File

@@ -4458,6 +4458,10 @@ L<virt-dib(1)> command and documentation.
L<virt-diff(1)> command and documentation.
=item F<doc>
Miscellaneous manual pages.
=item F<edit>
L<virt-edit(1)> command and documentation.