[libvirt-dbus PATCH 7/9] man: Convert to reStructuredText

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



All the documentation for libvirt-dbus is now written in the
same language.

Signed-off-by: Andrea Bolognani <abologna@xxxxxxxxxx>
---
 docs/libvirt-dbus.pod | 66 ----------------------------------------
 docs/libvirt-dbus.rst | 71 +++++++++++++++++++++++++++++++++++++++++++
 docs/meson.build      |  6 ++--
 libvirt-dbus.spec.in  |  2 +-
 4 files changed, 75 insertions(+), 70 deletions(-)
 delete mode 100644 docs/libvirt-dbus.pod
 create mode 100644 docs/libvirt-dbus.rst

diff --git a/docs/libvirt-dbus.pod b/docs/libvirt-dbus.pod
deleted file mode 100644
index 49de044..0000000
--- a/docs/libvirt-dbus.pod
+++ /dev/null
@@ -1,66 +0,0 @@
-=head1 NAME
-
-libvirt-dbus - D-Bus daemon exporting libvirt API
-
-=head1 SYNOPSIS
-
-B<libvirt-dbus> [I<OPTION>]...
-
-=head1 DESCRIPTION
-
-libvirt-dbus wraps libvirt API to provide a high-level object-oriented
-API better suited for dbus-based applications.
-
-Normally libvirt-dbus is started by D-Bus daemon on demand.
-
-=head1 OPTIONS
-
-=over
-
-=item B<-h --help>
-
-Display command line help usage then exit.
-
-=item B<--system>
-
-Connect to the system bus.
-
-=item B<--session>
-
-Connect to the session bus.
-
-=item B<-t --threads> I<NUM>
-
-Configure maximal number of worker threads.
-
-=back
-
-=head1 BUGS
-
-Please report all bugs you discover.  This should be done via either:
-
-=over
-
-=item a) the mailing list
-
-L<https://libvirt.org/contact.html>
-
-=item b) the bug tracker
-
-L<https://libvirt.org/bugs.html>
-
-=back
-
-Alternatively, you may report bugs to your software distribution / vendor.
-
-=head1 AUTHORS
-
-Please refer to the AUTHORS file distributed with libvirt-dbus.
-
-=head1 LICENSE
-
-libvirt-dbus is Free Software and licenced under LGPLv2+.
-
-=head1 SEE ALSO
-
-L<https://libvirt.org/dbus.html>, L<https://libvirt.org/>
diff --git a/docs/libvirt-dbus.rst b/docs/libvirt-dbus.rst
new file mode 100644
index 0000000..cb01fac
--- /dev/null
+++ b/docs/libvirt-dbus.rst
@@ -0,0 +1,71 @@
+============
+libvirt-dbus
+============
+
+----------------------------------
+D-Bus daemon exporting libvirt API
+----------------------------------
+
+:Manual section: 8
+
+SYNOPSIS
+========
+
+``libvirt-dbus`` [*OPTION*]...
+
+DESCRIPTION
+===========
+
+libvirt-dbus wraps libvirt API to provide a high-level object-oriented
+API better suited for dbus-based applications.
+
+Normally libvirt-dbus is started by D-Bus daemon on demand.
+
+OPTIONS
+=======
+
+**-h --help**
+
+  Display command line help usage then exit.
+
+**--system**
+
+  Connect to the system bus.
+
+**--session**
+
+  Connect to the session bus.
+
+**-t --threads** *NUM*
+
+  Configure maximal number of worker threads.
+
+BUGS
+====
+
+Please report all bugs you discover.  This should be done via either:
+
+a) the mailing list
+
+  https://libvirt.org/contact.html
+
+b) the bug tracker
+
+  https://libvirt.org/bugs.html
+
+Alternatively, you may report bugs to your software distribution / vendor.
+
+AUTHORS
+=======
+
+Please refer to the AUTHORS file distributed with libvirt-dbus.
+
+LICENSE
+=======
+
+libvirt-dbus is Free Software and licenced under LGPLv2+.
+
+SEE ALSO
+========
+
+https://libvirt.org/dbus.html, https://libvirt.org/
diff --git a/docs/meson.build b/docs/meson.build
index e62e71a..fbeaf12 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -1,8 +1,8 @@
-prog_pod2man = find_program('pod2man')
+prog_rst2man = find_program('rst2man')
 
 configure_file(
-    command: [prog_pod2man.path(), '-s 8', '@INPUT@', '@OUTPUT@'],
-    input: 'libvirt-dbus.pod',
+    command: [prog_rst2man.path(), '@INPUT@', '@OUTPUT@'],
+    input: 'libvirt-dbus.rst',
     output: 'libvirt-dbus.8',
     install_dir: join_paths (get_option('mandir'), 'man8'),
 )
diff --git a/libvirt-dbus.spec.in b/libvirt-dbus.spec.in
index 175910e..84172fa 100644
--- a/libvirt-dbus.spec.in
+++ b/libvirt-dbus.spec.in
@@ -19,7 +19,7 @@ BuildRequires: meson >= %{meson_version}
 BuildRequires: glib2-devel >= %{glib2_version}
 BuildRequires: libvirt-devel >= %{libvirt_version}
 BuildRequires: libvirt-glib-devel >= %{libvirt_glib_version}
-BuildRequires: /usr/bin/pod2man
+BuildRequires: /usr/bin/rst2man
 
 Requires: dbus
 Requires: glib2 >= %{glib2_version}
-- 
2.25.3





[Index of Archives]     [Virt Tools]     [Libvirt Users]     [Lib OS Info]     [Fedora Users]     [Fedora Desktop]     [Fedora SELinux]     [Big List of Linux Books]     [Yosemite News]     [KDE Users]     [Fedora Tools]

  Powered by Linux