Message-ID: <20201029100721.0fe83761@coco.lan>
Date:   Thu, 29 Oct 2020 10:07:21 +0100
From:   Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To:     Greg Kroah-Hartman <gregkh@...uxfoundation.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        Alexandre Torgue <alexandre.torgue@...com>,
        Andreas Klinger <ak@...klinger.de>,
        Anton Vorontsov <anton@...msg.org>,
        Baolin Wang <baolin.wang7@...il.com>,
        Bartosz Golaszewski <bgolaszewski@...libre.com>,
        Benson Leung <bleung@...omium.org>,
        Bjorn Andersson <bjorn.andersson@...aro.org>,
        Boris Brezillon <bbrezillon@...nel.org>,
        Chao Yu <chao@...nel.org>,
        Chunyan Zhang <zhang.lyra@...il.com>,
        Colin Cross <ccross@...roid.com>,
        Daniel Thompson <daniel.thompson@...aro.org>,
        Enric Balletbo i Serra <enric.balletbo@...labora.com>,
        Fabrice Gasnier <fabrice.gasnier@...com>,
        Heikki Krogerus <heikki.krogerus@...ux.intel.com>,
        Jaegeuk Kim <jaegeuk@...nel.org>,
        Jingoo Han <jingoohan1@...il.com>,
        Johan Hovold <johan@...nel.org>,
        Johannes Berg <johannes@...solutions.net>,
        Jonathan Cameron <jic23@...nel.org>,
        Kees Cook <keescook@...omium.org>,
        Lee Jones <lee.jones@...aro.org>,
        Linus Walleij <linus.walleij@...aro.org>,
        Mathieu Poirier <mathieu.poirier@...aro.org>,
        Maxime Coquelin <mcoquelin.stm32@...il.com>,
        Mike Kravetz <mike.kravetz@...cle.com>,
        Ohad Ben-Cohen <ohad@...ery.com>,
        Orson Zhai <orsonzhai@...il.com>,
        Peter Rosin <peda@...ntia.se>,
        Richard Cochran <richardcochran@...il.com>,
        Richard Gong <richard.gong@...ux.intel.com>,
        Sebastian Reichel <sre@...nel.org>,
        Srinivas Kandagatla <srinivas.kandagatla@...aro.org>,
        Stefan Achatz <erazor_de@...rs.sourceforge.net>,
        Tony Luck <tony.luck@...el.com>, Wu Hao <hao.wu@...el.com>,
        Divya Bharathi <divya27392@...il.com>,
        platform-driver-x86@...r.kernel.org,
        Divya Bharathi <divya.bharathi@...l.com>,
        Hans de Goede <hdegoede@...hat.com>,
        Andy Shevchenko <andy.shevchenko@...il.com>,
        mark gross <mgross@...ux.intel.com>,
        Mario Limonciello <mario.limonciello@...l.com>,
        Prasanth KSR <prasanth.ksr@...l.com>
Subject: Re: [PATCH 00/33] ABI: add it to the documentation build system

Em Wed, 28 Oct 2020 15:43:21 +0100
Greg Kroah-Hartman <gregkh@...uxfoundation.org> escreveu:

> On Wed, Oct 28, 2020 at 03:22:58PM +0100, Mauro Carvalho Chehab wrote:
> > Hi Greg,
> > 
> > As requested, this is a rebased version on the top of v5.10-rc1
> > adding support for having the Linux ABI documentted inside
> > the Linux admin manual.
> > 
> > When compared with the version I sent years ago, this
> > version has:
> > 
> > - a logic to detect duplicated ABI symbols;
> > - it auto-generate cross-reference markups for ABI symbols,
> >   ABI files and .rst files;
> > - Other files from 5.10-rc1 required adjustments in order
> >   to be accepted by the script in rst-source mode;
> > - Some bug fixes.
> > 
> > PS.: I didn't try to merge it against linux-next yet. So,
> > I won't doubt that applying it could cause some conflicts.
> > 
> > Feel free to review it.  
> 
> In general, I like it.
> 
> If there's no complaints, I'd like to take all of the Documentation/ABI/
> updates in for 5.10-rc2 at the least, to make it easier to build on top
> of and to keep these types of mistakes from living longer than they
> should be.  And make merging easier with other trees over time.

I rebased today on the top of linux-next. All patches applied as-is.

There's just a few new warnings due to a single patch, added via
platform-driver-x86:

	[PATCH v7] Introduce support for Systems Management Driver over WMI for Dell Systems

(plus, it generated a get_abi.pl warning, due to a description added there
without Description:)

The ReST warnings are:

	/devel/v4l/docs/Documentation/ABI/testing/sysfs-class-firmware-attributes:2: WARNING: Title underline too short.

	Dell specific class extensions
	--------------------------
	/devel/v4l/docs/Documentation/ABI/testing/sysfs-class-firmware-attributes:2: WARNING: Unexpected indentation.
	/devel/v4l/docs/Documentation/ABI/testing/sysfs-class-firmware-attributes:2: WARNING: Unexpected indentation.
	/devel/v4l/docs/Documentation/ABI/testing/sysfs-class-firmware-attributes:2: WARNING: Block quote ends without a blank line; unexpected unindent.
	/devel/v4l/docs/Documentation/ABI/testing/sysfs-class-firmware-attributes:173: WARNING: Unexpected indentation.
	/devel/v4l/docs/Documentation/ABI/testing/sysfs-class-firmware-attributes:173: WARNING: Unexpected indentation.
	/devel/v4l/docs/Documentation/ABI/testing/sysfs-class-firmware-attributes:173: WARNING: Block quote ends without a blank line; unexpected unindent.
	/devel/v4l/docs/Documentation/ABI/testing/sysfs-class-firmware-attributes:111: WARNING: Inline emphasis start-string without end-string.

Without looking at the file, from the warnings, I suspect
that adding a few blank before/after indented lines should be
enough to fix them.

I'll prepare a separate patch to the file author, fixing those,
to be merged via the platform-driver-x86 git tree.

Thanks,
Mauro

Powered by blists - more mailing lists