[PATCH] leds: Add leds-qcom-lpg entry to documentation table of contents

[PATCH] leds: Add leds-qcom-lpg entry to documentation table of contents

[Bagas Sanjaya]

After merging linux-leds tree to the mainline [1], htmldocs build produces
a new warning:

checking consistency... /home/bagas/repo/linux-stable/Documentation/leds/leds-qcom-lpg.rst: WARNING: document isn't included in any toctree

The warning above is because leds-qcom-lpg.rst is missing in the table of
contents.

Add the missing entry.

[1]: https://lore.kernel.org/all/20220531200619.GA8906@duo.ucw.cz/

Fixes: e98a860f65428a ("leds: qcom-lpg: Require pattern to follow documentation")
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Pavel Machek <pavel@ucw.cz>
Cc: Bjorn Andersson <bjorn.andersson@linaro.org>
Cc: Marijn Suijten <marijn.suijten@somainline.org>
Cc: linux-leds@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/leds/index.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/leds/index.rst b/Documentation/leds/index.rst
index e5d63b9400459c..014e009b076159 100644
--- a/Documentation/leds/index.rst
+++ b/Documentation/leds/index.rst
@@ -25,4 +25,5 @@ LEDs
    leds-lp5562
    leds-lp55xx
    leds-mlxcpld
+   leds-qcom-lpg
    leds-sc27xx

base-commit: 50fd82b3a9a9335df5d50c7ddcb81c81d358c4fc
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH] leds: Add leds-qcom-lpg entry to documentation table of contents

[Jonathan Corbet]

Bagas Sanjaya <bagasdotme@gmail.com> writes:

> After merging linux-leds tree to the mainline [1], htmldocs build produces
> a new warning:
>
> checking consistency... /home/bagas/repo/linux-stable/Documentation/leds/leds-qcom-lpg.rst: WARNING: document isn't included in any toctree
>
> The warning above is because leds-qcom-lpg.rst is missing in the table of
> contents.
>
> Add the missing entry.

The fix is good but ...

> [1]: https://lore.kernel.org/all/20220531200619.GA8906@duo.ucw.cz/
>
> Fixes: e98a860f65428a ("leds: qcom-lpg: Require pattern to follow documentation")

...I'm confused as to why you used that commit for a Fixes: tag.  It
touched the file in question but didn't add it in the first place; I
think 24e2d05d1b68 is the droid you're looking for.

jon

Re: [PATCH] leds: Add leds-qcom-lpg entry to documentation table of contents

[Pavel Machek]

[-- Attachment #1: Type: text/plain, Size: 1068 bytes --]

Hi!

> > After merging linux-leds tree to the mainline [1], htmldocs build produces
> > a new warning:
> >
> > checking consistency... /home/bagas/repo/linux-stable/Documentation/leds/leds-qcom-lpg.rst: WARNING: document isn't included in any toctree
> >
> > The warning above is because leds-qcom-lpg.rst is missing in the table of
> > contents.
> >
> > Add the missing entry.
> 
> The fix is good but ...
> 
> > [1]: https://lore.kernel.org/all/20220531200619.GA8906@duo.ucw.cz/
> >
> > Fixes: e98a860f65428a ("leds: qcom-lpg: Require pattern to follow documentation")
> 
> ...I'm confused as to why you used that commit for a Fixes: tag.  It
> touched the file in question but didn't add it in the first place; I
> think 24e2d05d1b68 is the droid you're looking for.

Not sure if that is important, we don't need this in stable, do we?

Anyway

Acked-by: Pavel Machek <pavel@ucw.cz>

... and I assume it goes through your tree?

Best regards,
								Pavel


-- 
People of Russia, stop Putin before his war on Ukraine escalates.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 195 bytes --]

Re: [PATCH] leds: Add leds-qcom-lpg entry to documentation table of contents

[Bagas Sanjaya]

On Fri, Jun 03, 2022 at 03:53:26PM +0200, Pavel Machek wrote:
> Not sure if that is important, we don't need this in stable, do we?
> 
> Anyway
> 
> Acked-by: Pavel Machek <pavel@ucw.cz>
> 
> ... and I assume it goes through your tree?

Looking at timeline, the -rc1 is imminent (probably tomorrow), so this
patch misses 5.19. If it lands through jc_docs tree, it will be aimed
for 5.20. But if the htmldocs warning also appears on mainline after
-rc1, I guess it can land through leds tree as stabilization (bug fixes)
patch.

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