From patchwork Tue May 21 12:25:13 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 164719 Delivered-To: patch@linaro.org Received: by 2002:a92:9e1a:0:0:0:0:0 with SMTP id q26csp1538847ili; Tue, 21 May 2019 05:28:47 -0700 (PDT) X-Google-Smtp-Source: APXvYqys76T8ZSkhY9OUmEKwyuGH6gKnOA+0kUnf1cFvw+N2Ton1MGt9jKt4Y5fVj837RNzS7/2g X-Received: by 2002:a05:6402:13cf:: with SMTP id a15mr82063885edx.70.1558441726904; Tue, 21 May 2019 05:28:46 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1558441726; cv=none; d=google.com; s=arc-20160816; b=F4EY0jVvoFI+NuspVR5pliA888uR5apED2mNkGq0SGQRjhrGKdg7LQH1GqXWQYADz2 amgYAKJeULRvAXTu/Dw6LDbKy3il6G8NROz3AULEzyC5L+GjSQvbDp9r7aF6FxLj0x6/ 0GGx5frFNPIs0T0mLkTotqTx/0RI6V0cckhScC+T1wrSJI2NVpm5E5bWrMmaln+2pmzn bABODdbVqrs8D+2e97btvNCMlUiAZoZUnulBxPRP7fU6EkKdqkkkVkCJdmc2B7Ets8+V esenoNyN1tphOIVeAaoUvzY8qqWXYhvNyYdxCXlJuCQKln40PdwcsjmUGmeAzZ4+nGLR iiTA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:cc:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject :content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:to:from:dkim-signature; bh=6OFDFvuvQviFWUA+ErkQZRrbDM3t1pANZfkvzqmBlg8=; b=aT7ApVFoYFkTO6AZz9PDaFAYPPJ53+x77g5M1HmahL2Iz2S3Hnc5Q4WiLeK0Ud51Df p+BxwuVsh+Wo/h5NQYnvo0nwFLDFAXM/ve4OW4nhkeyXiDIeUenK4ff5YW5mel6x+1en YhOTDccwOLxK9Pav79ykR5ArHxDb9bgETWeMTNxYzNxLTS0N3oAnnDYEn451vQIsmA5Q g/rHyZBvRqqDfNSl6fO/cUB3m8GU0HTAgjVatdaKbn4GwMmcrwtxiK4CJHeIj6KOSriH SW5EOdPA5/CuUiJXwpEPAYQ8/sNLF6uIUrj2gSMz17Z0w+PUVKZB/OZQY+2rtKe2X+Y+ fTeA== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=npj4YbrO; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id w20si3159709eda.95.2019.05.21.05.28.46 for (version=TLS1 cipher=AES128-SHA bits=128/128); Tue, 21 May 2019 05:28:46 -0700 (PDT) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=npj4YbrO; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([127.0.0.1]:52692 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hT3sr-0004FY-Ng for patch@linaro.org; Tue, 21 May 2019 08:28:45 -0400 Received: from eggs.gnu.org ([209.51.188.92]:45331) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hT3q2-0001SG-RJ for qemu-devel@nongnu.org; Tue, 21 May 2019 08:25:52 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hT3px-0005GA-0V for qemu-devel@nongnu.org; Tue, 21 May 2019 08:25:48 -0400 Received: from mail-wm1-x329.google.com ([2a00:1450:4864:20::329]:50611) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hT3pw-00056N-Ii for qemu-devel@nongnu.org; Tue, 21 May 2019 08:25:44 -0400 Received: by mail-wm1-x329.google.com with SMTP id f204so2799900wme.0 for ; Tue, 21 May 2019 05:25:29 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=6OFDFvuvQviFWUA+ErkQZRrbDM3t1pANZfkvzqmBlg8=; b=npj4YbrO4P/rhMjEvX/1V6DzWudQYkMfQHNy5tszxjNs7loGgjR/IyshL2nc3YjMUk 4vi94cWZEmGyS5GlHzV5BMvAUFsI78B+ur4qTvirFuwOK4GSWsnpquL+SoFnzCn/zQTZ KWQlBxUgOT2uZwFHoj0kvUkHVds1h1nSoRL7oWWdIaZgL+1ww+FE7d9F8llWL5JNUiVK 5kTpz5LzyAG2FFh3sSjdfd3P/ggiAhKnPZ8hVsYg/2+MTO7tZ6HbwlBgUWduC+4ATNM/ omRvkt20z2Xk2Aieqv/dT7DftF9oT6/Sh1nevREJBzekv/7CBAnhlGkL8Qxyzn60Zigz sFWg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=6OFDFvuvQviFWUA+ErkQZRrbDM3t1pANZfkvzqmBlg8=; b=UBWGbD44tCd3DabT/42zg7p4cuVZdbOQW7Na/T6KB1T4uEYd525K26N+MBdVaXtoDa +WP6t058Rn6RPNisiWKxzfdI8wp87Q3LB6B0VTC9AUXGHbYGGUABWtYVUw+ZmMlpAiqE 1mhLbqGY+QI8NHQ36zbLf4tfqAs485BJJjYJr2J+JQ5nX3IMyHFa6KHWhJ//bH7SXsrA QSuT6Kb2M9TQGgcB5JOILyYzma8HqA75ccBZ4XMkx5n17L++5mt1Md1gVFIw8oRrzNxv RI8xUETIfvBKRsFU0Wv0JmvJKckcZgztSp8U3tthV6TW7O6jKFBCpl2bO6bLF4dZ6ZMt DZ5w== X-Gm-Message-State: APjAAAUjDCBcKtcw72t9pDshurTB0IbZmpeCUFidNeAbPIJ4wdGIg/je bSgOqj6bh6yHpYkJHLtQrMHPeBJ0D9I= X-Received: by 2002:a1c:740d:: with SMTP id p13mr3389604wmc.2.1558441528747; Tue, 21 May 2019 05:25:28 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id u11sm12233393wrn.1.2019.05.21.05.25.27 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 21 May 2019 05:25:28 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Date: Tue, 21 May 2019 13:25:13 +0100 Message-Id: <20190521122519.12573-5-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190521122519.12573-1-peter.maydell@linaro.org> References: <20190521122519.12573-1-peter.maydell@linaro.org> MIME-Version: 1.0 X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::329 Subject: [Qemu-devel] [RFC 04/10] docs/conf.py: Ignore some missing references in nitpick mode X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: "Daniel P. Berrange" , Eduardo Habkost , Gabriel Barreto , "Emilio G. Cota" , Stefan Hajnoczi , Cleber Rosa , Paolo Bonzini , John Snow Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" We enable Sphinx's 'nitpick' mode via the command line -n switch, which means it warns about references to things it doesn't know about. Add a whitelist of expected-not-to-be-present types, to avoid false positives when C function prototypes use standard integer types. If this whitelist gets too long and unmanageable we might be better off switching to non-nitpick mode instead. Signed-off-by: Peter Maydell --- docs/conf.py | 11 +++++++++++ 1 file changed, 11 insertions(+) -- 2.20.1 diff --git a/docs/conf.py b/docs/conf.py index 9109edbcb97..388299fb25b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -114,6 +114,17 @@ todo_include_todos = False # with "option::" in the document being processed. Turn that off. suppress_warnings = ["ref.option"] +nitpick_ignore = [ + ("c:type", "int8_t"), + ("c:type", "int16_t"), + ("c:type", "int32_t"), + ("c:type", "int64_t"), + ("c:type", "uint8_t"), + ("c:type", "uint16_t"), + ("c:type", "uint32_t"), + ("c:type", "uint64_t"), +] + # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for