Documentation: leds: Fix warning from leds-qcom-lpg

[PATCH] Documentation: leds: Fix warning from leds-qcom-lpg

Posted by Jeffrey Hugo 2 years, 7 months ago

"make htmldocs" generates a warning about leds-qcom-lpg -
"Documentation/leds/leds-qcom-lpg.rst: WARNING: document isn't included
in any toctree"

Add leds-qcom-lpg to the leds index to fix this warning.

Fixes: 24e2d05d1b68 ("leds: Add driver for Qualcomm LPG")
Signed-off-by: Jeffrey Hugo <quic_jhugo@quicinc.com>
---
 Documentation/leds/index.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/leds/index.rst b/Documentation/leds/index.rst
index e5d63b9..014e009 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
-- 
2.7.4

Re: [PATCH] Documentation: leds: Fix warning from leds-qcom-lpg

Posted by Jonathan Corbet 2 years, 7 months ago

Jeffrey Hugo <quic_jhugo@quicinc.com> writes:

> "make htmldocs" generates a warning about leds-qcom-lpg -
> "Documentation/leds/leds-qcom-lpg.rst: WARNING: document isn't included
> in any toctree"
>
> Add leds-qcom-lpg to the leds index to fix this warning.
>
> Fixes: 24e2d05d1b68 ("leds: Add driver for Qualcomm LPG")
> Signed-off-by: Jeffrey Hugo <quic_jhugo@quicinc.com>
> ---
>  Documentation/leds/index.rst | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/Documentation/leds/index.rst b/Documentation/leds/index.rst
> index e5d63b9..014e009 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

Already fixed in docs-next.

Thanks,

jon

Re: [PATCH] Documentation: leds: Fix warning from leds-qcom-lpg

Posted by Jeffrey Hugo 2 years, 7 months ago

On 2/6/2023 10:33 AM, Jonathan Corbet wrote:
> Jeffrey Hugo <quic_jhugo@quicinc.com> writes:
> 
>> "make htmldocs" generates a warning about leds-qcom-lpg -
>> "Documentation/leds/leds-qcom-lpg.rst: WARNING: document isn't included
>> in any toctree"
>>
>> Add leds-qcom-lpg to the leds index to fix this warning.
>>
>> Fixes: 24e2d05d1b68 ("leds: Add driver for Qualcomm LPG")
>> Signed-off-by: Jeffrey Hugo <quic_jhugo@quicinc.com>
>> ---
>>   Documentation/leds/index.rst | 1 +
>>   1 file changed, 1 insertion(+)
>>
>> diff --git a/Documentation/leds/index.rst b/Documentation/leds/index.rst
>> index e5d63b9..014e009 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
> 
> Already fixed in docs-next.
> 
> Thanks,
> 
> jon

Ah.  Missed that.  Thanks.