docs: convert virt-sanlock-cleanup man page from pod to rst

This was a semi-automated conversion. First it was run through pod2rst,
and then it was manually editted to use a rst structure that matches
expectations of rst2man.

Reviewed-by: Cole Robinson <crobinso@redhat.com>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>

diff --git a/docs/Makefile.am b/docs/Makefile.am
index 378855ab7135730065e05450825c9a4b7943b50c..b7bf7151fc66313219be7065ca052113f6f3e629 100644 (file)
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -207,6 +207,7 @@ manpages1_rst = \
 manpages7_rst = \
   $(NULL)
 manpages8_rst = \
+  manpages/virt-sanlock-cleanup.rst \
   $(NULL)
 manpages_rst += \
   $(manpages1_rst) \

diff --git a/docs/manpages/index.rst b/docs/manpages/index.rst
index 5042071c7daf95f530e87069d92cc3a16e236b59..85a9100ce86823a096db3cdeb8f4e252c7c15a19 100644 (file)
--- a/docs/manpages/index.rst
+++ b/docs/manpages/index.rst
@@ -15,3 +15,4 @@ Tools
 * `virt-host-validate(1) <virt-host-validate.html>`__ - validate host virtualization setup
 * `virt-pki-validate(1) <virt-pki-validate.html>`__ - validate libvirt PKI files are configured correctly
 * `virt-xml-validate(1) <virt-xml-validate.html>`__ - validate libvirt XML files against a schema
+* `virt-sanlock-cleanup(8) <virt-sanlock-cleanup.html>`__ - remove stale sanlock resource lease files

diff --git a/docs/manpages/virt-sanlock-cleanup.rst b/docs/manpages/virt-sanlock-cleanup.rst
new file mode 100644 (file)
index 0000000..ac49fa4
--- /dev/null
+++ b/docs/manpages/virt-sanlock-cleanup.rst
@@ -0,0 +1,79 @@
+====================
+virt-sanlock-cleanup
+====================
+
+-----------------------------------------
+remove stale sanlock resource lease files
+-----------------------------------------
+
+:Manual section: 1
+:Manual group: Virtualization Support
+
+.. contents::
+
+SYNOPSIS
+========
+
+``virt-sanlock-cleanup``
+
+
+DESCRIPTION
+===========
+
+This tool removes any resource lease files created by the sanlock
+lock manager plugin. The resource lease files only need to exist
+on disks when a guest using the resource is active. This script
+reclaims the disk space used by resources which are not currently
+active.
+
+
+EXIT STATUS
+===========
+
+Upon successful processing of leases cleanup, an exit status
+of 0 will be set. Upon fatal error a non-zero status will
+be set.
+
+
+AUTHOR
+======
+
+Daniel P. Berrangé
+
+
+BUGS
+====
+
+Please report all bugs you discover.  This should be done via either:
+
+#. the mailing list
+
+   `https://libvirt.org/contact.html <https://libvirt.org/contact.html>`_
+
+#. the bug tracker
+
+   `https://libvirt.org/bugs.html <https://libvirt.org/bugs.html>`_
+
+Alternatively, you may report bugs to your software distributor / vendor.
+
+
+COPYRIGHT
+=========
+
+Copyright (C) 2011, 2013 Red Hat, Inc.
+
+
+LICENSE
+=======
+
+``virt-sanlock-cleanup`` is distributed under the terms of the GNU GPL v2+.
+This is free software; see the source for copying conditions. There
+is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
+PURPOSE
+
+
+SEE ALSO
+========
+
+virsh(1), `online instructions <https://libvirt.org/locking.html>`_,
+`https://libvirt.org/ <https://libvirt.org/>`_

diff --git a/tools/Makefile.am b/tools/Makefile.am
index 52b5fdaba1b24e020be473126693b050bd76135f..f9c344ec83c84e4e8fdcafdfef175a4c8d6d29bd 100644 (file)
--- a/tools/Makefile.am
+++ b/tools/Makefile.am
@@ -55,14 +55,12 @@ ICON_FILES = \
 PODFILES = \
        virt-admin.pod \
        virt-login-shell.pod \
-       virt-sanlock-cleanup.pod \
        virsh.pod \
        $(NULL)
 
 MANINFILES = \
        virt-admin.1.in \
        virt-login-shell.1.in \
-       virt-sanlock-cleanup.8.in \
        virsh.1.in \
        $(NULL)
 
@@ -97,7 +95,6 @@ man1_MANS = \
 
 if WITH_SANLOCK
 sbin_SCRIPTS = virt-sanlock-cleanup
-man8_MANS = virt-sanlock-cleanup.8
 DISTCLEANFILES += virt-sanlock-cleanup
 endif WITH_SANLOCK
 

diff --git a/tools/virt-sanlock-cleanup.pod b/tools/virt-sanlock-cleanup.pod
deleted file mode 100644 (file)
index 4101256..0000000
--- a/tools/virt-sanlock-cleanup.pod
+++ /dev/null
@@ -1,49 +0,0 @@
-=head1 NAME
-
-virt-sanlock-cleanup - remove stale sanlock resource lease files
-
-=head1 SYNOPSIS
-
-B<virt-sanlock-cleanup>
-
-=head1 DESCRIPTION
-
-This tool removes any resource lease files created by the sanlock
-lock manager plugin. The resource lease files only need to exist
-on disks when a guest using the resource is active. This script
-reclaims the disk space used by resources which are not currently
-active.
-
-=head1 EXIT STATUS
-
-Upon successful processing of leases cleanup, an exit status
-of 0 will be set. Upon fatal error a non-zero status will
-be set.
-
-=head1 AUTHOR
-
-Daniel Berrange
-
-=head1 BUGS
-
-Report any bugs discovered to the libvirt community via the
-mailing list L<https://libvirt.org/contact.html> or bug tracker
-L<https://libvirt.org/bugs.html>.
-Alternatively report bugs to your software distributor / vendor.
-
-=head1 COPYRIGHT
-
-Copyright (C) 2011, 2013 Red Hat, Inc.
-
-=head1 LICENSE
-
-virt-sanlock-cleanup is distributed under the terms of the GNU GPL v2+.
-This is free software; see the source for copying conditions. There
-is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
-PURPOSE
-
-=head1 SEE ALSO
-
-L<virsh(1)>, online instructions L<https://libvirt.org/locking.html>
-
-=cut