[PATCH v2] Documentation: bno055: separate SPDX identifier and page title

[PATCH v2] Documentation: bno055: separate SPDX identifier and page title

[Bagas Sanjaya]

kernel test robot reported htmldocs warning:

Documentation/iio/bno055.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.

The warning above is caused by missing blank line separator between SPDX
identifier and page title.

Add the blank line to fix the warning.

Link: https://lore.kernel.org/lkml/202207031509.DlBrHyaw-lkp@intel.com/
Fixes: ec0c70cb45507d ("docs: iio: add documentation for BNO055 driver")
Reported-by: kernel test robot <lkp@intel.com>
Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Andrea Merello <andrea.merello@iit.it>
Cc: Jonathan Cameron <jic23@kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: Lars-Peter Clausen <lars@metafoo.de>
Cc: Rob Herring <robh+dt@kernel.org>
Cc: Matt Ranostay <matt.ranostay@konsulko.com>
Cc: Alexandru Ardelean <ardeleanalex@gmail.com>
Cc: jacopo@jmondi.org
Cc: linux-iio@vger.kernel.org
Cc: devicetree@vger.kernel.org
Cc: linux-kernel@vger.kernel.org (open list)
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---

 Changes since v1 [1]:
   - Collect Reviewed-by from Andy Shevchenko
   - Explain why the warning is triggered
   - No code changes 

 This patch is based on "Add support for Bosch BNO055 IMU" series [2]
 as fixup for BNO055 documentation (patch [14/14])

 [1]: https://lore.kernel.org/lkml/YsGVa8KFmdvGY92e@debian.me/
 [2]: https://lore.kernel.org/lkml/20220613120534.36991-1-andrea.merello@iit.it/ 
 Documentation/iio/bno055.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/iio/bno055.rst b/Documentation/iio/bno055.rst
index af21376d7a2533..9a489a79d8f5a8 100644
--- a/Documentation/iio/bno055.rst
+++ b/Documentation/iio/bno055.rst
@@ -1,4 +1,5 @@
 .. SPDX-License-Identifier: GPL-2.0
+
 ==============================
 BNO055 driver
 ==============================
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH v2] Documentation: bno055: separate SPDX identifier and page title

[Andy Shevchenko]

On Mon, Jul 4, 2022 at 5:41 AM Bagas Sanjaya <bagasdotme@gmail.com> wrote:
>
> kernel test robot reported htmldocs warning:
>
> Documentation/iio/bno055.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
>
> The warning above is caused by missing blank line separator between SPDX
> identifier and page title.
>
> Add the blank line to fix the warning.
>
> Link: https://lore.kernel.org/lkml/202207031509.DlBrHyaw-lkp@intel.com/
> Fixes: ec0c70cb45507d ("docs: iio: add documentation for BNO055 driver")
> Reported-by: kernel test robot <lkp@intel.com>
> Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>

> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Andrea Merello <andrea.merello@iit.it>
> Cc: Jonathan Cameron <jic23@kernel.org>
> Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> Cc: Lars-Peter Clausen <lars@metafoo.de>
> Cc: Rob Herring <robh+dt@kernel.org>
> Cc: Matt Ranostay <matt.ranostay@konsulko.com>
> Cc: Alexandru Ardelean <ardeleanalex@gmail.com>
> Cc: jacopo@jmondi.org
> Cc: linux-iio@vger.kernel.org
> Cc: devicetree@vger.kernel.org
> Cc: linux-kernel@vger.kernel.org (open list)

It's a very noisy Cc list which will go in the git history. Instead,
use --to and --cc parameters of `git format-patch`. Maintainers
usually use `b4` tool that adds a Link tag to the patch itself on the
Lore archive which will keep track on the Cc list anyway.

-- 
With Best Regards,
Andy Shevchenko

Re: [PATCH v2] Documentation: bno055: separate SPDX identifier and page title

[Bagas Sanjaya]

On 7/5/22 02:49, Andy Shevchenko wrote:
>> Cc: Jonathan Corbet <corbet@lwn.net>
>> Cc: Andrea Merello <andrea.merello@iit.it>
>> Cc: Jonathan Cameron <jic23@kernel.org>
>> Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
>> Cc: Lars-Peter Clausen <lars@metafoo.de>
>> Cc: Rob Herring <robh+dt@kernel.org>
>> Cc: Matt Ranostay <matt.ranostay@konsulko.com>
>> Cc: Alexandru Ardelean <ardeleanalex@gmail.com>
>> Cc: jacopo@jmondi.org
>> Cc: linux-iio@vger.kernel.org
>> Cc: devicetree@vger.kernel.org
>> Cc: linux-kernel@vger.kernel.org (open list)
> 
> It's a very noisy Cc list which will go in the git history. Instead,
> use --to and --cc parameters of `git format-patch`. Maintainers
> usually use `b4` tool that adds a Link tag to the patch itself on the
> Lore archive which will keep track on the Cc list anyway.
> 

Hi Andy,

Thanks for reminding me.

I think something like `b4 am -l`, right?

Anyway, should I resend (reroll)?

-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH v2] Documentation: bno055: separate SPDX identifier and page title

[Andy Shevchenko]

On Tue, Jul 5, 2022 at 3:13 AM Bagas Sanjaya <bagasdotme@gmail.com> wrote:
> On 7/5/22 02:49, Andy Shevchenko wrote:

...

> >> Cc: Jonathan Corbet <corbet@lwn.net>
> >> Cc: Andrea Merello <andrea.merello@iit.it>
> >> Cc: Jonathan Cameron <jic23@kernel.org>
> >> Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> >> Cc: Lars-Peter Clausen <lars@metafoo.de>
> >> Cc: Rob Herring <robh+dt@kernel.org>
> >> Cc: Matt Ranostay <matt.ranostay@konsulko.com>
> >> Cc: Alexandru Ardelean <ardeleanalex@gmail.com>
> >> Cc: jacopo@jmondi.org
> >> Cc: linux-iio@vger.kernel.org
> >> Cc: devicetree@vger.kernel.org
> >> Cc: linux-kernel@vger.kernel.org (open list)
> >
> > It's a very noisy Cc list which will go in the git history. Instead,
> > use --to and --cc parameters of `git format-patch`. Maintainers
> > usually use `b4` tool that adds a Link tag to the patch itself on the
> > Lore archive which will keep track on the Cc list anyway.

> Thanks for reminding me.
>
> I think something like `b4 am -l`, right?
>
> Anyway, should I resend (reroll)?

Depends on the maintainer's wishes. Maybe they can drop them when
applying, I dunno.

-- 
With Best Regards,
Andy Shevchenko

Re: [PATCH v2] Documentation: bno055: separate SPDX identifier and page title

[Jonathan Cameron]

On Tue, 5 Jul 2022 11:02:32 +0200
Andy Shevchenko <andy.shevchenko@gmail.com> wrote:

> On Tue, Jul 5, 2022 at 3:13 AM Bagas Sanjaya <bagasdotme@gmail.com> wrote:
> > On 7/5/22 02:49, Andy Shevchenko wrote:  
> 
> ...
> 
> > >> Cc: Jonathan Corbet <corbet@lwn.net>
> > >> Cc: Andrea Merello <andrea.merello@iit.it>
> > >> Cc: Jonathan Cameron <jic23@kernel.org>
> > >> Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> > >> Cc: Lars-Peter Clausen <lars@metafoo.de>
> > >> Cc: Rob Herring <robh+dt@kernel.org>
> > >> Cc: Matt Ranostay <matt.ranostay@konsulko.com>
> > >> Cc: Alexandru Ardelean <ardeleanalex@gmail.com>
> > >> Cc: jacopo@jmondi.org
> > >> Cc: linux-iio@vger.kernel.org
> > >> Cc: devicetree@vger.kernel.org
> > >> Cc: linux-kernel@vger.kernel.org (open list)  
> > >
> > > It's a very noisy Cc list which will go in the git history. Instead,
> > > use --to and --cc parameters of `git format-patch`. Maintainers
> > > usually use `b4` tool that adds a Link tag to the patch itself on the
> > > Lore archive which will keep track on the Cc list anyway.  
> 
> > Thanks for reminding me.
> >
> > I think something like `b4 am -l`, right?
> >
> > Anyway, should I resend (reroll)?  
> 
> Depends on the maintainer's wishes. Maybe they can drop them when
> applying, I dunno.
> 

At the moment this is a fix to a series we haven't actually accepted.
Nice to have an all, but up to Andrea on how to handle it.
One reasonable option would be just to squish it into the original
patch for v7 with an appropriate note in the patch description / changelog.

Thanks,

Jonathan