From nobody Tue Nov 26 11:26:02 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=1575643927; cv=none; d=zohomail.com; s=zohoarc; b=eBzQUplNAOddksyOaEYgVhWixRPsDMMze+pWb3fhr9ATiXhS2wYyebF8dBsrxX0OywToAF4BEXSNjCfS+tm5HDpQ0mlCK+Cqm3IBIh9SGYCUZKpx7Zgl3CjW5UoA0lOWwi5R5s37WujJcWMppFwcuOR+NSVNny+pTFvtmhYeGpo= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1575643927; 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=tgDEHI6NCZ35SFUPMef0xcI9caIDXwQsKtkpiXlyarw=; b=OSy0Z6Rt6xFw3SXep13I8lQph9JyCyWmb0U4yoNmtQizVO0Gh5gvT1z54Erl7ygr2qZda9bGQXpN2gx1VAC+1G5Fv4qirGP5iWdJ8bG3Tsj0A+fq4tdBhQY/dbFa4IMc6kFtRfXBFeXDIE5EAJFEysGaLgxpuHrovRn/PQto/qY= 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 1575643927647541.8129708640352; Fri, 6 Dec 2019 06:52:07 -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-256-LDyLz-fPNkuNBHvF-O5GIw-1; Fri, 06 Dec 2019 09:52:01 -0500 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 84DA918AAFA1; Fri, 6 Dec 2019 14:51:55 +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 5A3AC5D9E2; Fri, 6 Dec 2019 14:51:55 +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 1D26D6B5C4; Fri, 6 Dec 2019 14:51:55 +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 xB6EprHW017237 for ; Fri, 6 Dec 2019 09:51:53 -0500 Received: by smtp.corp.redhat.com (Postfix) id 804A25DA32; Fri, 6 Dec 2019 14:51:53 +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 23FD55DA60; Fri, 6 Dec 2019 14:51:47 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1575643926; 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=tgDEHI6NCZ35SFUPMef0xcI9caIDXwQsKtkpiXlyarw=; b=SozlXPJIV5yzSIlcmSKhezVGq/IXJIbFCVWgPY1Xi2VU/dOcUp1ejpBar8YD/pYW7ulP6+ f7W2JQx1R1h6+m7QRpX9DjQ+YhTsgLA6zx1i44nI5j9/rw3D5eKrwLAD4U0aj09OP4mECo 2nJZR1DXyxsCj9TdDX9WvFUsdJJ0vB4= From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Date: Fri, 6 Dec 2019 14:50:41 +0000 Message-Id: <20191206145042.3777845-17-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 16/17] docs: convert virkeycode*/virkeyname* man pages 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.14 X-MC-Unique: LDyLz-fPNkuNBHvF-O5GIw-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 keycodemap tool is told to generate docs in rst format now instead of pod. Signed-off-by: Daniel P. Berrang=C3=A9 --- docs/Makefile.am | 30 ++++++++++++++++++++++++++++ docs/manpages/index.rst | 16 +++++++++++++++ src/util/Makefile.inc.am | 43 +--------------------------------------- 3 files changed, 47 insertions(+), 42 deletions(-) diff --git a/docs/Makefile.am b/docs/Makefile.am index fad506539b..e1f8f7646d 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -197,6 +197,10 @@ kbase_html =3D \ kbasedir =3D $(HTML_DIR)/kbase kbase_DATA =3D $(kbase_html) =20 +# Sync with src/util/ +KEYCODES =3D linux osx atset1 atset2 atset3 xtkbd usb win32 qnum +KEYNAMES =3D linux osx win32 + manpages_rst =3D \ manpages/index.rst \ $(NULL) @@ -207,6 +211,8 @@ manpages1_rst =3D \ manpages/virsh.rst \ $(NULL) manpages7_rst =3D \ + $(KEYCODES:%=3Dmanpages/virkeycode-%.rst) \ + $(KEYNAMES:%=3Dmanpages/virkeyname-%.rst) \ $(NULL) manpages8_rst =3D \ manpages/virt-sanlock-cleanup.rst \ @@ -269,6 +275,29 @@ man8_MANS =3D $(manpages8_rst:%.rst=3D%.8) -e 's|RUNSTATEDIR|$(runstatedir)|g' | \ $(RST2MAN) > $@ =20 +manpages/virkeycode-%.rst: $(top_srcdir)/src/keycodemapdb/data/keymaps.csv= \ + $(top_srcdir)/src/keycodemapdb/tools/keymap-gen Makefile.am + $(AM_V_GEN)export NAME=3D`echo $@ | \ + sed -e 's,manpages/virkeycode-,,' -e 's,\.rst,,'` && \ + $(MKDIR_P) manpages/ && \ + $(RUNUTF8) $(PYTHON) $(top_srcdir)/src/keycodemapdb/tools/keymap-gen \ + code-docs \ + --lang rst \ + --title "virkeycode-$$NAME" \ + --subtitle "Key code values for $$NAME" \ + $(top_srcdir)/src/keycodemapdb/data/keymaps.csv $$NAME > $@ + +manpages/virkeyname-%.rst: $(top_srcdir)/src/keycodemapdb/data/keymaps.csv= \ + $(top_srcdir)/src/keycodemapdb/tools/keymap-gen Makefile.am + $(AM_V_GEN)export NAME=3D`echo $@ | \ + sed -e 's,manpages/virkeyname-,,' -e 's,\.rst,,'` && \ + $(MKDIR_P) manpages/ && \ + $(RUNUTF8) $(PYTHON) $(top_srcdir)/src/keycodemapdb/tools/keymap-gen \ + name-docs \ + --lang rst \ + --title "virkeyname-$$NAME" \ + --subtitle "Key name values for $$NAME" \ + $(top_srcdir)/src/keycodemapdb/data/keymaps.csv $$NAME > $@ =20 manpagesdir =3D $(HTML_DIR)/manpages manpages_DATA =3D $(manpages_html) @@ -342,6 +371,7 @@ CLEANFILES =3D \ $(manpages_html) \ $(man1_MANS) \ $(man7_MANS) \ + $(manpages7_rst) \ $(man8_MANS) \ $(api_DATA) \ $(dot_html_generated_in) \ diff --git a/docs/manpages/index.rst b/docs/manpages/index.rst index 1041dbf8b4..4945ad59e2 100644 --- a/docs/manpages/index.rst +++ b/docs/manpages/index.rst @@ -19,3 +19,19 @@ Tools * `virt-login-shell(1) `__ - tool to execute a shel= l within a container * `virt-admin(1) `__ - daemon administration interface * `virsh(1) `__ - management user interface + +Key codes +=3D=3D=3D=3D=3D=3D=3D=3D=3D + +* `virkeycode-atset1 `__ - atset1 keycodes +* `virkeycode-atset2 `__ - atset2 keycodes +* `virkeycode-atset3 `__ - atset3 keycodes +* `virkeycode-linux `__ - linux keycodes +* `virkeycode-qnum `__ - qnmum keycodes +* `virkeycode-osx `__ - osx keycodes +* `virkeycode-usb `__ - usb keycodes +* `virkeycode-win32 `__ - win32 keycodes +* `virkeycode-xtkbd `__ - xtkbd keycodes +* `virkeyname-linux `__ - keycodes +* `virkeyname-osx `__ - osx keynames +* `virkeyname-win32 `__ - win32 keynames diff --git a/src/util/Makefile.inc.am b/src/util/Makefile.inc.am index ec10e53606..459378b264 100644 --- a/src/util/Makefile.inc.am +++ b/src/util/Makefile.inc.am @@ -242,7 +242,7 @@ EXTRA_DIST +=3D \ $(srcdir)/keycodemapdb/tools/keymap-gen \ $(NULL) =20 - +# Sync with docs/ KEYCODES =3D linux osx atset1 atset2 atset3 xtkbd usb win32 qnum KEYNAMES =3D linux osx win32 =20 @@ -251,15 +251,8 @@ KEYTABLES =3D \ $(KEYNAMES:%=3Dutil/virkeynametable_%.h) \ $(NULL) =20 -KEYPODS =3D $(KEYCODES:%=3Dutil/virkeycode-%.pod) \ - $(KEYNAMES:%=3Dutil/virkeyname-%.pod) -KEYMANS =3D $(KEYPODS:%.pod=3D%.7) - -man7_MANS +=3D $(KEYMANS) - BUILT_SOURCES +=3D $(KEYTABLES) CLEANFILES +=3D $(KEYTABLES) -CLEANFILES +=3D $(KEYMANS) $(KEYPODS) =20 UTIL_IO_HELPER_SOURCES =3D util/iohelper.c =20 @@ -323,37 +316,3 @@ util/virkeynametable_%.h: $(srcdir)/keycodemapdb/data/= keymaps.csv \ name-table --lang stdc --varname virKeyNameTable_$$NAME \ $(srcdir)/keycodemapdb/data/keymaps.csv $$NAME > $@-tmp && \ mv $@-tmp $@ || rm -f $@-tmp - -util/virkeycode-%.pod: $(srcdir)/keycodemapdb/data/keymaps.csv \ - $(srcdir)/keycodemapdb/tools/keymap-gen Makefile.am - $(AM_V_GEN)export NAME=3D`echo $@ | sed -e 's,util/virkeycode-,,' \ - -e 's,\.pod,,'` && \ - $(MKDIR_P) util/ && \ - $(RUNUTF8) $(PYTHON) $(srcdir)/keycodemapdb/tools/keymap-gen \ - code-docs --lang pod \ - --title "virkeycode-$$NAME" \ - --subtitle "Key code values for $$NAME" \ - $(srcdir)/keycodemapdb/data/keymaps.csv $$NAME > \ - $@-tmp && mv $@-tmp $@ || rm $@-tmp - -util/virkeyname-%.pod: $(srcdir)/keycodemapdb/data/keymaps.csv \ - $(srcdir)/keycodemapdb/tools/keymap-gen Makefile.am - $(AM_V_GEN)export NAME=3D`echo $@ | sed -e 's,util/virkeyname-,,' \ - -e 's,\.pod,,'` && \ - $(MKDIR_P) util/ && \ - $(RUNUTF8) $(PYTHON) $(srcdir)/keycodemapdb/tools/keymap-gen \ - name-docs --lang pod \ - --title "virkeyname-$$NAME" \ - --subtitle "Key name values for $$NAME" \ - $(srcdir)/keycodemapdb/data/keymaps.csv $$NAME > \ - $@-tmp && mv $@-tmp $@ || rm $@-tmp - -util/virkey%.7: util/virkey%.pod - $(AM_V_GEN)$(POD2MAN) --section=3D7 $< $@-t1 && \ - if grep 'POD ERROR' $@-t1; then rm $@-t1; exit 1; fi && \ - sed \ - -e 's|SYSCONFDIR|\@sysconfdir\@|g' \ - -e 's|LOCALSTATEDIR|\@localstatedir\@|g' \ - < $@-t1 > $@-t2 && \ - rm -f $@-t1 && \ - mv $@-t2 $@ --=20 2.23.0 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list