From patchwork Fri Oct 2 05:49:44 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 285737 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=-12.1 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, MAILING_LIST_MULTI, MENTIONS_GIT_HOSTING, SPF_HELO_NONE, SPF_PASS, URIBL_BLOCKED, USER_AGENT_GIT autolearn=unavailable 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 A4B6DC4727F for ; Fri, 2 Oct 2020 05:50:18 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 6D6A9208A9 for ; Fri, 2 Oct 2020 05:50:18 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1601617818; bh=FBPwZnSsMqIWKQkD2zCJOP8xtefKz0VFKlRBsQSz4YE=; h=From:To:Cc:Subject:Date:List-ID:From; b=XEKXoYgB5/bn5DXtErvSPXHXCFquTfecG8j2cPLhfRRiaKmkdHD4WEYAQcky7L4RZ mpCXWANeE2/m9Ht3Ow7f1l6mn88iwg47sbDf4nufaqlSQotqhc4c2lA6OXpKrsBs+b EWXS2C1gGJYOkbK8+5sknyszLoHjJb+LTF6MO0Ps= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726080AbgJBFuG (ORCPT ); Fri, 2 Oct 2020 01:50:06 -0400 Received: from mail.kernel.org ([198.145.29.99]:59822 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1725971AbgJBFt7 (ORCPT ); Fri, 2 Oct 2020 01:49:59 -0400 Received: from mail.kernel.org (ip5f5ad59f.dynamic.kabel-deutschland.de [95.90.213.159]) (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 85847208C7; Fri, 2 Oct 2020 05:49:58 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1601617798; bh=FBPwZnSsMqIWKQkD2zCJOP8xtefKz0VFKlRBsQSz4YE=; h=From:To:Cc:Subject:Date:From; b=ejgMZ/l6FXxzU+YdRTwMxdT0f1Q+4gbrj+84EBxH2JN9yIe9vDe8W07jPvUyVE/UW pwqbFJ9yYWMl5Ms1dxYbPS7KEwa6ATt81MqjfNpvhhwgtMSJSrT18+F2izm1Y7rpLF 3mFQ7DT+0UPX36PDklpu0eXa1Raxyyql02Wb8Kf4= Received: from mchehab by mail.kernel.org with local (Exim 4.94) (envelope-from ) id 1kODx6-006hij-79; Fri, 02 Oct 2020 07:49:56 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , "David S. Miller" , Alexandru Elisei , Andrew Jones , Andrew Lunn , Anton Ivanov , Balbir Singh , Bartosz Golaszewski , Eugeniu Rosca , Geert Uytterhoeven , Jakub Kicinski , Jeff Dike , Linus Walleij , Marc Zyngier , Mathieu Poirier , Paolo Bonzini , Richard Weinberger , Taehee Yoo , Thomas Gleixner , Ulrich Hecht , Wolfram Sang , kvm@vger.kernel.org, linux-gpio@vger.kernel.org, linux-i2c@vger.kernel.org, linux-um@lists.infradead.org, netdev@vger.kernel.org Subject: [PATCH 0/6] Fix new html build warnings from next-20201001 Date: Fri, 2 Oct 2020 07:49:44 +0200 Message-Id: X-Mailer: git-send-email 2.26.2 MIME-Version: 1.0 Sender: Mauro Carvalho Chehab Precedence: bulk List-ID: X-Mailing-List: linux-i2c@vger.kernel.org There are some new warnings when building the documentation from yesterday's linux next. This small series fix them. - patch 1 documents two new kernel-doc parameters on a net core file. I used the commit log in order to help documenting them; - patch 2 fixes some tags at UMLv2 howto; - patches 3 and 5 add some new documents at the corresponding index file. - patch 4 changes kernel-doc script for it to recognize typedef enums. Patch 4 should probably be merged via docs tree, but the others are against stuff recently added at linux-next. So, the better is to merge them directly at the trees which introduced the issue. - As a reference, the patches fixing all html build warnings are at: https://git.linuxtv.org/mchehab/experimental.git/log/?h=sphinx3-fixes-v3 Such series also adds support for Sphinx versions 3.1 and above. It should be noticed that, with Sphinx version 3 and above, there are a few new warnings, because currently Sphinx assumes a that names are unique for all C symbols. There are a few cases where we have the same name for a function and for a struct at the Kernel. Upstream is already working on a solution for that. So, for now, I recomend doing html builds with version < 3. Mauro Carvalho Chehab (6): net: core: document two new elements of struct net_device docs: vcpu.rst: fix some build warnings docs: virt: user_mode_linux_howto_v2.rst: fix a literal block markup docs: i2c: index.rst: add slave-testunit-backend.rst scripts: kernel-doc: add support for typedef enum docs: gpio: add a new document to its index.rst Documentation/admin-guide/gpio/index.rst | 1 + .../admin-guide/hw-vuln/l1d_flush.rst | 3 +-- Documentation/i2c/index.rst | 1 + Documentation/virt/kvm/devices/vcpu.rst | 26 +++++++++---------- .../virt/uml/user_mode_linux_howto_v2.rst | 1 + include/linux/netdevice.h | 5 ++++ scripts/kernel-doc | 15 ++++++++--- 7 files changed, 33 insertions(+), 19 deletions(-)