From nobody Tue Nov 26 12:31:31 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=1575644045; cv=none; d=zohomail.com; s=zohoarc; b=hQjG4GUXTdU0+bxCZHKFFOwdGYmr+LBBe9R6IuWPI9Jg410MB63VCjHNqrLP67u5WP3QYGY/edSTY/L2Wk7QRJOfya7e3IRNiOA13n9s/u4U8ODITbWK8CqIBu0S7kgb6qE8Cq4IycZkXc4/wNpYkclfCx3gpl8BbeMrXicTjK4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1575644045; 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=dFCOlxTwZZnQa+ldkYcmlXV3TKcK9yMrYO23IpqRNEA=; b=CtxzCK97HJX6tHiBeuDi3N+SiS2RrGiS3UZqdy7MaOimYRftrZJ7mUAYd3tCRbkln2u/XeZIigaEdkhBT9hJzHBlHxWc1/czBIdAeN2751o1VNXIM+zk4bZNloBVQ9wGJuSXhCe3op4oND0bMcBAJkF3M4iGhR+Iopircx9Moj8= 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 1575644045103888.5706192272265; Fri, 6 Dec 2019 06:54:05 -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-18-fYjtCEaWOnikc_rRt6cwAg-1; Fri, 06 Dec 2019 09:51:32 -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 A80BF800D5C; Fri, 6 Dec 2019 14:51:26 +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 798FB6CE46; Fri, 6 Dec 2019 14:51:26 +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 3747D6B51B; Fri, 6 Dec 2019 14:51:26 +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 xB6EpPmc017064 for ; Fri, 6 Dec 2019 09:51:25 -0500 Received: by smtp.corp.redhat.com (Postfix) id 166BA5D9E1; Fri, 6 Dec 2019 14:51:25 +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 91AA25DA7B; Fri, 6 Dec 2019 14:51:19 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1575644042; 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=dFCOlxTwZZnQa+ldkYcmlXV3TKcK9yMrYO23IpqRNEA=; b=NtJmbQVreaR5FvqOsTRuApRA6DAtn0f80nh0Q6QSebaOWBF3KaODzP9zBC4tbgyJMgMJ5z MdaxrkzOa1642YWhO+YqEA4ZM3eVxZxnGQnAqxUKS0h3izaTU0ds7aWTQ/Ot7uGWAZpvuC bC7q6D7CJosbhQn6DL1BauKRzXOuKeI= From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Date: Fri, 6 Dec 2019 14:50:34 +0000 Message-Id: <20191206145042.3777845-10-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 09/17] docs: convert virt-host-validate 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.12 X-MC-Unique: fYjtCEaWOnikc_rRt6cwAg-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 --- docs/Makefile.am | 5 ++ docs/manpages/index.rst | 5 ++ docs/manpages/virt-host-validate.rst | 95 ++++++++++++++++++++++++++++ tools/Makefile.am | 3 - tools/virt-host-validate.pod | 68 -------------------- 5 files changed, 105 insertions(+), 71 deletions(-) create mode 100644 docs/manpages/virt-host-validate.rst delete mode 100644 tools/virt-host-validate.pod diff --git a/docs/Makefile.am b/docs/Makefile.am index 9fa706f0a9..bedcc04bd4 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -224,6 +224,11 @@ manpages_rst +=3D \ manpages/virtlogd.rst \ $(NULL) endif ! WITH_LIBVIRTD +if WITH_HOST_VALIDATE + manpages8_rst +=3D manpages/virt-host-validate.rst +else ! WITH_HOST_VALIDATE + manpages_rst +=3D manpages/virt-host-validate.rst +endif ! WITH_HOST_VALIDATE 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 8544fb2501..a545960919 100644 --- a/docs/manpages/index.rst +++ b/docs/manpages/index.rst @@ -8,3 +8,8 @@ Daemons * `libvirtd(8) `__ - libvirt management daemon * `virtlockd(8) `__ - libvirt lock management daemon * `virtlogd(8) `__ - libvirt log management daemon + +Tools +=3D=3D=3D=3D=3D + +* `virt-host-validate(1) `__ - validate host virt= ualization setup diff --git a/docs/manpages/virt-host-validate.rst b/docs/manpages/virt-host= -validate.rst new file mode 100644 index 0000000000..0738694662 --- /dev/null +++ b/docs/manpages/virt-host-validate.rst @@ -0,0 +1,95 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +virt-host-validate +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +---------------------------------- +validate host virtualization setup +---------------------------------- + +:Manual section: 1 +:Manual group: Virtualization Support + +.. contents:: + +SYNOPSIS +=3D=3D=3D=3D=3D=3D=3D=3D + +``virt-host-validate`` [*OPTIONS*...] [*HV-TYPE*] + + +DESCRIPTION +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +This tool validates that the host is configured in a suitable +way to run libvirt hypervisor drivers. If invoked without any +arguments it will check support for all hypervisor drivers it +is aware of. Optionally it can be given a particular hypervisor +type (``qemu``, ``lxc`` or ``bhyve``) to restrict the checks +to those relevant for that virtualization technology + + +OPTIONS +=3D=3D=3D=3D=3D=3D=3D + +``-v``, ``--version`` + +Display the command version + +``-h``, ``--help`` + +Display the command line help + +``-q``, ``--quiet`` + +Don't display details of individual checks being performed. +Only display output if a check does not pass. + + +EXIT STATUS +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Upon successful validation, an exit status of 0 will be set. Upon +failure a non-zero status will be set. + +AUTHOR +=3D=3D=3D=3D=3D=3D + +Daniel P. Berrang=C3=A9 + + +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) 2012 by Red Hat, Inc. + + +LICENSE +=3D=3D=3D=3D=3D=3D=3D + +``virt-host-validate`` 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 +=3D=3D=3D=3D=3D=3D=3D=3D + +virsh(1), virt-pki-validate(1), virt-xml-validate(1), +`https://libvirt.org/ `_ diff --git a/tools/Makefile.am b/tools/Makefile.am index 1a541a3984..f4e71d38f2 100644 --- a/tools/Makefile.am +++ b/tools/Makefile.am @@ -54,7 +54,6 @@ ICON_FILES =3D \ =20 PODFILES =3D \ virt-admin.pod \ - virt-host-validate.pod \ virt-login-shell.pod \ virt-pki-validate.pod \ virt-sanlock-cleanup.pod \ @@ -64,7 +63,6 @@ PODFILES =3D \ =20 MANINFILES =3D \ virt-admin.1.in \ - virt-host-validate.1.in \ virt-login-shell.1.in \ virt-pki-validate.1.in \ virt-sanlock-cleanup.8.in \ @@ -118,7 +116,6 @@ endif WITH_LOGIN_SHELL =20 if WITH_HOST_VALIDATE bin_PROGRAMS +=3D virt-host-validate -man1_MANS +=3D virt-host-validate.1 endif WITH_HOST_VALIDATE =20 virt-xml-validate: virt-xml-validate.in Makefile diff --git a/tools/virt-host-validate.pod b/tools/virt-host-validate.pod deleted file mode 100644 index 121bb7ed7a..0000000000 --- a/tools/virt-host-validate.pod +++ /dev/null @@ -1,68 +0,0 @@ -=3Dhead1 NAME - -virt-host-validate - validate host virtualization setup - -=3Dhead1 SYNOPSIS - -B [I...] [I] - -=3Dhead1 DESCRIPTION - -This tool validates that the host is configured in a suitable -way to run libvirt hypervisor drivers. If invoked without any -arguments it will check support for all hypervisor drivers it -is aware of. Optionally it can be given a particular hypervisor -type ('qemu', 'lxc' or 'bhyve') to restrict the checks -to those relevant for that virtualization technology - -=3Dhead1 OPTIONS - -=3Dover 4 - -=3Ditem C<-v>, C<--version> - -Display the command version - -=3Ditem C<-h>, C<--help> - -Display the command line help - -=3Ditem C<-q>, C<--quiet> - -Don't display details of individual checks being performed. -Only display output if a check does not pass. - -=3Dback - -=3Dhead1 EXIT STATUS - -Upon successful validation, an exit status of 0 will be set. Upon -failure a non-zero status will be set. - -=3Dhead1 AUTHOR - -Daniel P. Berrange - -=3Dhead1 BUGS - -Report any bugs discovered to the libvirt community via the -mailing list L or bug tracker -L. -Alternatively report bugs to your software distributor / vendor. - -=3Dhead1 COPYRIGHT - -Copyright (C) 2012 by Red Hat, Inc. - -=3Dhead1 LICENSE - -virt-host-validate 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 - -=3Dhead1 SEE ALSO - -L, L, L - -=3Dcut --=20 2.23.0 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list