From nobody Sun May 5 23:53:53 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) client-ip=209.132.183.28; envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.zohomail.com with SMTPS id 1526392118260533.6681276674643; Tue, 15 May 2018 06:48:38 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.phx2.redhat.com [10.5.11.24]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 6314F66CA1; Tue, 15 May 2018 13:48:36 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id CF49930BBA66; Tue, 15 May 2018 13:48:34 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 5144B4BB79; Tue, 15 May 2018 13:48:33 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.rdu2.redhat.com [10.11.54.3]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id w4FDmVEx016141 for ; Tue, 15 May 2018 09:48:31 -0400 Received: by smtp.corp.redhat.com (Postfix) id 55B67111CA19; Tue, 15 May 2018 13:48:31 +0000 (UTC) Received: from antique-work.brq.redhat.com (unknown [10.43.2.152]) by smtp.corp.redhat.com (Postfix) with ESMTP id EF002111CA18 for ; Tue, 15 May 2018 13:48:28 +0000 (UTC) From: Pavel Hrdina To: libvir-list@redhat.com Date: Tue, 15 May 2018 15:48:28 +0200 Message-Id: X-Scanned-By: MIMEDefang 2.78 on 10.11.54.3 X-loop: libvir-list@redhat.com Subject: [libvirt] [dbus PATCH v2] docs: Introduce man file for libvirt-dbus daemon X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.84 on 10.5.11.24 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.38]); Tue, 15 May 2018 13:48:37 +0000 (UTC) X-ZohoMail: RSF_0 Z_629925259 SPT_0 Content-Type: text/plain; charset="utf-8" Signed-off-by: Pavel Hrdina Reviewed-by: Daniel P. Berrang=C3=A9 --- changes in v2: - added pod2man build dependency into spec file .gitignore | 2 ++ Makefile.am | 2 +- configure.ac | 1 + docs/Makefile.am | 13 +++++++++ docs/libvirt-dbus.pod | 66 +++++++++++++++++++++++++++++++++++++++++++ libvirt-dbus.spec.in | 2 ++ 6 files changed, 85 insertions(+), 1 deletion(-) create mode 100644 docs/Makefile.am create mode 100644 docs/libvirt-dbus.pod diff --git a/.gitignore b/.gitignore index c6d9754..0bf09cf 100644 --- a/.gitignore +++ b/.gitignore @@ -29,6 +29,8 @@ vgcore.* /data/system/libvirt-dbus.rules /data/system/org.libvirt.conf =20 +/docs/*.1 + /src/.deps/ /src/libvirt-dbus /src/org.libvirt.service diff --git a/Makefile.am b/Makefile.am index 16f57b2..bb5ff5c 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,5 +1,5 @@ =20 -SUBDIRS =3D data src tests +SUBDIRS =3D data docs src tests =20 ACLOCAL_AMFLAGS =3D -I m4 =20 diff --git a/configure.ac b/configure.ac index cc8947c..707a03e 100644 --- a/configure.ac +++ b/configure.ac @@ -74,6 +74,7 @@ AC_CONFIG_FILES([run], [chmod +x,-w run]) AC_OUTPUT(Makefile data/Makefile + docs/Makefile src/Makefile tests/Makefile libvirt-dbus.spec) diff --git a/docs/Makefile.am b/docs/Makefile.am new file mode 100644 index 0000000..c41ffae --- /dev/null +++ b/docs/Makefile.am @@ -0,0 +1,13 @@ +POD2MAN =3D pod2man -c "Virtualization Support" -r "$(PACKAGE)-$(VERSION)" + +PODFILES =3D libvirt-dbus.pod + +%.8: %.pod + $(AM_V_GEN)$(POD2MAN) -s 8 $< $@ \ + && if grep 'POD ERROR' $@; then rm $@; exit 1; fi + +man8_MANS =3D libvirt-dbus.8 + +EXTRA_DIST =3D $(PODFILES) + +CLEANFILES =3D $(man8_MANS) diff --git a/docs/libvirt-dbus.pod b/docs/libvirt-dbus.pod new file mode 100644 index 0000000..49de044 --- /dev/null +++ b/docs/libvirt-dbus.pod @@ -0,0 +1,66 @@ +=3Dhead1 NAME + +libvirt-dbus - D-Bus daemon exporting libvirt API + +=3Dhead1 SYNOPSIS + +B [I