public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Guenter Roeck <linux@roeck-us.net>
Cc: Charles Hsu <hsu.yungteng@gmail.com>,
	robh@kernel.org, krzk+dt@kernel.org, conor+dt@kernel.org,
	devicetree@vger.kernel.org, linux-hwmon@vger.kernel.org,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	huah Khan <skhan@linuxfoundation.org>,
	linux-doc@vger.kernel.org, Mark Brown <broonie@kernel.org>
Subject: Re: [PATCH v7 2/2] hwmon: pmbus: add support for STEF48H28
Date: Thu, 29 Jan 2026 08:17:59 +0100	[thread overview]
Message-ID: <20260129081743.50ab5a66@foz.lan> (raw)
In-Reply-To: <46a42764-6cf0-46c8-b764-4c4b394b04d0@roeck-us.net>

Hi Gunter/Charles,

On Mon, 26 Jan 2026 16:12:42 -0800
Guenter Roeck <linux@roeck-us.net> wrote:

> On Mon, Jan 26, 2026 at 02:37:12PM +0800, Charles Hsu wrote:
> > Add support for STEF48H28 hot-swap controller.
> > 
> > Signed-off-by: Charles Hsu <hsu.yungteng@gmail.com>  

This patch completely broke docs build, as it is using a markup meant
to identify section titles to mark the beginning/ending of a table.

Also, please use get_maintainers.pl:

	$ ./scripts/get_maintainer.pl Documentation/hwmon/stef48h28.rst
	Charles Hsu <hsu.yungteng@gmail.com> (maintainer:ST STEF48H28 DRIVER)
	Guenter Roeck <linux@roeck-us.net> (maintainer:HARDWARE MONITORING)
	Jonathan Corbet <corbet@lwn.net> (maintainer:DOCUMENTATION)
	Shuah Khan <skhan@linuxfoundation.org> (reviewer:DOCUMENTATION)
	linux-hwmon@vger.kernel.org (open list:ST STEF48H28 DRIVER)
	linux-doc@vger.kernel.org (open list:DOCUMENTATION)
	linux-kernel@vger.kernel.org (open list)

(adding documentation folks to C/C and also -next maintainer)

Please apply the enclosed patch to fix linux-next.

Thanks,
Mauro

---

[PATCH] docs: hwmon: stef48h28.rst: fix a documentation build
 breakage on -next

The table there is completely misformatted, causing Sphinx to
badly fail:

Traceback
=========

      File "/usr/lib/python3.14/site-packages/sphinx/util/parallel.py", line 137, in _join_one
        raise SphinxParallelError(*result)
    sphinx.errors.SphinxParallelError: docutils.utils.SystemMessage: /new_devel/docs/Documentation/hwmon/stef48h28.rst:45: (SEVERE/4) Missing matching underline for section title overline.

    =========================================================
    in1_label               "vin".
    in1_input               Measured voltage. From READ_VIN register.

The full traceback has been saved in:
/tmp/sphinx-err-wpoae2yk.log

Fixes: aef6b6b5d5bc ("hwmon: pmbus: add support for STEF48H28")
Cc: stable@vger.kernel.org

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

diff --git a/Documentation/hwmon/stef48h28.rst b/Documentation/hwmon/stef48h28.rst
index 00bef9e55651..3bfc37f3be8e 100644
--- a/Documentation/hwmon/stef48h28.rst
+++ b/Documentation/hwmon/stef48h28.rst
@@ -42,7 +42,7 @@ The driver supports standard PMBus driver platform data.
 Sysfs entries
 -------------
 
-=========================================================
+================	========================================================
 in1_label		"vin".
 in1_input		Measured voltage. From READ_VIN register.
 in1_min			Minimum Voltage. From VIN_UV_WARN_LIMIT register.
@@ -53,11 +53,11 @@ in2_input		Measured voltage. From READ_VOUT register.
 in2_min			Minimum Voltage. From VOUT_UV_WARN_LIMIT register.
 in2_max			Maximum voltage. From VOUT_OV_WARN_LIMIT register.
 
-curr1_label "iin".
-curr1_input Measured current. From READ_IIN register.
+curr1_label		"iin".
+curr1_input		Measured current. From READ_IIN register.
 
-curr2_label "iout1".
-curr2_input Measured current. From READ_IOUT register.
+curr2_label		"iout1".
+curr2_input		Measured current. From READ_IOUT register.
 
 power1_label		"pin"
 power1_input		Measured input power. From READ_PIN register.
@@ -70,4 +70,4 @@ temp1_max		Maximum temperature. From OT_WARN_LIMIT register.
 temp1_crit		Critical high temperature. From OT_FAULT_LIMIT register.
 
 temp2_input		Measured temperature. From READ_TEMPERATURE_2 register.
-=========================================================
+================	========================================================

       reply	other threads:[~2026-01-29  7:18 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20260126063712.1049025-1-hsu.yungteng@gmail.com>
     [not found] ` <20260126063712.1049025-2-hsu.yungteng@gmail.com>
     [not found]   ` <46a42764-6cf0-46c8-b764-4c4b394b04d0@roeck-us.net>
2026-01-29  7:17     ` Mauro Carvalho Chehab [this message]
2026-01-29 14:14       ` [PATCH v7 2/2] hwmon: pmbus: add support for STEF48H28 Guenter Roeck

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260129081743.50ab5a66@foz.lan \
    --to=mchehab+huawei@kernel.org \
    --cc=broonie@kernel.org \
    --cc=conor+dt@kernel.org \
    --cc=corbet@lwn.net \
    --cc=devicetree@vger.kernel.org \
    --cc=hsu.yungteng@gmail.com \
    --cc=krzk+dt@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-hwmon@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@roeck-us.net \
    --cc=robh@kernel.org \
    --cc=skhan@linuxfoundation.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox