From nobody Sun May 5 19:46:12 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 1548342882675322.04427476479304; Thu, 24 Jan 2019 07:14:42 -0800 (PST) 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 mx1.redhat.com (Postfix) with ESMTPS id E1702C05D274; Thu, 24 Jan 2019 15:14:32 +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 2455A6047F; Thu, 24 Jan 2019 15:14:32 +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 BF8753F5CB; Thu, 24 Jan 2019 15:14:29 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id x0OEhJsO031042 for ; Thu, 24 Jan 2019 09:43:19 -0500 Received: by smtp.corp.redhat.com (Postfix) id AF1E61042557; Thu, 24 Jan 2019 14:43:19 +0000 (UTC) Received: from angien.brq.redhat.com (unknown [10.43.2.229]) by smtp.corp.redhat.com (Postfix) with ESMTP id 35E6210021B1 for ; Thu, 24 Jan 2019 14:43:16 +0000 (UTC) From: Peter Krempa To: libvir-list@redhat.com Date: Thu, 24 Jan 2019 15:43:15 +0100 Message-Id: <804c2654cbe6fa7e6881de0b03b49ca629255ac8.1548340995.git.pkrempa@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22 X-loop: libvir-list@redhat.com Subject: [libvirt] [PATCH] docs: Format bit shift notation for bitwise flag enums 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: , Content-Transfer-Encoding: quoted-printable 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-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.31]); Thu, 24 Jan 2019 15:14:34 +0000 (UTC) Content-Type: text/plain; charset="utf-8" Big number itself does not make much sense in some cases. Format the bitshift format as well. Changes our web page docs from: VIR_MIGRATE_POSTCOPY =3D 32768 : Setting the VIR_MIGRATE_POSTCOPY... VIR_MIGRATE_TLS =3D 65536 : Setting the VIR_MIGRATE_TLS flag... to: VIR_MIGRATE_POSTCOPY =3D 32768 (1<<15) : Setting the VIR_MIGRATE_POSTCOPY... VIR_MIGRATE_TLS =3D 65536 (1<<16) : Setting the VIR_MIGRATE_TLS flag... Signed-off-by: Peter Krempa Reviewed-by: John Ferlan --- docs/apibuild.py | 4 ++++ docs/libvirt.css | 4 ++++ docs/newapi.xsl | 15 +++++++++++++-- 3 files changed, 21 insertions(+), 2 deletions(-) diff --git a/docs/apibuild.py b/docs/apibuild.py index 3ef5d0f554..a57f995189 100755 --- a/docs/apibuild.py +++ b/docs/apibuild.py @@ -2123,6 +2123,10 @@ class docBuilder: except: val =3D info[0] output.write(" value=3D'%s'" % (val)) + valuestr =3D re.sub("<", "<", info[0]) + valuestr =3D re.sub("[\(\)]", "", valuestr) + output.write(" valuestr=3D'%s'" % valuestr) + if info[2] is not None and info[2] !=3D '': output.write(" type=3D'%s'" % info[2]) if info[1] is not None and info[1] !=3D '': diff --git a/docs/libvirt.css b/docs/libvirt.css index e590b33cfb..c5fe27fa3f 100644 --- a/docs/libvirt.css +++ b/docs/libvirt.css @@ -537,3 +537,7 @@ dl.mail dt a:hover { color: rgb(255, 230, 0); text-decoration: none; } + +td.enumvalue { + white-space: nowrap; +} diff --git a/docs/newapi.xsl b/docs/newapi.xsl index 8d4c032c03..0a3658c9a5 100644 --- a/docs/newapi.xsl +++ b/docs/newapi.xsl @@ -288,6 +288,17 @@ + + + + + + ( + + ) + + +

<= /a>

@@ -306,7 +317,7 @@ =3D - +
@@ -316,7 +327,7 @@ - + --=20 2.20.1 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list