From mboxrd@z Thu Jan 1 00:00:00 1970 From: Mauro Carvalho Chehab Subject: [PATCH 00/17] Address several documentation build warnings Date: Tue, 17 Mar 2020 15:54:09 +0100 Message-ID: Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Return-path: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=m.gmane-mx.org@lists.infradead.org To: Linux Doc Mailing List Cc: Andrew Lunn , Wolfram Sang , Peter Zijlstra , Catalin Marinas , Linus Walleij , Lai Jiangshan , Liam Girdwood , linux-ide@vger.kernel.org, linux-i2c@vger.kernel.org, Joel Fernandes , linux1394-devel@lists.sourceforge.net, Will Deacon , Jason Gunthorpe , Florian Fainelli , Jonathan Corbet , Mauro Carvalho Chehab , Russell King , Chanwoo Choi , Doug Ledford , MyungJoo Ham , linux-pci@vger.kernel.org, Darren Hart , Niranjana Vishwanathapura , Paul E. McKe List-Id: linux-i2c@vger.kernel.org This patch series is against next-20200317. It addresses several warnings on random places. It is worth noticing patch 07/17: It changes kernel-doc parser to accept a very common pattern on kernel-doc markups. This reduces a lot of warnings all over the tree. The remaining patches are just random fixes with the hope to address most warnings that are shown in red when building the documentation. Mauro Carvalho Chehab (17): docs: amu: supress some Sphinx warnings docs: arm64: booting.rst: get rid of some warnings docs: pci: boot-interrupts.rst: improve html output kernel: futex.c: get rid of a docs build warning devfreq: devfreq.h: get rid of some doc warnings firewire: firewire-cdev.hL get rid of a docs warning scripts: kernel-doc: proper handle @foo->bar() lib: bitmap.c: get rid of some doc warnings rcu: update.c: get rid of some doc warnings net: phy: sfp-bus.c: get rid of docs warnings net: core: dev.c: fix a documentation warning gpio: gpiolib.c: fix a doc warning i2c: include/linux/i2c.h: fix a doc warning infiniband: pa_vnic_encap.h: get rid of a warning ata: libata-core: fix a doc warning fs: inode.c: get rid of docs warnings regulator: driver.h: fix regulator_map_* function names Documentation/PCI/boot-interrupts.rst | 34 ++++++++++-------- Documentation/arm64/amu.rst | 5 +++ Documentation/arm64/booting.rst | 36 +++++++++++-------- drivers/ata/libata-core.c | 2 +- drivers/gpio/gpiolib.c | 2 +- .../infiniband/ulp/opa_vnic/opa_vnic_encap.h | 2 +- drivers/net/phy/sfp-bus.c | 32 +++++++++-------- fs/inode.c | 6 ++-- include/linux/devfreq.h | 6 ++-- include/linux/i2c.h | 4 +-- include/linux/regulator/driver.h | 4 +-- include/uapi/linux/firewire-cdev.h | 2 +- kernel/futex.c | 3 +- kernel/rcu/update.c | 8 ++--- lib/bitmap.c | 27 +++++++------- net/core/dev.c | 2 +- scripts/kernel-doc | 2 ++ 17 files changed, 101 insertions(+), 76 deletions(-) -- 2.24.1 From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-4.0 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 5006AC2BB1D for ; Tue, 17 Mar 2020 14:55:03 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 17B3520724 for ; Tue, 17 Mar 2020 14:55:03 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="hbarKczS"; dkim=fail reason="signature verification failed" (1024-bit key) header.d=kernel.org header.i=@kernel.org header.b="jF6VXV0D" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 17B3520724 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+infradead-linux-arm-kernel=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20170209; h=Sender: Content-Transfer-Encoding:Content-Type:Cc:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:Message-Id:Date:Subject:To :From:Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To:References: List-Owner; bh=l8nKK2foxQjwU/wi+SI2MmTaoVSkui7GbNODr1w443Y=; b=hbarKczS0/9rd2 pQqdGnMW4GqpR8BLF6mClWYB9sqUW+po0iLewuFfCqUCB3KWwgs14bFGwuRkaDFXNRGNmrk1ooQtB 2evHb2C8b0xxM3x+evlWQuhPfjn3yM2vsdV+bk7LdDUvaK0DyXV2JKfn5NIQYHsK9ggptGPQZf21P eHoZsVuH9n4D0hsTSMA9nbGvlqm5z+DTf8DLazwqBIzK7PeQ2iQLukyMQTLK55RDfui91dgk1Go+c RzSXEsm7wZAtleCgYXRTQAinbjRcoAhyMeQjlc8n93yAkWZtwhK8EX8L3DHENXK1Xk+/3Kb901oBq pSKDhQ54Qxk4KjQkTExA==; Received: from localhost ([127.0.0.1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jEDcT-0002Ol-A7; Tue, 17 Mar 2020 14:55:01 +0000 Received: from mail.kernel.org ([198.145.29.99]) by bombadil.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1jEDbz-0001vI-ON for linux-arm-kernel@lists.infradead.org; Tue, 17 Mar 2020 14:54:33 +0000 Received: from mail.kernel.org (ip5f5ad4e9.dynamic.kabel-deutschland.de [95.90.212.233]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 3243320738; Tue, 17 Mar 2020 14:54:31 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1584456871; bh=wv1oXeNAPji2JqILSy7dsOlUm83jPgRnZSKzsNM/ZJ8=; h=From:To:Cc:Subject:Date:From; b=jF6VXV0DKDhsOphX476Krqri9CPMtpL7QuS51NlGKZA0DVmzUvhwO3/cUoDkLVDmJ XoRoh5cHAImMSv3Hwx/BWDHPdfFiPGVUDa+jQOg8aJNn5px1ZWbMevRVF2uIDn2tgn fgA3/ORJqAVd4OK24NQB91k43PHQmCH5xncZM/xA= Received: from mchehab by mail.kernel.org with local (Exim 4.92.3) (envelope-from ) id 1jEDbw-000AME-Ae; Tue, 17 Mar 2020 15:54:28 +0100 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Subject: [PATCH 00/17] Address several documentation build warnings Date: Tue, 17 Mar 2020 15:54:09 +0100 Message-Id: X-Mailer: git-send-email 2.24.1 MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20200317_075431_829134_F749FBE9 X-CRM114-Status: GOOD ( 10.98 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Andrew Lunn , Wolfram Sang , Peter Zijlstra , Catalin Marinas , Linus Walleij , Lai Jiangshan , Liam Girdwood , linux-ide@vger.kernel.org, linux-i2c@vger.kernel.org, Joel Fernandes , linux1394-devel@lists.sourceforge.net, Will Deacon , Jason Gunthorpe , Florian Fainelli , Jonathan Corbet , Mauro Carvalho Chehab , Russell King , Chanwoo Choi , Doug Ledford , MyungJoo Ham , linux-pci@vger.kernel.org, Darren Hart , Niranjana Vishwanathapura , "Paul E. McKenney" , linux-pm@vger.kernel.org, Josh Triplett , Steven Rostedt , rcu@vger.kernel.org, linux-gpio@vger.kernel.org, Mark Brown , Mathieu Desnoyers , Alexander Viro , Jakub Kicinski , Bjorn Helgaas , Thomas Gleixner , Ingo Molnar , linux-arm-kernel@lists.infradead.org, Jens Axboe , netdev@vger.kernel.org, Dennis Dalessandro , linux-kernel@vger.kernel.org, linux-rdma@vger.kernel.org, Kyungmin Park , Stefan Richter , linux-fsdevel@vger.kernel.org, Bartosz Golaszewski , "David S. Miller" , Heiner Kallweit Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+infradead-linux-arm-kernel=archiver.kernel.org@lists.infradead.org This patch series is against next-20200317. It addresses several warnings on random places. It is worth noticing patch 07/17: It changes kernel-doc parser to accept a very common pattern on kernel-doc markups. This reduces a lot of warnings all over the tree. The remaining patches are just random fixes with the hope to address most warnings that are shown in red when building the documentation. Mauro Carvalho Chehab (17): docs: amu: supress some Sphinx warnings docs: arm64: booting.rst: get rid of some warnings docs: pci: boot-interrupts.rst: improve html output kernel: futex.c: get rid of a docs build warning devfreq: devfreq.h: get rid of some doc warnings firewire: firewire-cdev.hL get rid of a docs warning scripts: kernel-doc: proper handle @foo->bar() lib: bitmap.c: get rid of some doc warnings rcu: update.c: get rid of some doc warnings net: phy: sfp-bus.c: get rid of docs warnings net: core: dev.c: fix a documentation warning gpio: gpiolib.c: fix a doc warning i2c: include/linux/i2c.h: fix a doc warning infiniband: pa_vnic_encap.h: get rid of a warning ata: libata-core: fix a doc warning fs: inode.c: get rid of docs warnings regulator: driver.h: fix regulator_map_* function names Documentation/PCI/boot-interrupts.rst | 34 ++++++++++-------- Documentation/arm64/amu.rst | 5 +++ Documentation/arm64/booting.rst | 36 +++++++++++-------- drivers/ata/libata-core.c | 2 +- drivers/gpio/gpiolib.c | 2 +- .../infiniband/ulp/opa_vnic/opa_vnic_encap.h | 2 +- drivers/net/phy/sfp-bus.c | 32 +++++++++-------- fs/inode.c | 6 ++-- include/linux/devfreq.h | 6 ++-- include/linux/i2c.h | 4 +-- include/linux/regulator/driver.h | 4 +-- include/uapi/linux/firewire-cdev.h | 2 +- kernel/futex.c | 3 +- kernel/rcu/update.c | 8 ++--- lib/bitmap.c | 27 +++++++------- net/core/dev.c | 2 +- scripts/kernel-doc | 2 ++ 17 files changed, 101 insertions(+), 76 deletions(-) -- 2.24.1 _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel