From nobody Sun May 19 19:40:26 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1636119361175724.4935154870504; Fri, 5 Nov 2021 06:36:01 -0700 (PDT) Received: from localhost ([::1]:39708 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mizNw-0000Iy-0S for importer@patchew.org; Fri, 05 Nov 2021 09:36:00 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:54278) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mizL9-0005wV-Pk for qemu-devel@nongnu.org; Fri, 05 Nov 2021 09:33:08 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:47177) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mizL5-0006lE-L3 for qemu-devel@nongnu.org; Fri, 05 Nov 2021 09:33:06 -0400 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-288-s7jgni3FNF2-z_NIgIjfYw-1; Fri, 05 Nov 2021 09:32:35 -0400 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 70C3F100CCC8; Fri, 5 Nov 2021 13:32:33 +0000 (UTC) Received: from localhost (unknown [10.39.208.24]) by smtp.corp.redhat.com (Postfix) with ESMTP id DC25A60FFD; Fri, 5 Nov 2021 13:32:31 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1636119183; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=IPyqCrxhN/c0hWzf+ls7+Sg9Q/olMxoUjg3H47163bQ=; b=Ad76vHhDgshFo+L9bDu+XzyeF0VXz/6E0z41LMvSQeIiPpptaw7paNPd6nA/MPd7SIYgEV njgVfY+1nL37WQAPOWOgcq5cmhBH1IkEX+ePJU2lKJSsrkr0qj5JtDtGnO/a/gzo4itU5W GBrqKfjkY64IFOSQfdmDLeBCsYzruCY= X-MC-Unique: s7jgni3FNF2-z_NIgIjfYw-1 From: marcandre.lureau@redhat.com To: qemu-devel@nongnu.org Subject: [PULL 01/11] docs/sphinx: add loaded modules to generated depfile Date: Fri, 5 Nov 2021 17:32:12 +0400 Message-Id: <20211105133222.184722-2-marcandre.lureau@redhat.com> In-Reply-To: <20211105133222.184722-1-marcandre.lureau@redhat.com> References: <20211105133222.184722-1-marcandre.lureau@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=marcandre.lureau@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=216.205.24.124; envelope-from=marcandre.lureau@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -33 X-Spam_score: -3.4 X-Spam_bar: --- X-Spam_report: (-3.4 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.648, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: John Snow , Peter Maydell , Richard Henderson , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1636119362178100001 From: Marc-Andr=C3=A9 Lureau Signed-off-by: Marc-Andr=C3=A9 Lureau Reviewed-by: John Snow Reviewed-by: Paolo Bonzini --- docs/sphinx/depfile.py | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/depfile.py b/docs/sphinx/depfile.py index 277fdf0f5680..b6fb926df11d 100644 --- a/docs/sphinx/depfile.py +++ b/docs/sphinx/depfile.py @@ -12,6 +12,7 @@ =20 import os import sphinx +import sys =20 __version__ =3D '1.0' =20 @@ -20,8 +21,17 @@ def get_infiles(env): yield env.doc2path(x) yield from ((os.path.join(env.srcdir, dep) for dep in env.dependencies[x])) + for mod in sys.modules.values(): + if hasattr(mod, '__file__'): + if mod.__file__: + yield mod.__file__ =20 -def write_depfile(app, env): + +def write_depfile(app, exception): + if exception: + return + + env =3D app.env if not env.config.depfile: return =20 @@ -42,7 +52,7 @@ def write_depfile(app, env): def setup(app): app.add_config_value('depfile', None, 'env') app.add_config_value('depfile_stamp', None, 'env') - app.connect('env-updated', write_depfile) + app.connect('build-finished', write_depfile) =20 return dict( version =3D __version__, --=20 2.33.0.721.g106298f7f9 From nobody Sun May 19 19:40:26 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1636119318950295.1339303151576; Fri, 5 Nov 2021 06:35:18 -0700 (PDT) Received: from localhost ([::1]:39158 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mizNF-0008My-RR for importer@patchew.org; Fri, 05 Nov 2021 09:35:17 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:54228) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mizKq-0005bE-S6 for qemu-devel@nongnu.org; Fri, 05 Nov 2021 09:32:48 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]:27672) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mizKp-00068C-1S for qemu-devel@nongnu.org; Fri, 05 Nov 2021 09:32:48 -0400 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-88-ADEML3ecMwOmsMAybEQYYg-1; Fri, 05 Nov 2021 09:32:40 -0400 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 7442C806694; Fri, 5 Nov 2021 13:32:39 +0000 (UTC) Received: from localhost (unknown [10.39.208.24]) by smtp.corp.redhat.com (Postfix) with ESMTP id 3CA0260C17; Fri, 5 Nov 2021 13:32:37 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1636119165; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=L4Dbpe9joMsyv00w5/56KL/pzWUB6b1iOdSGi/rDV0g=; b=a//cSt8fxHCi9PTxMyO/F2WunRNHDIavBFHMpZDf0+Rp0TSkZ9Sp6JwBoAgAre083O97zY dI6M3kaZCG0mVfXEeUdrP/rlVNqGT4U6pZnPYHc49t6xFBP6qsDQ4zeivDWoQme/xzcIPh dNbn/BCRockEkayYcZeOlc0l2Gv8hsE= X-MC-Unique: ADEML3ecMwOmsMAybEQYYg-1 From: marcandre.lureau@redhat.com To: qemu-devel@nongnu.org Subject: [PULL 02/11] docs/sphinx: add static files to generated depfile Date: Fri, 5 Nov 2021 17:32:13 +0400 Message-Id: <20211105133222.184722-3-marcandre.lureau@redhat.com> In-Reply-To: <20211105133222.184722-1-marcandre.lureau@redhat.com> References: <20211105133222.184722-1-marcandre.lureau@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=marcandre.lureau@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.133.124; envelope-from=marcandre.lureau@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -33 X-Spam_score: -3.4 X-Spam_bar: --- X-Spam_report: (-3.4 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.648, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: John Snow , Peter Maydell , Richard Henderson , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1636119319945100001 From: Marc-Andr=C3=A9 Lureau Signed-off-by: Marc-Andr=C3=A9 Lureau Reviewed-by: John Snow Reviewed-by: Paolo Bonzini --- docs/sphinx/depfile.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/sphinx/depfile.py b/docs/sphinx/depfile.py index b6fb926df11d..99539adb4892 100644 --- a/docs/sphinx/depfile.py +++ b/docs/sphinx/depfile.py @@ -13,6 +13,7 @@ import os import sphinx import sys +from pathlib import Path =20 __version__ =3D '1.0' =20 @@ -25,6 +26,10 @@ def get_infiles(env): if hasattr(mod, '__file__'): if mod.__file__: yield mod.__file__ + # this is perhaps going to include unused files: + for static_path in env.config.html_static_path: + for path in Path(static_path).rglob('*'): + yield str(path) =20 =20 def write_depfile(app, exception): --=20 2.33.0.721.g106298f7f9 From nobody Sun May 19 19:40:26 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1636119511500950.5139373469291; Fri, 5 Nov 2021 06:38:31 -0700 (PDT) Received: from localhost ([::1]:47524 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mizQM-0005di-IT for importer@patchew.org; Fri, 05 Nov 2021 09:38:30 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:54254) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mizL2-0005rd-F7 for qemu-devel@nongnu.org; Fri, 05 Nov 2021 09:33:00 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]:26230) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mizL0-0006je-Aj for qemu-devel@nongnu.org; Fri, 05 Nov 2021 09:33:00 -0400 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-125-ehi8q0v1NtqGV3q67pUV8w-1; Fri, 05 Nov 2021 09:32:54 -0400 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 534B0100CCC1; Fri, 5 Nov 2021 13:32:53 +0000 (UTC) Received: from localhost (unknown [10.39.208.24]) by smtp.corp.redhat.com (Postfix) with ESMTP id BE55819711; Fri, 5 Nov 2021 13:32:43 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1636119177; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=TDpj2YlICBL+OLHMnUabr1+5cGry17swVrdRs4yk16Y=; b=ZNWAlZy6HnH0PV1kG2/sNeaYwwUWTR4kn/6BQrJsfrV0WXVZmaUa6IjG/OQqpEraJOviBZ 4XtAVQU2Mq5ER4DdWYBxmK/+HKNtVxK9FDZWrID9+jnJHSq/Msf0L+RQ6tTGcSAY5SFEV7 DbzhNSbStTUeA8juW5XWhU2Bl7740r8= X-MC-Unique: ehi8q0v1NtqGV3q67pUV8w-1 From: marcandre.lureau@redhat.com To: qemu-devel@nongnu.org Subject: [PULL 03/11] docs/sphinx: add templates files to generated depfile Date: Fri, 5 Nov 2021 17:32:14 +0400 Message-Id: <20211105133222.184722-4-marcandre.lureau@redhat.com> In-Reply-To: <20211105133222.184722-1-marcandre.lureau@redhat.com> References: <20211105133222.184722-1-marcandre.lureau@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=marcandre.lureau@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.129.124; envelope-from=marcandre.lureau@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -33 X-Spam_score: -3.4 X-Spam_bar: --- X-Spam_report: (-3.4 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.648, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: John Snow , Peter Maydell , Richard Henderson , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1636119512204100001 From: Marc-Andr=C3=A9 Lureau Signed-off-by: Marc-Andr=C3=A9 Lureau Reviewed-by: John Snow Reviewed-by: Paolo Bonzini --- docs/conf.py | 2 +- docs/sphinx/depfile.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index ff6e92c6e2e6..edc2bf8fcba7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -74,7 +74,7 @@ extensions =3D ['kerneldoc', 'qmp_lexer', 'hxtool', 'depfile', 'qapidoc'] =20 # Add any paths that contain templates here, relative to this directory. -templates_path =3D ['_templates'] +templates_path =3D [os.path.join(qemu_docdir, '_templates')] =20 # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: diff --git a/docs/sphinx/depfile.py b/docs/sphinx/depfile.py index 99539adb4892..afdcbcec6e76 100644 --- a/docs/sphinx/depfile.py +++ b/docs/sphinx/depfile.py @@ -27,7 +27,7 @@ def get_infiles(env): if mod.__file__: yield mod.__file__ # this is perhaps going to include unused files: - for static_path in env.config.html_static_path: + for static_path in env.config.html_static_path + env.config.templates_= path: for path in Path(static_path).rglob('*'): yield str(path) =20 --=20 2.33.0.721.g106298f7f9 From nobody Sun May 19 19:40:26 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1636119387048736.1011648560152; Fri, 5 Nov 2021 06:36:27 -0700 (PDT) Received: from localhost ([::1]:40336 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mizOM-0000jK-1x for importer@patchew.org; Fri, 05 Nov 2021 09:36:26 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:54296) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mizLG-0006BB-Pw for qemu-devel@nongnu.org; Fri, 05 Nov 2021 09:33:14 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]:27217) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mizLE-0007BV-Sn for qemu-devel@nongnu.org; Fri, 05 Nov 2021 09:33:14 -0400 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-340-9Wa2JxBBPuu8THbWjZPhVw-1; Fri, 05 Nov 2021 09:32:59 -0400 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 05E4980668F; Fri, 5 Nov 2021 13:32:58 +0000 (UTC) Received: from localhost (unknown [10.39.208.24]) by smtp.corp.redhat.com (Postfix) with ESMTP id 28C1760C17; Fri, 5 Nov 2021 13:32:56 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1636119192; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=MW9ODVTqgQXtcYi0p7p+F/acStLJNpD6uYScMCV6w8M=; b=OsoKuQZrZ+e26L3RLzG57fppnvkiBXR6XP8IElHP3eZkr7Sb5sVfEuHdHoA9KzI1IHsJ11 4RgQs2PPd++7GAkOWrIVQh8mS4815iiqfZlCbhmv2vSoyrhVnG4GOYJXLnwfmEdvfa/aHM x/3bFnsoG4sPaj7EA4HupYDVM7Nzh4A= X-MC-Unique: 9Wa2JxBBPuu8THbWjZPhVw-1 From: marcandre.lureau@redhat.com To: qemu-devel@nongnu.org Subject: [PULL 04/11] tests/qapi-schema/meson: add depfile to sphinx doc Date: Fri, 5 Nov 2021 17:32:15 +0400 Message-Id: <20211105133222.184722-5-marcandre.lureau@redhat.com> In-Reply-To: <20211105133222.184722-1-marcandre.lureau@redhat.com> References: <20211105133222.184722-1-marcandre.lureau@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=marcandre.lureau@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.133.124; envelope-from=marcandre.lureau@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -33 X-Spam_score: -3.4 X-Spam_bar: --- X-Spam_report: (-3.4 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.648, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: John Snow , Peter Maydell , Richard Henderson , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1636119387443100001 From: Marc-Andr=C3=A9 Lureau Signed-off-by: Marc-Andr=C3=A9 Lureau Reviewed-by: John Snow Reviewed-by: Paolo Bonzini --- tests/qapi-schema/meson.build | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/tests/qapi-schema/meson.build b/tests/qapi-schema/meson.build index df5acfd08b6b..3676729fbb06 100644 --- a/tests/qapi-schema/meson.build +++ b/tests/qapi-schema/meson.build @@ -238,10 +238,11 @@ if build_docs # fuzzy comparison if future Sphinx versions produce different text, # but for now the simple comparison suffices. qapi_doc_out =3D custom_target('QAPI rST doc', - output: ['doc-good.txt'], + output: ['doc-good.txt', 'doc-good.stamp'], input: files('doc-good.json', 'doc-good.rst= '), build_by_default: true, depend_files: sphinx_extn_depends, + depfile: 'docs.d', # We use -E to suppress Sphinx's caching, b= ecause # we want it to always really run the QAPI = doc # generation code. It also means we don't @@ -250,6 +251,8 @@ if build_docs '-b', 'text', '-E', '-c', meson.project_source_root()= / 'docs', '-D', 'master_doc=3Ddoc-good', + '-Ddepfile=3D@DEPFILE@', + '-Ddepfile_stamp=3D@OUTPUT1@', meson.current_source_dir(), meson.current_build_dir()]) =20 --=20 2.33.0.721.g106298f7f9 From nobody Sun May 19 19:40:26 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1636119767983786.7522042073024; Fri, 5 Nov 2021 06:42:47 -0700 (PDT) Received: from localhost ([::1]:55164 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mizUU-0002Wn-Rl for importer@patchew.org; Fri, 05 Nov 2021 09:42:46 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:54448) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mizLe-0007HU-B6 for qemu-devel@nongnu.org; Fri, 05 Nov 2021 09:33:38 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]:59591) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mizLb-0008GB-8g for qemu-devel@nongnu.org; Fri, 05 Nov 2021 09:33:36 -0400 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-96-s03LVsyXP_Oyd-ER_d9XwQ-1; Fri, 05 Nov 2021 09:33:30 -0400 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 C590B100CCCF; Fri, 5 Nov 2021 13:33:13 +0000 (UTC) Received: from localhost (unknown [10.39.208.24]) by smtp.corp.redhat.com (Postfix) with ESMTP id 8182A5DEFA; Fri, 5 Nov 2021 13:33:01 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1636119214; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=IUGyp1bFRh4m5FZfvaEWgonOqz1uBSAsiDtklz5Cd48=; b=ObD9gc9C43k5yc1Rq26I0ZWcKVGQngmPfRiRqhhDeEO5Y5Wmj3QGsDFySn5iBwDNMf8Eao kcMWpXyZhyOL03YVlcf92fkI+Z9bHTVj+l5pbvsKBKwp1dJxbdMtNBUjIvGsi6TV6B3I4J NF0W7/R7vFkOuoXj3YQsz7J0JDfx9cY= X-MC-Unique: s03LVsyXP_Oyd-ER_d9XwQ-1 From: marcandre.lureau@redhat.com To: qemu-devel@nongnu.org Subject: [PULL 05/11] meson: drop sphinx_extn_depends Date: Fri, 5 Nov 2021 17:32:16 +0400 Message-Id: <20211105133222.184722-6-marcandre.lureau@redhat.com> In-Reply-To: <20211105133222.184722-1-marcandre.lureau@redhat.com> References: <20211105133222.184722-1-marcandre.lureau@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=marcandre.lureau@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.133.124; envelope-from=marcandre.lureau@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -33 X-Spam_score: -3.4 X-Spam_bar: --- X-Spam_report: (-3.4 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.648, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: John Snow , Peter Maydell , Richard Henderson , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1636119770037100001 From: Marc-Andr=C3=A9 Lureau Module dependencies is now handled by depfile.py. Signed-off-by: Marc-Andr=C3=A9 Lureau Reviewed-by: John Snow Reviewed-by: Paolo Bonzini --- docs/meson.build | 9 +-------- tests/qapi-schema/meson.build | 1 - 2 files changed, 1 insertion(+), 9 deletions(-) diff --git a/docs/meson.build b/docs/meson.build index 19cce670a20d..34fda6853d9e 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -37,13 +37,6 @@ endif if build_docs SPHINX_ARGS +=3D ['-Dversion=3D' + meson.project_version(), '-Drelease= =3D' + config_host['PKGVERSION']] =20 - sphinx_extn_depends =3D [ meson.current_source_dir() / 'sphinx/depfile.p= y', - meson.current_source_dir() / 'sphinx/hxtool.py', - meson.current_source_dir() / 'sphinx/kerneldoc.p= y', - meson.current_source_dir() / 'sphinx/kernellog.p= y', - meson.current_source_dir() / 'sphinx/qapidoc.py', - meson.current_source_dir() / 'sphinx/qmp_lexer.p= y', - qapi_gen_depends ] sphinx_template_files =3D [ meson.project_source_root() / 'docs/_templat= es/footer.html' ] =20 have_ga =3D have_tools and config_host.has_key('CONFIG_GUEST_AGENT') @@ -77,7 +70,7 @@ if build_docs output: 'docs.stamp', input: files('conf.py'), depfile: 'docs.d', - depend_files: [ sphinx_extn_depends, sphinx_template_files= ], + depend_files: [ sphinx_template_files ], command: [SPHINX_ARGS, '-Ddepfile=3D@DEPFILE@', '-Ddepfile_stamp=3D@OUTPUT0@', '-b', 'html', '-d', private_dir, diff --git a/tests/qapi-schema/meson.build b/tests/qapi-schema/meson.build index 3676729fbb06..e505bf709ad3 100644 --- a/tests/qapi-schema/meson.build +++ b/tests/qapi-schema/meson.build @@ -241,7 +241,6 @@ if build_docs output: ['doc-good.txt', 'doc-good.stamp'], input: files('doc-good.json', 'doc-good.rst= '), build_by_default: true, - depend_files: sphinx_extn_depends, depfile: 'docs.d', # We use -E to suppress Sphinx's caching, b= ecause # we want it to always really run the QAPI = doc --=20 2.33.0.721.g106298f7f9 From nobody Sun May 19 19:40:26 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1636119549881166.71565018534056; Fri, 5 Nov 2021 06:39:09 -0700 (PDT) Received: from localhost ([::1]:49148 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mizQy-0006kN-Ti for importer@patchew.org; Fri, 05 Nov 2021 09:39:08 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:54420) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mizLV-0006uK-JE for qemu-devel@nongnu.org; Fri, 05 Nov 2021 09:33:29 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]:41184) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mizLT-00089L-DN for qemu-devel@nongnu.org; Fri, 05 Nov 2021 09:33:29 -0400 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-49-By6Hif7YPfuvIlkiXD6Zhw-1; Fri, 05 Nov 2021 09:33:24 -0400 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 05FA887504C; Fri, 5 Nov 2021 13:33:23 +0000 (UTC) Received: from localhost (unknown [10.39.208.24]) by smtp.corp.redhat.com (Postfix) with ESMTP id 030095F4EC; Fri, 5 Nov 2021 13:33:17 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1636119206; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=eFuNYvfu1xuFGAdpNEqcj9GR4by1GDQBCYjgTlDla38=; b=JgsnBB6TKIBZNnjRBSC7aJ5dxz4+L1Xvt1iWXH7I99GwbGpibB8n7e1W3be0nnARr+V0tt mSdsxJhXu4bMjQ8qmtVVrLo28EMJe7CBVQ82mShVj6JvyXNAP8Gcb7Cx86Ag02TC/E6+Ik 8q0penVarCEBJYpulDskFKmyecr/lkA= X-MC-Unique: By6Hif7YPfuvIlkiXD6Zhw-1 From: marcandre.lureau@redhat.com To: qemu-devel@nongnu.org Subject: [PULL 06/11] meson: drop sphinx_template_files Date: Fri, 5 Nov 2021 17:32:17 +0400 Message-Id: <20211105133222.184722-7-marcandre.lureau@redhat.com> In-Reply-To: <20211105133222.184722-1-marcandre.lureau@redhat.com> References: <20211105133222.184722-1-marcandre.lureau@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=marcandre.lureau@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.129.124; envelope-from=marcandre.lureau@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -33 X-Spam_score: -3.4 X-Spam_bar: --- X-Spam_report: (-3.4 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.648, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: John Snow , Peter Maydell , Richard Henderson , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1636119550715100001 From: Marc-Andr=C3=A9 Lureau Static files dependencies is now handled by depfile.py. Signed-off-by: Marc-Andr=C3=A9 Lureau Reviewed-by: John Snow Reviewed-by: Paolo Bonzini --- docs/meson.build | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/meson.build b/docs/meson.build index 34fda6853d9e..27c6e156fff8 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -37,8 +37,6 @@ endif if build_docs SPHINX_ARGS +=3D ['-Dversion=3D' + meson.project_version(), '-Drelease= =3D' + config_host['PKGVERSION']] =20 - sphinx_template_files =3D [ meson.project_source_root() / 'docs/_templat= es/footer.html' ] - have_ga =3D have_tools and config_host.has_key('CONFIG_GUEST_AGENT') =20 man_pages =3D { @@ -70,7 +68,6 @@ if build_docs output: 'docs.stamp', input: files('conf.py'), depfile: 'docs.d', - depend_files: [ sphinx_template_files ], command: [SPHINX_ARGS, '-Ddepfile=3D@DEPFILE@', '-Ddepfile_stamp=3D@OUTPUT0@', '-b', 'html', '-d', private_dir, --=20 2.33.0.721.g106298f7f9 From nobody Sun May 19 19:40:26 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 16361197728321013.9593253953773; Fri, 5 Nov 2021 06:42:52 -0700 (PDT) Received: from localhost ([::1]:55448 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mizUZ-0002jk-MG for importer@patchew.org; Fri, 05 Nov 2021 09:42:51 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:54474) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mizLg-0007LE-F4 for qemu-devel@nongnu.org; Fri, 05 Nov 2021 09:33:40 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]:32781) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mizLc-0008Jg-F4 for qemu-devel@nongnu.org; Fri, 05 Nov 2021 09:33:40 -0400 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-246-regdj_CINzqBdUIWtSNFVw-1; Fri, 05 Nov 2021 09:33:33 -0400 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id D1FD39126B; Fri, 5 Nov 2021 13:33:32 +0000 (UTC) Received: from localhost (unknown [10.39.208.24]) by smtp.corp.redhat.com (Postfix) with ESMTP id 9C87819C79; Fri, 5 Nov 2021 13:33:27 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1636119215; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=+xpRJAHG8yNNa6bB1HoJUN6+5u1Fhoz4/fzXWVz4r9M=; b=JHqWDg91MGW3NqrhwSN9tLx9AK5qSBQxCKQMo7mPFWJ8yf0oWcfsDuTQIWsMhVFgI2Cij4 f975WcjPvkz+h37+lDJPZCe12DV8NL2qkgaR7jPtKvGuqaYLazBQ8Che+ZjkhNRfnWOnnE daF8VBN3P0vmBF2maGa4bT/aNgN9wWM= X-MC-Unique: regdj_CINzqBdUIWtSNFVw-1 From: marcandre.lureau@redhat.com To: qemu-devel@nongnu.org Subject: [PULL 07/11] docs/sphinx: set navigation_with_keys=True Date: Fri, 5 Nov 2021 17:32:18 +0400 Message-Id: <20211105133222.184722-8-marcandre.lureau@redhat.com> In-Reply-To: <20211105133222.184722-1-marcandre.lureau@redhat.com> References: <20211105133222.184722-1-marcandre.lureau@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=marcandre.lureau@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.133.124; envelope-from=marcandre.lureau@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -33 X-Spam_score: -3.4 X-Spam_bar: --- X-Spam_report: (-3.4 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.648, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: John Snow , Peter Maydell , Richard Henderson , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1636119774547100001 From: Marc-Andr=C3=A9 Lureau Allow navigating to the previous/next page using the keyboard's left and right arrows. I wish this would be the default, and that the themes would provide more key navigation, but that doesn't seem on the roadmap. Signed-off-by: Marc-Andr=C3=A9 Lureau Reviewed-by: John Snow Reviewed-by: Paolo Bonzini --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/conf.py b/docs/conf.py index edc2bf8fcba7..f536483bc3d5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -166,6 +166,7 @@ if LooseVersion(sphinx_rtd_theme.__version__) >=3D LooseVersion("0.4.3"): html_theme_options =3D { "style_nav_header_background": "#802400", + "navigation_with_keys": True, } =20 html_logo =3D os.path.join(qemu_docdir, "../ui/icons/qemu_128x128.png") --=20 2.33.0.721.g106298f7f9 From nobody Sun May 19 19:40:26 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1636119993444823.115886020853; Fri, 5 Nov 2021 06:46:33 -0700 (PDT) Received: from localhost ([::1]:33900 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mizY8-0007It-B8 for importer@patchew.org; Fri, 05 Nov 2021 09:46:32 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:54546) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mizLt-0007hh-0O for qemu-devel@nongnu.org; Fri, 05 Nov 2021 09:33:59 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:38803) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mizLr-000198-Lh for qemu-devel@nongnu.org; Fri, 05 Nov 2021 09:33:52 -0400 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-517-0o4SCp1SMLyzaZPlzWmTKw-1; Fri, 05 Nov 2021 09:33:49 -0400 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 502AC875048; Fri, 5 Nov 2021 13:33:45 +0000 (UTC) Received: from localhost (unknown [10.39.208.24]) by smtp.corp.redhat.com (Postfix) with ESMTP id EAE9060C17; Fri, 5 Nov 2021 13:33:36 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1636119231; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=vXCQEoApqaksXfro1WHTSuYwZpITFwX8D1pEIqEVdtc=; b=hhjXDAXOAYNicVzTklijhLLKg9HqXNT8agS/l8UjnSgqqVePvR569Y7EtWC61ZLwI4FZw1 z+qi+18+RBueXU//LcCFIh5UD1C+rfSJkD2WPyafXs64DPF3wF3WkmeO21HVsRyjKY09uZ 7LYHE/QF+WcfzX4GUb6PnRa7/Ihm8k4= X-MC-Unique: 0o4SCp1SMLyzaZPlzWmTKw-1 From: marcandre.lureau@redhat.com To: qemu-devel@nongnu.org Subject: [PULL 08/11] docs/sphinx: add 's' keyboard binding to focus search Date: Fri, 5 Nov 2021 17:32:19 +0400 Message-Id: <20211105133222.184722-9-marcandre.lureau@redhat.com> In-Reply-To: <20211105133222.184722-1-marcandre.lureau@redhat.com> References: <20211105133222.184722-1-marcandre.lureau@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=marcandre.lureau@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=216.205.24.124; envelope-from=marcandre.lureau@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -33 X-Spam_score: -3.4 X-Spam_bar: --- X-Spam_report: (-3.4 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.648, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: John Snow , Peter Maydell , Richard Henderson , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1636119994677100001 From: Marc-Andr=C3=A9 Lureau This is pretty ubiquitous. ('/' is already taken by some browsers for quick search) Signed-off-by: Marc-Andr=C3=A9 Lureau Reviewed-by: John Snow Reviewed-by: Paolo Bonzini --- docs/conf.py | 4 ++++ docs/sphinx-static/custom.js | 9 +++++++++ 2 files changed, 13 insertions(+) create mode 100644 docs/sphinx-static/custom.js diff --git a/docs/conf.py b/docs/conf.py index f536483bc3d5..3161b8b127c6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -182,6 +182,10 @@ 'theme_overrides.css', ] =20 +html_js_files =3D [ + 'custom.js', +] + html_context =3D { "display_gitlab": True, "gitlab_user": "qemu-project", diff --git a/docs/sphinx-static/custom.js b/docs/sphinx-static/custom.js new file mode 100644 index 000000000000..71a86053051b --- /dev/null +++ b/docs/sphinx-static/custom.js @@ -0,0 +1,9 @@ +document.addEventListener('keydown', (event) =3D> { + // find a better way to look it up? + let search_input =3D document.getElementsByName('q')[0]; + + if (event.code =3D=3D=3D 'KeyS' && document.activeElement !=3D=3D sear= ch_input) { + event.preventDefault(); + search_input.focus(); + } +}); --=20 2.33.0.721.g106298f7f9 From nobody Sun May 19 19:40:26 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1636120230362968.2814253537606; Fri, 5 Nov 2021 06:50:30 -0700 (PDT) Received: from localhost ([::1]:42140 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mizbw-0004gD-Ue for importer@patchew.org; Fri, 05 Nov 2021 09:50:28 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:54568) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mizLy-0007i9-Fe for qemu-devel@nongnu.org; Fri, 05 Nov 2021 09:33:59 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]:24606) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mizLw-0001RQ-45 for qemu-devel@nongnu.org; Fri, 05 Nov 2021 09:33:58 -0400 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-120-9KgtaqbIPmWFHERwWNPIwg-1; Fri, 05 Nov 2021 09:33:51 -0400 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id EF60D112B8D5; Fri, 5 Nov 2021 13:33:50 +0000 (UTC) Received: from localhost (unknown [10.39.208.24]) by smtp.corp.redhat.com (Postfix) with ESMTP id 891925FC13; Fri, 5 Nov 2021 13:33:49 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1636119235; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=GvqT5RX8XrTCakxUrMOv3JoHcoZ4N7vOMJK4HDTaeEk=; b=HJNmSTjh/02V6axbXofr5/QAKr2gsB014GHWLMzmllLKEjQJ3rrmO6T04lup54pn5jQED+ NvY6tcbaDZUytNQ1VTJrRbn58FerIVmz0Im+NAg6AAwc1/vVERUbA3FKFO+vmlmjn9nr96 KqBktulGZ9xfK6RTDEQZ4CvvlLX1dYA= X-MC-Unique: 9KgtaqbIPmWFHERwWNPIwg-1 From: marcandre.lureau@redhat.com To: qemu-devel@nongnu.org Subject: [PULL 09/11] docs: remove non-reference uses of single backticks Date: Fri, 5 Nov 2021 17:32:20 +0400 Message-Id: <20211105133222.184722-10-marcandre.lureau@redhat.com> In-Reply-To: <20211105133222.184722-1-marcandre.lureau@redhat.com> References: <20211105133222.184722-1-marcandre.lureau@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=marcandre.lureau@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.133.124; envelope-from=marcandre.lureau@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -33 X-Spam_score: -3.4 X-Spam_bar: --- X-Spam_report: (-3.4 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.648, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: John Snow , Peter Maydell , Richard Henderson Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1636120231686100001 Content-Type: text/plain; charset="utf-8" From: John Snow The single backtick markup in ReST is the "default role". Currently, Sphinx's default role is called "content". Sphinx suggests you can use the "Any" role instead to turn any single-backtick enclosed item into a cross-reference. This is useful for things like autodoc for Python docstrings, where it's often nicer to reference other types with `foo` instead of the more laborious :py:meth:`foo`. It's also useful in multi-domain cases to easily reference definitions from other Sphinx domains, such as referencing C code definitions from outside of kerneldoc comments. Before we do that, though, we'll need to turn all existing usages of the "content" role to inline verbatim markup wherever it does not correctly resolve into a cross-refernece by using double backticks instead. Signed-off-by: John Snow Reviewed-by: Eduardo Habkost Reviewed-by: Alexander Bulekov Message-Id: <20211004215238.1523082-2-jsnow@redhat.com> --- docs/devel/fuzzing.rst | 9 +++++---- docs/devel/tcg-plugins.rst | 2 +- docs/interop/live-block-operations.rst | 2 +- docs/system/guest-loader.rst | 2 +- qapi/block-core.json | 4 ++-- include/qemu/module.h | 6 +++--- qemu-options.hx | 4 ++-- 7 files changed, 15 insertions(+), 14 deletions(-) diff --git a/docs/devel/fuzzing.rst b/docs/devel/fuzzing.rst index 2749bb9bed36..784ecb99e667 100644 --- a/docs/devel/fuzzing.rst +++ b/docs/devel/fuzzing.rst @@ -182,10 +182,11 @@ The output should contain a complete list of matched = MemoryRegions. =20 OSS-Fuzz -------- -QEMU is continuously fuzzed on `OSS-Fuzz` __(https://github.com/google/oss= -fuzz). -By default, the OSS-Fuzz build will try to fuzz every fuzz-target. Since t= he -generic-fuzz target requires additional information provided in environment -variables, we pre-define some generic-fuzz configs in +QEMU is continuously fuzzed on `OSS-Fuzz +`_. By default, the OSS-Fuzz build +will try to fuzz every fuzz-target. Since the generic-fuzz target +requires additional information provided in environment variables, we +pre-define some generic-fuzz configs in ``tests/qtest/fuzz/generic_fuzz_configs.h``. Each config must specify: =20 - ``.name``: To identify the fuzzer config diff --git a/docs/devel/tcg-plugins.rst b/docs/devel/tcg-plugins.rst index 59a7d838bee3..f93ef4fe52a4 100644 --- a/docs/devel/tcg-plugins.rst +++ b/docs/devel/tcg-plugins.rst @@ -211,7 +211,7 @@ The hotpages plugin can be configured using the followi= ng arguments: =20 This is an instruction classifier so can be used to count different types of instructions. It has a number of options to refine which get -counted. You can give a value to the `count` argument for a class of +counted. You can give a value to the ``count`` argument for a class of instructions to break it down fully, so for example to see all the system registers accesses:: =20 diff --git a/docs/interop/live-block-operations.rst b/docs/interop/live-blo= ck-operations.rst index 9e3635b23386..814c29bbe1df 100644 --- a/docs/interop/live-block-operations.rst +++ b/docs/interop/live-block-operations.rst @@ -640,7 +640,7 @@ at this point: (QEMU) block-job-complete device=3Djob0 =20 In either of the above cases, if you once again run the -`query-block-jobs` command, there should not be any active block +``query-block-jobs`` command, there should not be any active block operation. =20 Comparing 'commit' and 'mirror': In both then cases, the overlay images diff --git a/docs/system/guest-loader.rst b/docs/system/guest-loader.rst index 4320d1183f73..9ef9776bf07b 100644 --- a/docs/system/guest-loader.rst +++ b/docs/system/guest-loader.rst @@ -51,4 +51,4 @@ The full syntax of the guest-loader is:: =20 ``bootargs=3D`` This is an optional field for kernel blobs which will pass command - like via the `/chosen/module@/bootargs` node. + like via the ``/chosen/module@/bootargs`` node. diff --git a/qapi/block-core.json b/qapi/block-core.json index b290782bf280..33e8507d1035 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -491,11 +491,11 @@ # @granularity: granularity of the dirty bitmap in bytes (since 1.4) # # @recording: true if the bitmap is recording new writes from the guest. -# Replaces `active` and `disabled` statuses. (since 4.0) +# Replaces ``active`` and ``disabled`` statuses. (since 4.0) # # @busy: true if the bitmap is in-use by some operation (NBD or jobs) # and cannot be modified via QMP or used by another operation. -# Replaces `locked` and `frozen` statuses. (since 4.0) +# Replaces ``locked`` and ``frozen`` statuses. (since 4.0) # # @persistent: true if the bitmap was stored on disk, is scheduled to be s= tored # on disk, or both. (since 4.0) diff --git a/include/qemu/module.h b/include/qemu/module.h index 3deac0078b9d..5fcc323b2a79 100644 --- a/include/qemu/module.h +++ b/include/qemu/module.h @@ -77,14 +77,14 @@ void module_allow_arch(const char *arch); /** * DOC: module info annotation macros * - * `scripts/modinfo-collect.py` will collect module info, + * ``scripts/modinfo-collect.py`` will collect module info, * using the preprocessor and -DQEMU_MODINFO. * - * `scripts/modinfo-generate.py` will create a module meta-data database + * ``scripts/modinfo-generate.py`` will create a module meta-data database * from the collected information so qemu knows about module * dependencies and QOM objects implemented by modules. * - * See `*.modinfo` and `modinfo.c` in the build directory to check the + * See ``*.modinfo`` and ``modinfo.c`` in the build directory to check the * script results. */ #ifdef QEMU_MODINFO diff --git a/qemu-options.hx b/qemu-options.hx index f051536b630f..7749f59300b5 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -1895,8 +1895,8 @@ SRST Valid parameters are: =20 ``grab-mod=3D`` : Used to select the modifier keys for toggl= ing - the mouse grabbing in conjunction with the "g" key. `` can be - either `lshift-lctrl-lalt` or `rctrl`. + the mouse grabbing in conjunction with the "g" key. ```` can= be + either ``lshift-lctrl-lalt`` or ``rctrl``. =20 ``alt_grab=3Don|off`` : Use Control+Alt+Shift-g to toggle mouse gr= abbing. This parameter is deprecated - use ``grab-mod`` instead. --=20 2.33.0.721.g106298f7f9 From nobody Sun May 19 19:40:26 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1636119620474793.7777644750926; Fri, 5 Nov 2021 06:40:20 -0700 (PDT) Received: from localhost ([::1]:50450 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mizS6-0007ap-Hw for importer@patchew.org; Fri, 05 Nov 2021 09:40:18 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:54584) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mizM5-0007nu-9j for qemu-devel@nongnu.org; Fri, 05 Nov 2021 09:34:05 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:60794) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mizM3-0001qy-N0 for qemu-devel@nongnu.org; Fri, 05 Nov 2021 09:34:05 -0400 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-305-mdWPmE-VPfSLKpA-uREyLA-1; Fri, 05 Nov 2021 09:33:59 -0400 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 63CDD875054; Fri, 5 Nov 2021 13:33:56 +0000 (UTC) Received: from localhost (unknown [10.39.208.24]) by smtp.corp.redhat.com (Postfix) with ESMTP id 0DB2A60C17; Fri, 5 Nov 2021 13:33:54 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1636119242; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=uaiDoJgOQGQvis10bJGSk5/g9IeVC9PME07gxiv+5oY=; b=ETFrEKL5jBj/mg347XJmGUL+xc9iMhsS2Mq75jRzDLFvxDaF67M46Pzya53RRj5OtLWALV THaRI/pUn7p8lw+cWJZW+cKvYnVEOwzpygNvB/wb8fnj6MMwHaUw7diD01ZpB8E3gAxKYF z0qppNsZcTQyQzbhsPEp7IY7QuQJdnU= X-MC-Unique: mdWPmE-VPfSLKpA-uREyLA-1 From: marcandre.lureau@redhat.com To: qemu-devel@nongnu.org Subject: [PULL 10/11] docs: (further) remove non-reference uses of single backticks Date: Fri, 5 Nov 2021 17:32:21 +0400 Message-Id: <20211105133222.184722-11-marcandre.lureau@redhat.com> In-Reply-To: <20211105133222.184722-1-marcandre.lureau@redhat.com> References: <20211105133222.184722-1-marcandre.lureau@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=marcandre.lureau@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=216.205.24.124; envelope-from=marcandre.lureau@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -33 X-Spam_score: -3.4 X-Spam_bar: --- X-Spam_report: (-3.4 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.648, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: John Snow , Peter Maydell , Richard Henderson , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1636119622604100001 From: John Snow The series rotted already. Here's the new changes. Signed-off-by: John Snow Reviewed-by: Damien Hedde [ extra backticks fixes ] Signed-off-by: Marc-Andr=C3=A9 Lureau Message-Id: <20211004215238.1523082-3-jsnow@redhat.com> --- docs/devel/build-system.rst | 16 ++++++++-------- docs/system/i386/sgx.rst | 6 +++--- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/devel/build-system.rst b/docs/devel/build-system.rst index 7f106d2f1c2f..ae536ef75db4 100644 --- a/docs/devel/build-system.rst +++ b/docs/devel/build-system.rst @@ -47,14 +47,14 @@ command line options for which a same-named Meson optio= n exists; dashes in the command line are replaced with underscores. =20 Many checks on the compilation environment are still found in configure -rather than `meson.build`, but new checks should be added directly to -`meson.build`. +rather than ``meson.build``, but new checks should be added directly to +``meson.build``. =20 Patches are also welcome to move existing checks from the configure -phase to `meson.build`. When doing so, ensure that `meson.build` does -not use anymore the keys that you have removed from `config-host.mak`. -Typically these will be replaced in `meson.build` by boolean variables, -``get_option('optname')`` invocations, or `dep.found()` expressions. +phase to ``meson.build``. When doing so, ensure that ``meson.build`` does +not use anymore the keys that you have removed from ``config-host.mak``. +Typically these will be replaced in ``meson.build`` by boolean variables, +``get_option('optname')`` invocations, or ``dep.found()`` expressions. In general, the remaining checks have little or no interdependencies, so they can be moved one by one. =20 @@ -298,7 +298,7 @@ comprises the following tasks: =20 - Add code to perform the actual feature check. =20 - - Add code to include the feature status in `config-host.h` + - Add code to include the feature status in ``config-host.h`` =20 - Add code to print out the feature status in the configure summary upon completion. @@ -334,7 +334,7 @@ The other supporting code is generally simple:: =20 For the configure script to parse the new option, the ``scripts/meson-buildoptions.sh`` file must be up-to-date; ``make -update-buildoptions`` (or just `make`) will take care of updating it. +update-buildoptions`` (or just ``make``) will take care of updating it. =20 =20 Support scripts diff --git a/docs/system/i386/sgx.rst b/docs/system/i386/sgx.rst index f103ae2a2fdd..9aa161af1a13 100644 --- a/docs/system/i386/sgx.rst +++ b/docs/system/i386/sgx.rst @@ -77,9 +77,9 @@ CPUID =20 Due to its myriad dependencies, SGX is currently not listed as supported in any of Qemu's built-in CPU configuration. To expose SGX (and SGX Launch -Control) to a guest, you must either use `-cpu host` to pass-through the +Control) to a guest, you must either use ``-cpu host`` to pass-through the host CPU model, or explicitly enable SGX when using a built-in CPU model, -e.g. via `-cpu ,+sgx` or `-cpu ,+sgx,+sgxlc`. +e.g. via ``-cpu ,+sgx`` or ``-cpu ,+sgx,+sgxlc``. =20 All SGX sub-features enumerated through CPUID, e.g. SGX2, MISCSELECT, ATTRIBUTES, etc... can be restricted via CPUID flags. Be aware that enforc= ing @@ -126,7 +126,7 @@ creating VM with SGX. Feature Control ~~~~~~~~~~~~~~~ =20 -Qemu SGX updates the `etc/msr_feature_control` fw_cfg entry to set the SGX +Qemu SGX updates the ``etc/msr_feature_control`` fw_cfg entry to set the S= GX (bit 18) and SGX LC (bit 17) flags based on their respective CPUID support, i.e. existing guest firmware will automatically set SGX and SGX LC accordi= ngly, assuming said firmware supports fw_cfg.msr_feature_control. --=20 2.33.0.721.g106298f7f9 From nobody Sun May 19 19:40:26 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1636119995633141.4101494115921; Fri, 5 Nov 2021 06:46:35 -0700 (PDT) Received: from localhost ([::1]:34114 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mizYA-0007Xx-HZ for importer@patchew.org; Fri, 05 Nov 2021 09:46:34 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:54626) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mizMF-00087J-5x for qemu-devel@nongnu.org; Fri, 05 Nov 2021 09:34:15 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]:43106) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mizMD-0002KE-1M for qemu-devel@nongnu.org; Fri, 05 Nov 2021 09:34:14 -0400 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-51-9qwC3zCeOfGMEhwER8Czbg-1; Fri, 05 Nov 2021 09:34:11 -0400 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id ED0BF112B8F9; Fri, 5 Nov 2021 13:34:09 +0000 (UTC) Received: from localhost (unknown [10.39.208.24]) by smtp.corp.redhat.com (Postfix) with ESMTP id EB7A41037F3F; Fri, 5 Nov 2021 13:34:00 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1636119252; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=uw8lNlRzeT0fJfa5Z4fBeynnvzDhYSxkV0pED0OyFlg=; b=jUZnIkw0R1+NhIt2RnSsA+XNoHHG3dTiVQ2Bge2sL2CAq2IHXMlOibgOnv64gsIzyD9AUf K58ju1JaeyKy6TePCXG+/b1H+bEjQ7TMfs15Olbq/nxOz3YeJP4T2PhDdQvlFpqBC4abuY I6yTxBmBLC3YQLx9cNfVDZZRpenQyqE= X-MC-Unique: 9qwC3zCeOfGMEhwER8Czbg-1 From: marcandre.lureau@redhat.com To: qemu-devel@nongnu.org Subject: [PULL 11/11] docs/sphinx: change default role to "any" Date: Fri, 5 Nov 2021 17:32:22 +0400 Message-Id: <20211105133222.184722-12-marcandre.lureau@redhat.com> In-Reply-To: <20211105133222.184722-1-marcandre.lureau@redhat.com> References: <20211105133222.184722-1-marcandre.lureau@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=marcandre.lureau@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.129.124; envelope-from=marcandre.lureau@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -33 X-Spam_score: -3.4 X-Spam_bar: --- X-Spam_report: (-3.4 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.648, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: John Snow , Peter Maydell , Richard Henderson Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1636119996420100003 Content-Type: text/plain; charset="utf-8" From: John Snow This interprets single-backtick syntax in all of our Sphinx docs as a cross-reference to *something*, including Python symbols. From here on out, new uses of `backticks` will cause a build failure if the target cannot be referenced. Signed-off-by: John Snow Reviewed-by: Eduardo Habkost Reviewed-by: Peter Maydell Message-Id: <20211004215238.1523082-4-jsnow@redhat.com> --- docs/conf.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 3161b8b127c6..763e7d243448 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -85,6 +85,11 @@ # The master toctree document. master_doc =3D 'index' =20 +# Interpret `single-backticks` to be a cross-reference to any kind of +# referenceable object. Unresolvable or ambiguous references will emit a +# warning at build time. +default_role =3D 'any' + # General information about the project. project =3D u'QEMU' copyright =3D u'2021, The QEMU Project Developers' --=20 2.33.0.721.g106298f7f9