All of lore.kernel.org
 help / color / mirror / Atom feed
From: Guenter Roeck <linux@roeck-us.net>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Jonathan Corbet <corbet@lwn.net>,
	Jean Delvare <jdelvare@suse.com>,
	Vadim Pasternak <vadimp@nvidia.com>,
	linux-hwmon@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2 17/24] docs: hwmon: mp2975.rst: address some html build warnings
Date: Tue, 13 Oct 2020 09:48:42 -0700	[thread overview]
Message-ID: <20201013164842.GI251780@roeck-us.net> (raw)
In-Reply-To: <8418e2062b82314ceae5da7404fad7b2d3a3fa9a.1602590106.git.mchehab+huawei@kernel.org>

On Tue, Oct 13, 2020 at 02:14:44PM +0200, Mauro Carvalho Chehab wrote:
>     .../Documentation/hwmon/mp2975.rst:25: WARNING: Unexpected indentation.
>     .../Documentation/hwmon/mp2975.rst:27: WARNING: Block quote ends without a blank line; unexpected unindent.
>     .../Documentation/hwmon/mp2975.rst:69: WARNING: Unexpected indentation.
>     .../Documentation/hwmon/mp2975.rst:70: WARNING: Block quote ends without a blank line; unexpected unindent.
>     .../Documentation/hwmon/mp2975.rst:72: WARNING: Bullet list ends without a blank line; unexpected unindent.
>     .../Documentation/hwmon/mp2975.rst: WARNING: document isn't included in any toctree
> 
> List blocks should have blank lines before and after them,
> in order to be properly parsed.
> 
> Fixes: 4beb7a028e9f ("hwmon: (pmbus) Add support for MPS Multi-phase mp2975 controller")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

Acked-by: Guenter Roeck <linux@roeck-us.net>

