From patchwork Mon Nov 30 08:59:28 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Heinrich Schuchardt X-Patchwork-Id: 1408096 X-Patchwork-Delegate: trini@ti.com Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=lists.denx.de (client-ip=85.214.62.61; helo=phobos.denx.de; envelope-from=u-boot-bounces@lists.denx.de; receiver=) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=gmx.de Authentication-Results: ozlabs.org; dkim=pass (1024-bit key; secure) header.d=gmx.net header.i=@gmx.net header.a=rsa-sha256 header.s=badeba3b8450 header.b=jxvZ8O0L; dkim-atps=neutral Received: from phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 4Ckzj732wbz9sTv for ; Mon, 30 Nov 2020 20:00:30 +1100 (AEDT) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id D26D68261E; Mon, 30 Nov 2020 10:00:15 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=none (p=none dis=none) header.from=gmx.de Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (1024-bit key; secure) header.d=gmx.net header.i=@gmx.net header.b="jxvZ8O0L"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 1B9598263C; Mon, 30 Nov 2020 10:00:14 +0100 (CET) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on phobos.denx.de X-Spam-Level: X-Spam-Status: No, score=-2.6 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,FREEMAIL_FROM,RCVD_IN_DNSWL_LOW,RCVD_IN_MSPIKE_H2, SPF_HELO_NONE autolearn=ham autolearn_force=no version=3.4.2 Received: from mout.gmx.net (mout.gmx.net [212.227.15.15]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id B46A382614 for ; Mon, 30 Nov 2020 10:00:10 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=none (p=none dis=none) header.from=gmx.de Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=xypron.glpk@gmx.de DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.net; s=badeba3b8450; t=1606726809; bh=ivCoBtNHX2khQOUPoqm9FvJv3nvKq0nMfsJ6TgmBUow=; h=X-UI-Sender-Class:From:To:Cc:Subject:Date; b=jxvZ8O0LhTPl9rAMC3mZcliZey0EzhjA/XqfGvvDc4+NM2qz7Q8QiGH3IpRN8pPZw b587GU3p8fJ6NFaInvAoh4XvQ+llZrZ/39wI0+HjYbmtFH+k09ATBHz9f7f0iSTl6R /rllx63W2HR6LudtdMOxf6rFye0xwFTtRPvd3ESA= X-UI-Sender-Class: 01bb95c1-4bf8-414a-932a-4f6e2808ef9c Received: from LT02.fritz.box ([62.143.246.89]) by mail.gmx.com (mrgmx005 [212.227.17.184]) with ESMTPSA (Nemesis) id 1MMXQ5-1kRr4g1e6x-00JWhY; Mon, 30 Nov 2020 10:00:09 +0100 From: Heinrich Schuchardt To: Tom Rini Cc: Jonathan Corbet , Sean Anderson , u-boot@lists.denx.de, Heinrich Schuchardt Subject: [PATCH 1/1] doc: allow building htmldoc with Sphinx 3+ Date: Mon, 30 Nov 2020 09:59:28 +0100 Message-Id: <20201130085928.17459-1-xypron.glpk@gmx.de> X-Mailer: git-send-email 2.29.2 MIME-Version: 1.0 X-Provags-ID: V03:K1:SYAGsZZpuaZMDn/q8FQRONCMNspRyX9O9cv4JHpPRSp3R8JVr6r MfmFOtKjuYp6WS5b1eoCmH42b4YylonA2rGi8cjn6sIMkKQFsWL98QAc2SOhP+pr3rnrZqI w39L2FshoeaIHZkGFfhy4k2L138Kv9rnJu8DFaCmp5imh1nZCmyi6VduKcbqaNazbNNJw1m 4nOdcFTMnppj7NzTRn1nA== X-UI-Out-Filterresults: notjunk:1;V03:K0:WUQBZ/eAAlQ=:fAeOi5D8/f/c+nC+rG30IM TEEJX1tXo10U0snP2Bar6KPuimQewoe2carDj5wqPtoZvzUQ3/jbT3T7T/96yH6DKFlJxXpSB XhjSnVgJBLeeIQKCAk/UGXAe5OiPCZxuUL7d2tuCmKe+5zKsim1Gi5vfNq+Hk4JK4Rmzyn87q ANUKjht82OTh/hac0RfRhLICdrFKvM3RG/FgmxUhSDxa64Rz0zMV9J6jpQihJbF3VMyZBHSQ/ MZ9yTNv26pAHJBp2wSdKxUAZsx9ySQ/LnFCNvH2D1EPAkah88HuPn5Z7mRJhzTdTFyMLrEZuf HpcKt4YXzuIrXqT0MWFj/+x9HpulPJTRKtAl5mL9OuzZgj85Our0Z5RHODpQZSmaancEa5/ic PxtVmkltQjE3VTcJdS1jsdp/MS5xokd6zXuXlpyBPxDcP/7saU+++RwUj7M8GTl7PgkpHl00P C5XG9D4N3bELxV7sXnTGb+pijZLymxDAjbbXFOVZsgPwL6VyZP+m4duFp9brfKD1YN45IZezT qt7n5HvIfZrgOscdjuCZgi1u6yNBu+YGJkpIBWMI97DYNs3bwTfUVoB7TfhFyM4LLc2EpnkrU P+T8fxZwf+0YyZXWBSVGb4vTBwevD+2a/2Y6n+Nt6kDAWSTh9Glscgbd/H5E1rK57OlqhPWub 5ssTx6bvtUL1ynaKp1fCkiwA3t+VXQ7/G11PMbSrJTILqyHQRuO4J7ovMjHIFlFbMn2IBKF6+ DZ+lFF/FDgnbHG09ZGAJnvSn9eoz3pI1F9BNc74F5aNHE3/xBxCls8J72XE9xL1smHtDBtGes Akz3wYlPotMiXh7nma7+AhygGd0MLDeJXcxFAAr817NCxn7m/ioLyIf8HwStz3j6QTyvu1HWj aMQ3oiiKEnfHLIJ34VNA== X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.34 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" X-Virus-Scanned: clamav-milter 0.102.3 at phobos.denx.de X-Virus-Status: Clean Due to removed function c_funcptr_sig_re building with Sphinx 3 fails. With the patch building succeeds with a lot of warnings if the '-W' flag is removed from doc/Makefile. Most of the documentation is correct This follows the approach taken by the Linux kernel. Signed-off-by: Heinrich Schuchardt --- doc/conf.py | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) -- 2.29.2 diff --git a/doc/conf.py b/doc/conf.py index 93250a6aee..ee7f201724 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -36,7 +36,34 @@ latex_engine = 'xelatex' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include', 'cdomain', 'kfigure'] +extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include', 'kfigure'] + +# +# cdomain is badly broken in Sphinx 3+. Leaving it out generates *most* +# of the docs correctly, but not all. +# +if major >= 3: + if (major > 3) or (minor > 0 or patch >= 2): + sys.stderr.write('''The build process with Sphinx 3+ is broken. +You will have to remove -W in doc/Makefile. +''') + # Sphinx c function parser is more pedantic with regards to type + # checking. Due to that, having macros at c:function cause problems. + # Those needed to be escaped by using c_id_attributes[] array + c_id_attributes = [ + + # include/linux/compiler.h + "__maybe_unused", + + # include/efi.h + "EFIAPI", + + # include/efi_loader.h + "__efi_runtime", + ] + +else: + extensions.append('cdomain') # The name of the math extension changed on Sphinx 1.4 if (major == 1 and minor > 3) or (major > 1):