From nobody Sun May 5 10:06:41 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 205.139.110.61 as permitted sender) client-ip=205.139.110.61; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-1.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.61 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1575643860; cv=none; d=zohomail.com; s=zohoarc; b=Ht5p+oDwwQ4XAcvsQU6uByRTkCdhK+GsTIv2Ij84n009BSRXip8xLRJIQSyxybCrWYHFRuZaKPjD7L00XwpAlbotlC+SLaLrCaLNPzm26GVyvYkp6SW1GQrfFZZ8SuarrrE2mdl75BBuH1zGrHkpBLRgeJiLSkq8EYqmXBQtPBU= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1575643860; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=pX/pHTI+Gzr8r35u1RWtkwBTvBTo2lsLThAFbzXApvM=; b=lYUAGhtIC8/dMUIJDI9LXeq/DWMV9UdzTbSeGJ7CQiEV6yJlS6c5UYk2d030WWqfY+b6ctCSVCi9aVXneYDhBCbRBh1kYT/4UQ9EnlqI/Q/kIMAW+U38Xhxxsu+KVFjc09E3kCPxhSYJ64IpyQRaowQWiaHbidVhGROyWd6Od1c= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.61 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-1.mimecast.com (us-smtp-1.mimecast.com [205.139.110.61]) by mx.zohomail.com with SMTPS id 1575643860910442.2845397201015; Fri, 6 Dec 2019 06:51:00 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-222-D1Ym7PMDNDeyjkB7wxniyA-1; Fri, 06 Dec 2019 09:50:57 -0500 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id EF26F800D54; Fri, 6 Dec 2019 14:50:51 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 5DD18619DB; Fri, 6 Dec 2019 14:50:51 +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 CFCF11803C33; Fri, 6 Dec 2019 14:50:50 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id xB6EomAQ016948 for ; Fri, 6 Dec 2019 09:50:48 -0500 Received: by smtp.corp.redhat.com (Postfix) id C54ED5DA60; Fri, 6 Dec 2019 14:50:48 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-112-49.ams2.redhat.com [10.36.112.49]) by smtp.corp.redhat.com (Postfix) with ESMTP id E74C75D9E1; Fri, 6 Dec 2019 14:50:47 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1575643859; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=pX/pHTI+Gzr8r35u1RWtkwBTvBTo2lsLThAFbzXApvM=; b=VfUgFyEK/DhJ0T2q1QE45ujgWQLepxF7l2a5ziJcQAAaKuPQDQEnQdS9PtajX4XMX4c8MB 0/0J5DnBBvA0dxWIQC1Fm3Stsbh2BHmZAu4fPIAPsXuUK7JUAZKrmT0vM9vGU90k8xuVpi CktV2ZRNbL39LNu7xV9hVggaxwLPC3U= From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Date: Fri, 6 Dec 2019 14:50:26 +0000 Message-Id: <20191206145042.3777845-2-berrange@redhat.com> In-Reply-To: <20191206145042.3777845-1-berrange@redhat.com> References: <20191206145042.3777845-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 X-loop: libvir-list@redhat.com Subject: [libvirt] [PATCH 01/17] src: update keycodemapdb submodule 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: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-MC-Unique: D1Ym7PMDNDeyjkB7wxniyA-1 X-Mimecast-Spam-Score: 0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) Pull in changes which support use of RST for docs output format instead of POD. The generator tool has changed its command line arg handling so all args must be after the command name. The docs title and subtitle must be specified separately too. Signed-off-by: Daniel P. Berrang=C3=A9 Reviewed-by: Cole Robinson --- src/keycodemapdb | 2 +- src/util/Makefile.inc.am | 16 ++++++++-------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/keycodemapdb b/src/keycodemapdb index 6280c94f30..317d3eeb96 160000 --- a/src/keycodemapdb +++ b/src/keycodemapdb @@ -1 +1 @@ -Subproject commit 6280c94f306df6a20bbc100ba15a5a81af0366e6 +Subproject commit 317d3eeb963a515e15a63fa356d8ebcda7041a51 diff --git a/src/util/Makefile.inc.am b/src/util/Makefile.inc.am index 0855f152fd..ec10e53606 100644 --- a/src/util/Makefile.inc.am +++ b/src/util/Makefile.inc.am @@ -310,7 +310,7 @@ util/virkeycodetable_%.h: $(srcdir)/keycodemapdb/data/k= eymaps.csv \ -e 's,\.h,,'` && \ $(MKDIR_P) util/ && \ $(RUNUTF8) $(PYTHON) $(srcdir)/keycodemapdb/tools/keymap-gen \ - --lang stdc --varname virKeyCodeTable_$$NAME code-table \ + code-table --lang stdc --varname virKeyCodeTable_$$NAME \ $(srcdir)/keycodemapdb/data/keymaps.csv $$NAME > $@-tmp && \ mv $@-tmp $@ || rm -f $@-tmp =20 @@ -320,7 +320,7 @@ util/virkeynametable_%.h: $(srcdir)/keycodemapdb/data/k= eymaps.csv \ -e 's,\.h,,'` && \ $(MKDIR_P) util/ && \ $(RUNUTF8) $(PYTHON) $(srcdir)/keycodemapdb/tools/keymap-gen \ - --lang stdc --varname virKeyNameTable_$$NAME name-table \ + name-table --lang stdc --varname virKeyNameTable_$$NAME \ $(srcdir)/keycodemapdb/data/keymaps.csv $$NAME > $@-tmp && \ mv $@-tmp $@ || rm -f $@-tmp =20 @@ -330,9 +330,9 @@ util/virkeycode-%.pod: $(srcdir)/keycodemapdb/data/keym= aps.csv \ -e 's,\.pod,,'` && \ $(MKDIR_P) util/ && \ $(RUNUTF8) $(PYTHON) $(srcdir)/keycodemapdb/tools/keymap-gen \ - --lang pod \ - --varname "virkeycode-$$NAME - Key code values for $$NAME" \ - code-docs \ + code-docs --lang pod \ + --title "virkeycode-$$NAME" \ + --subtitle "Key code values for $$NAME" \ $(srcdir)/keycodemapdb/data/keymaps.csv $$NAME > \ $@-tmp && mv $@-tmp $@ || rm $@-tmp =20 @@ -342,9 +342,9 @@ util/virkeyname-%.pod: $(srcdir)/keycodemapdb/data/keym= aps.csv \ -e 's,\.pod,,'` && \ $(MKDIR_P) util/ && \ $(RUNUTF8) $(PYTHON) $(srcdir)/keycodemapdb/tools/keymap-gen \ - --lang pod \ - --varname "virkeyname-$$NAME - Key name values for $$NAME" \ - name-docs \ + name-docs --lang pod \ + --title "virkeyname-$$NAME" \ + --subtitle "Key name values for $$NAME" \ $(srcdir)/keycodemapdb/data/keymaps.csv $$NAME > \ $@-tmp && mv $@-tmp $@ || rm $@-tmp =20 --=20 2.23.0 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list From nobody Sun May 5 10:06:41 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 205.139.110.61 as permitted sender) client-ip=205.139.110.61; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-1.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.61 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1575643863; cv=none; d=zohomail.com; s=zohoarc; b=mWOKKMCU0f0KR/DbZZfO6iKB9gjHwl6j08Vdwg1vZ3gYRKLEo9qvfIlvCQUQBBPSSf4+uy2LMPn69rrjogZturRh3y+4ap2D5yMVBJ+uC7CBXkhr18/WZnKOuCr/WxhPyYg9F5VmGdmUuEezH7jADDuZpbx3oGMFUASSNNR7glk= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1575643863; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=smQkeBIXEsg3nFYWEyWpGAA6aIwhwxqS6JNH6I2xA3U=; b=MerB5a4ntbMy/sSj+QtcV0ZT1RM8C5QfUCChhOzuLbYGJFW2QCyx9jvVPQ+pTCWEl4q8227c3etEOL+pYPLtt/z+PAkc2PqzVg5Ctd3YR4C3nr5wqYmTsAQaeeTtW3htP1ndEu5BwUwSo87csVyCQeWYij5fxOerxdfQXgCcIBo= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.61 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-1.mimecast.com (us-smtp-1.mimecast.com [205.139.110.61]) by mx.zohomail.com with SMTPS id 1575643863416586.9481703631982; Fri, 6 Dec 2019 06:51:03 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-286-3aCOvKi1NYm9ICDLuvQfhw-1; Fri, 06 Dec 2019 09:50:58 -0500 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 50B27100551D; Fri, 6 Dec 2019 14:50:52 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 2C82A6013B; Fri, 6 Dec 2019 14:50:52 +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 D78711803C38; Fri, 6 Dec 2019 14:50:51 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id xB6EooBE016958 for ; Fri, 6 Dec 2019 09:50:50 -0500 Received: by smtp.corp.redhat.com (Postfix) id 5FCCA5D9E1; Fri, 6 Dec 2019 14:50:50 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-112-49.ams2.redhat.com [10.36.112.49]) by smtp.corp.redhat.com (Postfix) with ESMTP id 2371B5D9E2; Fri, 6 Dec 2019 14:50:48 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1575643862; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=smQkeBIXEsg3nFYWEyWpGAA6aIwhwxqS6JNH6I2xA3U=; b=TTMBi/XNQXfkx1y475kr4UcqUQzB3PkAoi6ilEx4b7vD1hbO95bnqIMc3HTt/gImRY4YU7 2/fGgRF2GKIsVSuTgnr2TjZXtyVJBhsWIfVy2J12Q5Pj/Z6StXqcXRBEO54xpv5hFoxi+e 7CSGpEs+EEbziIiePJnDIJmRXd+z1xs= From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Date: Fri, 6 Dec 2019 14:50:27 +0000 Message-Id: <20191206145042.3777845-3-berrange@redhat.com> In-Reply-To: <20191206145042.3777845-1-berrange@redhat.com> References: <20191206145042.3777845-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 X-loop: libvir-list@redhat.com Subject: [libvirt] [PATCH 02/17] rpm: move pod2man & rst2html deps outside the autotools conditional 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: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 X-MC-Unique: 3aCOvKi1NYm9ICDLuvQfhw-1 X-Mimecast-Spam-Score: 0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) The generated man pages were previously bundled in the dist, so pod2man was inside the autotools conditional. We no longer bundle any generated files in the dist though, so pod2man must always be present. rst2html then mistakenly just followed what pod2man did. Signed-off-by: Daniel P. Berrang=C3=A9 Reviewed-by: Cole Robinson --- libvirt.spec.in | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/libvirt.spec.in b/libvirt.spec.in index c431f0dfb5..4999df525e 100644 --- a/libvirt.spec.in +++ b/libvirt.spec.in @@ -264,10 +264,10 @@ BuildRequires: autoconf BuildRequires: automake BuildRequires: gettext-devel BuildRequires: libtool +%endif BuildRequires: /usr/bin/pod2man # Replace with python3-docutils when we drop py2 support BuildRequires: /usr/bin/rst2html -%endif BuildRequires: gcc BuildRequires: git %if 0%{?fedora} || 0%{?rhel} > 7 --=20 2.23.0 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list From nobody Sun May 5 10:06:41 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 207.211.31.81 as permitted sender) client-ip=207.211.31.81; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-1.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 207.211.31.81 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1575643879; cv=none; d=zohomail.com; s=zohoarc; b=OhxWdmBrwP4W+AbAx/TAM6acG6RS+1XLBw8sgAyEbn3VLGJdAk32bH7HDV3evtQh2gvjnp/Q1DA5Fxy4a0fJfEcgxWHhffeoYjqH4AJaN5O9qPaRPvwNh1sXw4ogJpHO9J2BwuecX/Det/Gw0NlXjVEKOlVZVdqQZk42rL1pQok= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1575643879; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=hhQDPVbax0iXZhK8eRhuHFQWJDJhAlHR1C6nIatz5zE=; b=X6TeOvALtHOXz9y5VSIrudUuzdmteISuO1WeH4ScFGqYyHB97lRyaLuAXJnV/E7L6ZgaUkxNdR9lCg3q+cLcjiOOwHbqArVJDhNbClVmyrIsdLEW+PXX8PjD9odRP4sij87iCiXQoejos/Er4lB33hNjRXYubhWITtPxa0NTAvI= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 207.211.31.81 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-1.mimecast.com (us-smtp-1.mimecast.com [207.211.31.81]) by mx.zohomail.com with SMTPS id 1575643879580666.7823744856308; Fri, 6 Dec 2019 06:51:19 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-71-TZZMhr9qMiOkdm7QrUEzfw-1; Fri, 06 Dec 2019 09:51:16 -0500 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id E3BD0DB61; Fri, 6 Dec 2019 14:51:09 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id ADCCE60135; Fri, 6 Dec 2019 14:51:09 +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 4FEAB1803C33; Fri, 6 Dec 2019 14:51:09 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id xB6Eoqfl016969 for ; Fri, 6 Dec 2019 09:50:52 -0500 Received: by smtp.corp.redhat.com (Postfix) id 0399E5D9E2; Fri, 6 Dec 2019 14:50:52 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-112-49.ams2.redhat.com [10.36.112.49]) by smtp.corp.redhat.com (Postfix) with ESMTP id C498B5D9E1; Fri, 6 Dec 2019 14:50:50 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1575643878; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=hhQDPVbax0iXZhK8eRhuHFQWJDJhAlHR1C6nIatz5zE=; b=MEEkhDYADuZNTiBfg3a3928fS6fgPS0M+AUhrWIhv+NqLtnKuVwlVyKKSedmraNidqFEJV s2YCDmBSV5eJTqBmNyPQAtGkKqOvLQvg9oOHrWnWiQIevMWBZpNUcViB3dEzQkIh7tE0f1 qhwtTPKf+UkuPlZjKqrjSYXoSGbIi8g= From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Date: Fri, 6 Dec 2019 14:50:28 +0000 Message-Id: <20191206145042.3777845-4-berrange@redhat.com> In-Reply-To: <20191206145042.3777845-1-berrange@redhat.com> References: <20191206145042.3777845-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 X-loop: libvir-list@redhat.com Subject: [libvirt] [PATCH 03/17] rpm: use python3-docutils as the direct dep 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: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 X-MC-Unique: TZZMhr9qMiOkdm7QrUEzfw-1 X-Mimecast-Spam-Score: 0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) We no longer support python2, so using a file based dep for rst2html is not required. We do still have to do special casing for RHEL-7 though as the RPM is annoyingly different. Signed-off-by: Daniel P. Berrang=C3=A9 Reviewed-by: Cole Robinson --- libvirt.spec.in | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/libvirt.spec.in b/libvirt.spec.in index 4999df525e..8e05d3d0ea 100644 --- a/libvirt.spec.in +++ b/libvirt.spec.in @@ -266,8 +266,11 @@ BuildRequires: gettext-devel BuildRequires: libtool %endif BuildRequires: /usr/bin/pod2man -# Replace with python3-docutils when we drop py2 support -BuildRequires: /usr/bin/rst2html +%if 0%{?rhel} =3D=3D 7 +BuildRequires: python36-docutils +%else +BuildRequires: python3-docutils +%endif BuildRequires: gcc BuildRequires: git %if 0%{?fedora} || 0%{?rhel} > 7 --=20 2.23.0 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list From nobody Sun May 5 10:06:41 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 207.211.31.120 as permitted sender) client-ip=207.211.31.120; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-1.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 207.211.31.120 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1575643926; cv=none; d=zohomail.com; s=zohoarc; b=QIWxIxLXRfLCz4EN+qh17FztxsODXV2ohAT34ymwiWO8WFi1OgSlZHYro5uu34OXp5kaWM0yEHVXfNVunhGr9vRIaFMurhiJlw6UFUY/jyxYmhYHVlYPfkp05JLKociKE+YGB6wK9RiXlsLKEkwxaLbx5LsVGe3+J/w6R+M4meE= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1575643926; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=n6VeX5/qw4PzF7Dc00vpN+72GMaDpnpPeYtczkvvUFw=; b=Ea1x4sjcyco5GiaKYZzA5peElM7ePnSMGnI+vkoAF4xrC52kwNSbCM3vUi6Lsyi5CVFPC5VFUqp9m5nuHEpHmM9sK8zv5S+Isl2+P0+Nt7YWu1MOx16O3xtMtfTU9BEOsjVouzNQxwCashvo7jRfYAZKvesPR7iUhjlLju/ENEk= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 207.211.31.120 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-1.mimecast.com (us-smtp-delivery-1.mimecast.com [207.211.31.120]) by mx.zohomail.com with SMTPS id 1575643926507384.6779742523569; Fri, 6 Dec 2019 06:52:06 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-313-SOTC1YYONjmzgKz6Nf6hiQ-1; Fri, 06 Dec 2019 09:51:19 -0500 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 72D8E107ACC4; Fri, 6 Dec 2019 14:51:13 +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 489066CE40; Fri, 6 Dec 2019 14:51:13 +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 0A1EA6B4B3; Fri, 6 Dec 2019 14:51:13 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id xB6Ep09r016982 for ; Fri, 6 Dec 2019 09:51:00 -0500 Received: by smtp.corp.redhat.com (Postfix) id B07825DA60; Fri, 6 Dec 2019 14:51:00 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-112-49.ams2.redhat.com [10.36.112.49]) by smtp.corp.redhat.com (Postfix) with ESMTP id 197EA5D9E2; Fri, 6 Dec 2019 14:50:52 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1575643925; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=n6VeX5/qw4PzF7Dc00vpN+72GMaDpnpPeYtczkvvUFw=; b=d9buHWgywAfYaf6FPT7+BPjRKZCAt8SXb8zsIDjZUDviijGwMfjp/T1+/lP/LSUzpu8odv eCdGij3vaKevTS4lwpdbqIjAwXJ3S/hNMUQGjzqDue76pO7DDyXTM6L4V428QWpG66CIsh Q0FkgHvoyvI0aCO+Fsdf/GRvnqbwZME= From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Date: Fri, 6 Dec 2019 14:50:29 +0000 Message-Id: <20191206145042.3777845-5-berrange@redhat.com> In-Reply-To: <20191206145042.3777845-1-berrange@redhat.com> References: <20191206145042.3777845-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 X-loop: libvir-list@redhat.com Subject: [libvirt] [PATCH 04/17] docs: introduce rst2man as a mandatory tool for building docs 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: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-MC-Unique: SOTC1YYONjmzgKz6Nf6hiQ-1 X-Mimecast-Spam-Score: 0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) The rst2man tool is provided by python docutils, and as the name suggests, it converts RST documents into man pages. The intention is that our current POD docs will be converted to RST format, allowing one more use of Perl to be eliminated from libvirt. The manual pages will now all be kept in the docs/manpages/ directory, which enables us to include the man pages in the published website. This is good for people searching for libvirt man pages online as it makes it more likely google will send them to the libvirt.org instead of some random third party man page site with outdated content. Signed-off-by: Daniel P. Berrang=C3=A9 Reviewed-by: Cole Robinson --- docs/Makefile.am | 60 ++++++++++++++++++++++++++++++++++++ docs/docs.html.in | 3 ++ docs/manpages/index.rst | 3 ++ m4/virt-external-programs.m4 | 5 +++ 4 files changed, 71 insertions(+) create mode 100644 docs/manpages/index.rst diff --git a/docs/Makefile.am b/docs/Makefile.am index 5f5dce28eb..34fea87805 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -197,6 +197,54 @@ kbase_html =3D \ kbasedir =3D $(HTML_DIR)/kbase kbase_DATA =3D $(kbase_html) =20 +manpages_rst =3D \ + manpages/index.rst \ + $(NULL) +manpages1_rst =3D \ + $(NULL) +manpages7_rst =3D \ + $(NULL) +manpages8_rst =3D \ + $(NULL) +manpages_rst +=3D \ + $(manpages1_rst) \ + $(manpages7_rst) \ + $(manpages8_rst) \ + $(NULL) +manpages_rst_html_in =3D \ + $(manpages_rst:%.rst=3D%.html.in) +manpages_html =3D \ + $(manpages_rst_html_in:%.html.in=3D%.html) + +man1_MANS =3D $(manpages1_rst:%.rst=3D%.1) +man7_MANS =3D $(manpages7_rst:%.rst=3D%.7) +man8_MANS =3D $(manpages8_rst:%.rst=3D%.8) + +%.1: %.rst + $(AM_V_GEN)$(MKDIR_P) `dirname $@` && \ + grep -v '^\.\. contents::' < $< | \ + sed -e 's|SYSCONFDIR|$(sysconfdir)|g' \ + -e 's|RUNSTATEDIR|$(runstatedir)|g' | \ + $(RST2MAN) > $@ + +%.7: %.rst + $(AM_V_GEN)$(MKDIR_P) `dirname $@` && \ + grep -v '^\.\. contents::' < $< | \ + sed -e 's|SYSCONFDIR|$(sysconfdir)|g' \ + -e 's|RUNSTATEDIR|$(runstatedir)|g' | \ + $(RST2MAN) > $@ + +%.8: %.rst + $(AM_V_GEN)$(MKDIR_P) `dirname $@` && \ + grep -v '^\.\. contents::' < $< | \ + sed -e 's|SYSCONFDIR|$(sysconfdir)|g' \ + -e 's|RUNSTATEDIR|$(runstatedir)|g' | \ + $(RST2MAN) > $@ + + +manpagesdir =3D $(HTML_DIR)/manpages +manpages_DATA =3D $(manpages_html) + # Generate hvsupport.html and news.html first, since they take one extra s= tep. dot_html_generated_in =3D \ hvsupport.html.in \ @@ -244,6 +292,7 @@ EXTRA_DIST=3D \ $(javascript) $(logofiles) \ $(internals_html_in) $(internals_rst) $(fonts) \ $(kbase_html_in) $(kbase_rst) \ + $(manpages_rst) \ aclperms.htmlinc \ hvsupport.pl \ $(schema_DATA) @@ -262,6 +311,10 @@ CLEANFILES =3D \ $(apilxchtml) \ $(internals_html) \ $(kbase_html) \ + $(manpages_html) \ + $(man1_MANS) \ + $(man7_MANS) \ + $(man8_MANS) \ $(api_DATA) \ $(dot_html_generated_in) \ aclperms.htmlinc @@ -298,6 +351,13 @@ EXTRA_DIST +=3D \ %.png: %.fig convert -rotate 90 $< $@ =20 +manpages/%.html.in: manpages/%.rst + $(AM_V_GEN)$(MKDIR_P) `dirname $@` && \ + grep -v '^:Manual ' < $< | \ + sed -e 's|SYSCONFDIR|$(sysconfdir)|g' \ + -e 's|RUNSTATEDIR|$(runstatedir)|g' | \ + $(RST2HTML) > $@ + %.html.in: %.rst $(AM_V_GEN)$(MKDIR_P) `dirname $@` && \ $(RST2HTML) $< > $@ diff --git a/docs/docs.html.in b/docs/docs.html.in index f441769617..fbf35234d4 100644 --- a/docs/docs.html.in +++ b/docs/docs.html.in @@ -9,6 +9,9 @@
Applications
Applications known to use libvirt
=20 +
Manual pages
+
Manual pages for libvirt tools / daemons
+
Windows
Downloads for Windows
=20 diff --git a/docs/manpages/index.rst b/docs/manpages/index.rst new file mode 100644 index 0000000000..11c72135e8 --- /dev/null +++ b/docs/manpages/index.rst @@ -0,0 +1,3 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +Libvirt Manual Pages +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D diff --git a/m4/virt-external-programs.m4 b/m4/virt-external-programs.m4 index ed634a4c73..9b128382fa 100644 --- a/m4/virt-external-programs.m4 +++ b/m4/virt-external-programs.m4 @@ -38,6 +38,11 @@ AC_DEFUN([LIBVIRT_CHECK_EXTERNAL_PROGRAMS], [ then AC_MSG_ERROR("rst2html is required to build libvirt") fi + AC_PATH_PROGS([RST2MAN], [rst2man rst2man.py rst2man-3], []) + if test -z "$RST2MAN" + then + AC_MSG_ERROR("rst2man is required to build libvirt") + fi AC_PATH_PROG([AUGPARSE], [augparse], [/usr/bin/augparse]) AC_PROG_MKDIR_P AC_PROG_LN_S --=20 2.23.0 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list From nobody Sun May 5 10:06:41 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 205.139.110.61 as permitted sender) client-ip=205.139.110.61; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-1.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.61 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1575643879; cv=none; d=zohomail.com; s=zohoarc; b=Cnx/ZzRo1j6z4NNCR+3j6bXHS6444FYImsT7JHidZc/h3t4NcBLy8UkZqhUdTNfwjSn/pyUPrum7zuj1edF1VJPPqvHDucRz9w1Bvvo1innGHPqlVJ5dLElrligJ512Un/0V7+hqU4IVNausFVvLAOe2tCmUv1xwgVTFgH34PWo= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1575643879; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=zhxzXiK7tGoIc2qS5VQgNo05RcuMtHwMIDGog2JgNxs=; b=SsdGDfVPiWDre+uhmmFbhabYsmjTXnYtaULvqSpyeoeOVkVJvIx+cDrq8Q3tyGIXql2xVkz3hr5jBry+mwjkvq6eJXlGmeEFrZyyJA9EBrs7NvLsqXFFCTTMHuBF69rDQsWe/RztABSlV5J26qIfDRZUuYCr83ufq0tF5AAb2bk= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.61 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-1.mimecast.com (us-smtp-2.mimecast.com [205.139.110.61]) by mx.zohomail.com with SMTPS id 1575643879868371.6696305696697; Fri, 6 Dec 2019 06:51:19 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-90-E1WTCtY4PbO20ISZE4Vrgg-1; Fri, 06 Dec 2019 09:51:16 -0500 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 87210DB63; Fri, 6 Dec 2019 14:51:11 +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 61E1F6013B; Fri, 6 Dec 2019 14:51:11 +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 2594D6B4B2; Fri, 6 Dec 2019 14:51:11 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id xB6Ep9wG017002 for ; Fri, 6 Dec 2019 09:51:09 -0500 Received: by smtp.corp.redhat.com (Postfix) id 5B7D95DA32; Fri, 6 Dec 2019 14:51:09 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-112-49.ams2.redhat.com [10.36.112.49]) by smtp.corp.redhat.com (Postfix) with ESMTP id 01ED75D9E2; Fri, 6 Dec 2019 14:51:00 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1575643878; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=zhxzXiK7tGoIc2qS5VQgNo05RcuMtHwMIDGog2JgNxs=; b=TyiZRgV9MPv89qbfpP5ENA4AoyWIG+SyxWR8PEs+xxlh53Dxb+RPoSg0QA1Abd5aW5WiKo ohqQIXuwR3EQzo1NnA4FdBvDagdC3pxbbXalcWPpM5jPNOyGje2aagahAaZ0bgp+gAPdvX in2HfcXxU3PROiG/TTONRXgukG7/DUM= From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Date: Fri, 6 Dec 2019 14:50:30 +0000 Message-Id: <20191206145042.3777845-6-berrange@redhat.com> In-Reply-To: <20191206145042.3777845-1-berrange@redhat.com> References: <20191206145042.3777845-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 X-loop: libvir-list@redhat.com Subject: [libvirt] [PATCH 05/17] docs: describe the basic RST structure for a man page 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: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 X-MC-Unique: E1WTCtY4PbO20ISZE4Vrgg-1 X-Mimecast-Spam-Score: 0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) Signed-off-by: Daniel P. Berrang=C3=A9 Reviewed-by: Cole Robinson --- docs/styleguide.rst | 86 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 86 insertions(+) diff --git a/docs/styleguide.rst b/docs/styleguide.rst index 71f29320cb..2998e90963 100644 --- a/docs/styleguide.rst +++ b/docs/styleguide.rst @@ -64,3 +64,89 @@ which allows for 6 levels of headings =20 Heading 6 ^^^^^^^^^ + +Manual pages +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +RST documents created as manual pages must have the following structure + +:: + + =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + ::PROGRAM:: + =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + + --------------------------- + ...line line description... + --------------------------- + + :Manual section: 8 + :Manual group: Virtualization Support + + .. contents:: + + SYNOPSIS + =3D=3D=3D=3D=3D=3D=3D=3D + + ``::PROGRAM::`` [*OPTION*]... + + DESCRIPTION + =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + + ...describe the tool / program ... + + OPTIONS + =3D=3D=3D=3D=3D=3D=3D + + ``-h``, ``--help`` + + Display command line help usage then exit. + + ...and other args.... + + FILES + =3D=3D=3D=3D=3D + + ...any files used that the user needs to know about. eg config + files in particular... + + AUTHORS + =3D=3D=3D=3D=3D=3D=3D + + Please refer to the AUTHORS file distributed with libvirt. + + BUGS + =3D=3D=3D=3D + + Please report all bugs you discover. This should be done via either: + + #. the mailing list + + `https://libvirt.org/contact.html `_ + + #. the bug tracker + + `https://libvirt.org/bugs.html `_ + + Alternatively, you may report bugs to your software distributor / vendor. + + + COPYRIGHT + =3D=3D=3D=3D=3D=3D=3D=3D=3D + + Copyright (C) ::DATE:: ::ORIGINAL AUTHOR::, and the authors listed in the + libvirt AUTHORS file. + + LICENSE + =3D=3D=3D=3D=3D=3D=3D + + ``::PROGRAM::`` is distributed under the terms of the GNU LGPL v2.1+. + 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 + =3D=3D=3D=3D=3D=3D=3D=3D + + ...other man page links.... + `https://www.libvirt.org/ `_ --=20 2.23.0 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list From nobody Sun May 5 10:06:41 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 205.139.110.120 as permitted sender) client-ip=205.139.110.120; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-1.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.120 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1575643926; cv=none; d=zohomail.com; s=zohoarc; b=ZgrrWnvWAGW4B81smnTrwbJDKM4pouJC47YyxiMD4FR4V8IbhXe0f6yF8qMU29jCYXY6hZp+t+tbe2SYMTza3jP/MAbD+naQ3axnB/78naWQeZy1mm4lujZLsi9TGefguOCZCYY8HQcQjzmOq2KUeqXBqM1VlfMk84cSaMMkDgI= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1575643926; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=YR03o5pYjcOQrNU3kxMnJx8i3LDSvz46xk/9fSh/tEE=; b=cSyALZNspbmUc7I2I6N9KTaNt6xziSG7VrOoKN0aKc9PEh2o/aQbXlFQbFz5TNgsr0SSPrBdjA0OUr9RD2kI4u8xtC/Oj4Pv8pWaGBU+/OVSc2XVCjkvs689FzadVa3aMJdB+eRTVy6r7g4wQ/e2kXKiil1pcpnK+mgIz7XovTw= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.120 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-1.mimecast.com (us-smtp-delivery-1.mimecast.com [205.139.110.120]) by mx.zohomail.com with SMTPS id 157564392627736.560657354687805; Fri, 6 Dec 2019 06:52:06 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-295-HJyaAaptOFOAD7rwA20E-A-1; Fri, 06 Dec 2019 09:51:21 -0500 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 1F8E618AAFA5; Fri, 6 Dec 2019 14:51:15 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id E921D5D6C3; Fri, 6 Dec 2019 14:51:14 +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 A1B7D1803C41; Fri, 6 Dec 2019 14:51:14 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id xB6EpCQK017017 for ; Fri, 6 Dec 2019 09:51:12 -0500 Received: by smtp.corp.redhat.com (Postfix) id 8620A5DA32; Fri, 6 Dec 2019 14:51:12 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-112-49.ams2.redhat.com [10.36.112.49]) by smtp.corp.redhat.com (Postfix) with ESMTP id 82D3D5D9E2; Fri, 6 Dec 2019 14:51:09 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1575643925; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=YR03o5pYjcOQrNU3kxMnJx8i3LDSvz46xk/9fSh/tEE=; b=fYEbaq1sQXNSb+PbouQrazZWbvqm8qS+bhvgso4r9s0sBsHv90/K41caxHaU+470BgmKTs 5vETaWvRUv6+VuqaLZIn1NvmqkPzckcyUHbEal+0LdSNpye087xDjnYY0kDzcgHvzMdh51 xCwMQrJMp9hl+uF+UxXd1fgnXVNNj4E= From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Date: Fri, 6 Dec 2019 14:50:31 +0000 Message-Id: <20191206145042.3777845-7-berrange@redhat.com> In-Reply-To: <20191206145042.3777845-1-berrange@redhat.com> References: <20191206145042.3777845-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 X-loop: libvir-list@redhat.com Subject: [libvirt] [PATCH 06/17] docs: convert libvirtd man page from pod to rst 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: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 X-MC-Unique: HJyaAaptOFOAD7rwA20E-A-1 X-Mimecast-Spam-Score: 0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) 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. Signed-off-by: Daniel P. Berrang=C3=A9 Reviewed-by: Cole Robinson --- docs/Makefile.am | 9 ++ docs/manpages/index.rst | 5 + docs/manpages/libvirtd.rst | 259 +++++++++++++++++++++++++++++++++++++ src/remote/Makefile.inc.am | 15 --- src/remote/libvirtd.pod | 235 --------------------------------- 5 files changed, 273 insertions(+), 250 deletions(-) create mode 100644 docs/manpages/libvirtd.rst delete mode 100644 src/remote/libvirtd.pod diff --git a/docs/Makefile.am b/docs/Makefile.am index 34fea87805..8205f28788 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -211,6 +211,15 @@ manpages_rst +=3D \ $(manpages7_rst) \ $(manpages8_rst) \ $(NULL) +if WITH_LIBVIRTD +manpages8_rst +=3D \ + manpages/libvirtd.rst \ + $(NULL) +else ! WITH_LIBVIRTD +manpages_rst +=3D \ + manpages/libvirtd.rst \ + $(NULL) +endif ! WITH_LIBVIRTD manpages_rst_html_in =3D \ $(manpages_rst:%.rst=3D%.html.in) manpages_html =3D \ diff --git a/docs/manpages/index.rst b/docs/manpages/index.rst index 11c72135e8..4467d88ba1 100644 --- a/docs/manpages/index.rst +++ b/docs/manpages/index.rst @@ -1,3 +1,8 @@ =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D Libvirt Manual Pages =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Daemons +=3D=3D=3D=3D=3D=3D=3D + +* `libvirtd(8) `__ - libvirt management daemon diff --git a/docs/manpages/libvirtd.rst b/docs/manpages/libvirtd.rst new file mode 100644 index 0000000000..b7489a57fc --- /dev/null +++ b/docs/manpages/libvirtd.rst @@ -0,0 +1,259 @@ +=3D=3D=3D=3D=3D=3D=3D=3D +libvirtd +=3D=3D=3D=3D=3D=3D=3D=3D + +------------------------- +libvirt management daemon +------------------------- + +:Manual section: 8 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +=3D=3D=3D=3D=3D=3D=3D=3D + +``libvirtd`` [*OPTION*]... + + +DESCRIPTION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +The ``libvirtd`` program is the server side daemon component of the libvirt +virtualization management system. + +This daemon runs on host servers and performs required management tasks for +virtualized guests. This includes activities such as starting, stopping +and migrating guests between host servers, configuring and manipulating +networking, and managing storage for use by guests. + +The libvirt client libraries and utilities connect to this daemon to issue +tasks and collect information about the configuration and resources of the= host +system and guests. + +By default, the libvirtd daemon listens for requests on a local Unix domain +socket. Using the ``-l`` | ``--listen`` command line option, the libvirtd= daemon +can be instructed to additionally listen on a TCP/IP socket. The TCP/IP s= ocket +to use is defined in the libvirtd configuration file. + +Restarting libvirtd does not impact running guests. Guests continue to op= erate +and will be picked up automatically if their XML configuration has been +defined. Any guests whose XML configuration has not been defined will be = lost +from the configuration. + + +SYSTEM SOCKET ACTIVATION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +The ``libvirtd`` daemon is capable of starting in two modes. + +In the traditional mode, it will create and listen on UNIX sockets itself. +If the ``--listen`` parameter is given, it will also listen on TCP/IP sock= et(s), +according to the ``listen_tcp`` and ``listen_tls`` options in +``/etc/libvirt/libvirtd.conf`` + +In socket activation mode, it will rely on systemd to create and listen +on the UNIX, and optionally TCP/IP, sockets and pass them as pre-opened +file descriptors. In this mode, it is not permitted to pass the ``--listen= `` +parameter, and most of the socket related config options in +``/etc/libvirt/libvirtd.conf`` will no longer have any effect. To enable +TCP or TLS sockets use either + +:: + + $ systemctl start libvirtd-tls.socket + +Or + +:: + + $ systemctl start libvirtd-tcp.socket + +Socket activation mode is generally the default when running on a host +OS that uses systemd. To revert to the traditional mode, all the socket +unit files must be masked: + +:: + + $ systemctl mask libvirtd.socket libvirtd-ro.socket \ + libvirtd-admin.socket libvirtd-tls.socket libvirtd-tcp.socket + + +OPTIONS +=3D=3D=3D=3D=3D=3D=3D + +``-h``, ``--help`` + +Display command line help usage then exit. + +``-d``, ``--daemon`` + +Run as a daemon & write PID file. + +``-f``, ``--config *FILE*`` + +Use this configuration file, overriding the default value. + +``-l``, ``--listen`` + +Listen for TCP/IP connections. This should not be set if using systemd +socket activation. Instead activate the libvirtd-tls.socket or +libvirtd-tcp.socket unit files. + +``-p``, ``--pid-file *FILE*`` + +Use this name for the PID file, overriding the default value. + +``-t``, ``--timeout *SECONDS*`` + +Exit after timeout period (in seconds), provided there are neither any cli= ent +connections nor any running domains. + +``-v``, ``--verbose`` + +Enable output of verbose messages. + +``--version`` + +Display version information then exit. + + +SIGNALS +=3D=3D=3D=3D=3D=3D=3D + +On receipt of ``SIGHUP`` libvirtd will reload its configuration. + + +FILES +=3D=3D=3D=3D=3D + +When run as *root* +------------------ + +* ``SYSCONFDIR/libvirt/libvirtd.conf`` + +The default configuration file used by libvirtd, unless overridden on the +command line using the ``-f`` | ``--config`` option. + +* ``RUNSTATEDIR/libvirt/libvirt-sock`` +* ``RUNSTATEDIR/libvirt/libvirt-sock-ro`` + +The sockets libvirtd will use. + +* ``SYSCONFDIR/pki/CA/cacert.pem`` + +The TLS **Certificate Authority** certificate libvirtd will use. + +* ``SYSCONFDIR/pki/libvirt/servercert.pem`` + +The TLS **Server** certificate libvirtd will use. + +* ``SYSCONFDIR/pki/libvirt/private/serverkey.pem`` + +The TLS **Server** private key libvirtd will use. + +* ``RUNSTATEDIR/libvirtd.pid`` + +The PID file to use, unless overridden by the ``-p`` | ``--pid-file`` opti= on. + + +When run as *non-root* +---------------------- + +* ``$XDG_CONFIG_HOME/libvirt/libvirtd.conf`` + +The default configuration file used by libvirtd, unless overridden on the +command line using the ``-f``|``--config`` option. + +* ``$XDG_RUNTIME_DIR/libvirt/libvirt-sock`` + +The socket libvirtd will use. + +* ``$HOME/.pki/libvirt/cacert.pem`` + +The TLS **Certificate Authority** certificate libvirtd will use. + +* ``$HOME/.pki/libvirt/servercert.pem`` + +The TLS **Server** certificate libvirtd will use. + +* ``$HOME/.pki/libvirt/serverkey.pem`` + +The TLS **Server** private key libvirtd will use. + +* ``$XDG_RUNTIME_DIR/libvirt/libvirtd.pid`` + +The PID file to use, unless overridden by the ``-p``|``--pid-file`` option. + + +If ``$XDG_CONFIG_HOME`` is not set in your environment, libvirtd will use +``$HOME/.config`` + +If ``$XDG_RUNTIME_DIR`` is not set in your environment, libvirtd will use +``$HOME/.cache`` + + +EXAMPLES +=3D=3D=3D=3D=3D=3D=3D=3D + +To retrieve the version of libvirtd: + +.. code-block:: shell + + # libvirtd --version + libvirtd (libvirt) 0.8.2 + + +To start libvirtd, instructing it to daemonize and create a PID file: + +.. code-block:: shell + + # libvirtd -d + # ls -la RUNSTATEDIR/libvirtd.pid + -rw-r--r-- 1 root root 6 Jul 9 02:40 RUNSTATEDIR/libvirtd.pid + + +BUGS +=3D=3D=3D=3D + +Please report all bugs you discover. This should be done via either: + +#. the mailing list + + `https://libvirt.org/contact.html `_ + +#. the bug tracker + + `https://libvirt.org/bugs.html `_ + +Alternatively, you may report bugs to your software distributor / vendor. + + +AUTHORS +=3D=3D=3D=3D=3D=3D=3D + +Please refer to the AUTHORS file distributed with libvirt. + + +COPYRIGHT +=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Copyright (C) 2006-2012 Red Hat, Inc., and the authors listed in the +libvirt AUTHORS file. + + +LICENSE +=3D=3D=3D=3D=3D=3D=3D + +libvirtd is distributed under the terms of the GNU LGPL v2.1+. +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 +=3D=3D=3D=3D=3D=3D=3D=3D + +virsh(1), virt-install(1), virt-xml-validate(1), virt-top(1), +virt-df(1), `https://www.libvirt.org/ `_ diff --git a/src/remote/Makefile.inc.am b/src/remote/Makefile.inc.am index 8103cfb96a..f648aa4ee4 100644 --- a/src/remote/Makefile.inc.am +++ b/src/remote/Makefile.inc.am @@ -91,9 +91,6 @@ LOGROTATE_FILES_IN +=3D \ =20 SYSCONF_FILES +=3D remote/libvirtd.sysconf =20 -PODFILES +=3D remote/libvirtd.pod -MANINFILES +=3D libvirtd.8.in - LIBVIRTD_SOCKET_UNIT_FILES_IN =3D \ remote/libvirtd.socket.in \ remote/libvirtd-ro.socket.in \ @@ -227,8 +224,6 @@ CLEANFILES +=3D \ remote/virtproxyd.aug \ $(NULL) =20 -man8_MANS +=3D libvirtd.8 - libvirtd_SOURCES =3D $(REMOTE_DAEMON_SOURCES) =20 nodist_libvirtd_SOURCES =3D $(REMOTE_DAEMON_GENERATED) @@ -462,13 +457,3 @@ remote/qemu_daemon_dispatch_stubs.h: $(srcdir)/rpc/gen= dispatch.pl \ $(AM_V_GEN)$(PERL) -w $(top_srcdir)/src/rpc/gendispatch.pl \ --mode=3Dserver qemu QEMU $(QEMU_PROTOCOL) \ > remote/qemu_daemon_dispatch_stubs.h - -libvirtd.8.in: remote/libvirtd.pod - $(AM_V_GEN)$(POD2MAN) --section=3D8 $< $@-t1 && \ - if grep 'POD ERROR' $@-t1; then rm $@-t1; exit 1; fi && \ - sed \ - -e 's|SYSCONFDIR|\@sysconfdir\@|g' \ - -e 's|RUNSTATEDIR|\@runstatedir\@|g' \ - < $@-t1 > $@-t2 && \ - rm -f $@-t1 && \ - mv $@-t2 $@ diff --git a/src/remote/libvirtd.pod b/src/remote/libvirtd.pod deleted file mode 100644 index 24def17dc4..0000000000 --- a/src/remote/libvirtd.pod +++ /dev/null @@ -1,235 +0,0 @@ -=3Dhead1 NAME - -libvirtd - libvirtd management daemon - -=3Dhead1 SYNOPSIS - -B [I