> ---
>  Documentation/hwmon/index.rst  |  1 +
>  Documentation/hwmon/mp2975.rst | 14 +++++++++++++-
>  2 files changed, 14 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst
> index e6b91ab12978..b797db738225 100644
> --- a/Documentation/hwmon/index.rst
> +++ b/Documentation/hwmon/index.rst
> @@ -132,6 +132,7 @@ Hardware Monitoring Kernel Drivers
>     mcp3021
>     menf21bmc
>     mlxreg-fan
> +   mp2975
>     nct6683
>     nct6775
>     nct7802
> diff --git a/Documentation/hwmon/mp2975.rst b/Documentation/hwmon/mp2975.rst
> index 5b0609c62f48..81d816b71490 100644
> --- a/Documentation/hwmon/mp2975.rst
> +++ b/Documentation/hwmon/mp2975.rst
> @@ -20,6 +20,7 @@ This driver implements support for Monolithic Power Systems, Inc. (MPS)
>  vendor dual-loop, digital, multi-phase controller MP2975.
>  
>  This device:
> +
>  - Supports up to two power rail.
>  - Provides 8 pulse-width modulations (PWMs), and can be configured up
>    to 8-phase operation for rail 1 and up to 4-phase operation for rail
> @@ -32,10 +33,12 @@ This device:
>    10-mV DAC, IMVP9 mode with 5-mV DAC.
>  
>  Device supports:
> +
>  - SVID interface.
>  - AVSBus interface.
>  
>  Device complaint with:
> +
>  - PMBus rev 1.3 interface.
>  
>  Device supports direct format for reading output current, output voltage,
> @@ -45,11 +48,14 @@ Device supports VID and direct formats for reading output voltage.
>  The below VID modes are supported: VR12, VR13, IMVP9.
>  
>  The driver provides the next attributes for the current:
> +
>  - for current in: input, maximum alarm;
>  - for current out input, maximum alarm and highest values;
>  - for phase current: input and label.
> -attributes.
> +  attributes.
> +
>  The driver exports the following attributes via the 'sysfs' files, where
> +
>  - 'n' is number of telemetry pages (from 1 to 2);
>  - 'k' is number of configured phases (from 1 to 8);
>  - indexes 1, 1*n for "iin";
> @@ -65,11 +71,14 @@ The driver exports the following attributes via the 'sysfs' files, where
>  **curr[1-{2n+k}]_label**
>  
>  The driver provides the next attributes for the voltage:
> +
>  - for voltage in: input, high critical threshold, high critical alarm, all only
>    from page 0;
>  - for voltage out: input, low and high critical thresholds, low and high
>    critical alarms, from pages 0 and 1;
> +
>  The driver exports the following attributes via the 'sysfs' files, where
> +
>  - 'n' is number of telemetry pages (from 1 to 2);
>  - indexes 1 for "iin";
>  - indexes n+1, n+2 for "vout";
> @@ -87,9 +96,12 @@ The driver exports the following attributes via the 'sysfs' files, where
>  **in[2-{n+1}1_lcrit_alarm**
>  
>  The driver provides the next attributes for the power:
> +
>  - for power in alarm and input.
>  - for power out: highest and input.
> +
>  The driver exports the following attributes via the 'sysfs' files, where
> +
>  - 'n' is number of telemetry pages (from 1 to 2);
>  - indexes 1 for "pin";
>  - indexes n+1, n+2 for "pout";
> -- 
> 2.26.2
> 

  reply	other threads:[~2020-10-13 16:48 UTC|newest]

Thread overview: 72+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-13 12:14 [PATCH v2 00/24] Documentation build fixes against next-20201013 Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 01/24] docs: hwmon: adm1266.rst: fix a broken reference Mauro Carvalho Chehab
2020-10-13 16:48   ` Guenter Roeck
2020-10-13 12:14 ` [PATCH v2 02/24] tools: docs: memory-model: fix references for some files Mauro Carvalho Chehab
2020-10-13 16:33   ` Paul E. McKenney
2020-10-13 16:38     ` Alan Stern
2020-10-14  1:58       ` Paul E. McKenney
2020-10-14  7:56         ` Mauro Carvalho Chehab
2020-10-14 14:14           ` Akira Yokosawa
2020-10-14 14:39             ` Mauro Carvalho Chehab
2020-10-14 18:57         ` Paul E. McKenney
2020-10-15  5:15           ` Mauro Carvalho Chehab
2020-10-15 10:30             ` Peter Zijlstra
2020-10-13 12:14 ` [PATCH v2 03/24] docs: SafeSetID: fix a warning Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 04/24] docs: lockdep-design: fix some warning issues Mauro Carvalho Chehab
2020-10-13 12:52   ` Peter Zijlstra
2020-10-13 13:11     ` Matthew Wilcox
2020-10-13 14:09       ` Peter Zijlstra
2020-10-13 15:02         ` Matthew Wilcox
2020-10-14 16:04           ` Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 05/24] docs: admin-guide: net.rst: add a missing blank line Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 06/24] blk-mq: docs: add kernel-doc description for a new struct member Mauro Carvalho Chehab
2020-10-13 13:29   ` John Garry
2020-10-13 19:12   ` Jens Axboe
2020-10-13 12:14 ` [PATCH v2 07/24] drm: amdgpu: kernel-doc: update some adev parameters Mauro Carvalho Chehab
2020-10-13 12:14   ` Mauro Carvalho Chehab
2020-10-13 12:14   ` Mauro Carvalho Chehab
2020-10-13 12:41   ` Christian König
2020-10-13 12:41     ` Christian König
2020-10-13 12:41     ` Christian König
2020-10-13 12:14 ` [PATCH v2 08/24] drm: kernel-doc: document drm_dp_set_subconnector_property() params Mauro Carvalho Chehab
2020-10-13 12:14   ` Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 09/24] docs: kasan.rst: add two missing blank lines Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 10/24] mm: pagemap.h: fix two kernel-doc markups Mauro Carvalho Chehab
2020-10-13 12:26   ` Matthew Wilcox
2020-10-21  9:55     ` Mauro Carvalho Chehab
2020-10-21 11:28       ` Matthew Wilcox
2020-10-21 11:59         ` Mauro Carvalho Chehab
2020-10-21 12:02           ` Matthew Wilcox
2020-10-13 12:14 ` [PATCH v2 11/24] drm/dp: fix kernel-doc warnings at drm_dp_helper.c Mauro Carvalho Chehab
2020-10-13 12:14   ` Mauro Carvalho Chehab
2020-10-13 19:20   ` Lyude Paul
2020-10-13 19:20     ` Lyude Paul
2020-10-13 12:14 ` [PATCH v2 12/24] drm/dp: fix a kernel-doc issue at drm_edid.c Mauro Carvalho Chehab
2020-10-13 12:14   ` Mauro Carvalho Chehab
2020-10-13 19:24   ` Lyude Paul
2020-10-13 19:24     ` Lyude Paul
2020-10-13 19:49   ` Lyude Paul
2020-10-13 19:49     ` Lyude Paul
2020-10-21 10:11     ` Mauro Carvalho Chehab
2020-10-21 10:11       ` Mauro Carvalho Chehab
2020-10-21 16:56       ` Lyude Paul
2020-10-21 16:56         ` Lyude Paul
2020-10-13 12:14 ` [PATCH v2 13/24] docs: i2c: index.rst: add slave-testunit-backend.rst Mauro Carvalho Chehab
2020-10-13 15:53   ` Wolfram Sang
2020-10-13 12:14 ` [PATCH v2 14/24] docs: conf.py: disable automarkup for Sphinx 3.x Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 15/24] docs: net: statistics.rst: remove a duplicated kernel-doc Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 16/24] seqlock: fix two kernel-doc warnings Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 17/24] docs: hwmon: mp2975.rst: address some html build warnings Mauro Carvalho Chehab
2020-10-13 16:48   ` Guenter Roeck [this message]
2020-10-13 12:14 ` [PATCH v2 18/24] docs: userspace-api: add iommu.rst to the index file Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 19/24] net: phy: remove kernel-doc duplication Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 20/24] MAINTAINERS: fix broken doc refs due to yaml conversion Mauro Carvalho Chehab
2020-10-13 12:14   ` Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 21/24] crypto: sun8x-ce*: update entries to its documentation Mauro Carvalho Chehab
2020-10-13 12:14   ` Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 22/24] ice: docs fix a devlink info that broke a table Mauro Carvalho Chehab
2020-10-13 22:01   ` Jacob Keller
2020-10-13 12:14 ` [PATCH v2 23/24] RDMA: add a missing kernel-doc parameter markup Mauro Carvalho Chehab
2020-10-16 16:57   ` Jason Gunthorpe
2020-10-13 12:14 ` [PATCH v2 24/24] counters: docs: add a missing include Mauro Carvalho Chehab
2020-10-15  1:06   ` Shuah Khan

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=20201013164842.GI251780@roeck-us.net \
    --to=linux@roeck-us.net \
    --cc=corbet@lwn.net \
    --cc=jdelvare@suse.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-hwmon@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab+huawei@kernel.org \
    --cc=vadimp@nvidia.com \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.