htmldocs: Documentation/hwmon/max17616.rst:4: WARNING: Title underline too short.

[PATCH] htmldocs: Documentation/hwmon/max17616.rst:4: WARNING: Title underline too short.

Posted by Kriish Sharma 2 months ago

Fix the following warning encountered when running `make htmldocs`:

  Documentation/hwmon/max17616.rst:4: WARNING: Title underline too short.

The underline below "Kernel driver max17616" was shorter than the title
text, violating reStructuredText formatting rules. Extended the underline
to match the title length.

Fixes: 1fdbb3ff1233 ("Add linux-next specific files for 20251015")
Signed-off-by: Kriish Sharma <kriish.sharma2006@gmail.com>
---
 Documentation/hwmon/max17616.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/hwmon/max17616.rst b/Documentation/hwmon/max17616.rst
index 936447159f87..a3dc429048ae 100644
--- a/Documentation/hwmon/max17616.rst
+++ b/Documentation/hwmon/max17616.rst
@@ -1,7 +1,7 @@
 .. SPDX-License-Identifier: GPL-2.0
 
 Kernel driver max17616
-====================
+======================
 
 Supported chips:
 
-- 
2.34.1

Re: [PATCH] htmldocs: Documentation/hwmon/max17616.rst:4: WARNING: Title underline too short.

Posted by Guenter Roeck 2 months ago

On 10/15/25 08:35, Kriish Sharma wrote:
> Fix the following warning encountered when running `make htmldocs`:
> 
>    Documentation/hwmon/max17616.rst:4: WARNING: Title underline too short.
> 
> The underline below "Kernel driver max17616" was shorter than the title
> text, violating reStructuredText formatting rules. Extended the underline
> to match the title length.
> 
> Fixes: 1fdbb3ff1233 ("Add linux-next specific files for 20251015")

That is a bit wrong.

> Signed-off-by: Kriish Sharma <kriish.sharma2006@gmail.com>

Thanks for the report. Folded into the original patch.

Guenter