Re: [PATCH v2 4/5] docs: hwmon: Add documenttaion for acbel-crps PSU

From: kernel test robot
Date: Mon Mar 20 2023 - 22:18:18 EST


Hi Lakshmi,

Thank you for the patch! Perhaps something to improve:

[auto build test WARNING on groeck-staging/hwmon-next]
[also build test WARNING on robh/for-next linus/master v6.3-rc3 next-20230320]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]

url: https://github.com/intel-lab-lkp/linux/commits/Lakshmi-Yadlapati/dt-bindings-vendor-prefixes-Add-prefix-for-acbel/20230320-235222
base: https://git.kernel.org/pub/scm/linux/kernel/git/groeck/linux-staging.git hwmon-next
patch link: https://lore.kernel.org/r/20230320154019.1943770-5-lakshmiy%40us.ibm.com
patch subject: [PATCH v2 4/5] docs: hwmon: Add documenttaion for acbel-crps PSU
reproduce:
# https://github.com/intel-lab-lkp/linux/commit/e44825c6557c3020131598f7a5e842cbaf29cb1f
git remote add linux-review https://github.com/intel-lab-lkp/linux
git fetch --no-tags linux-review Lakshmi-Yadlapati/dt-bindings-vendor-prefixes-Add-prefix-for-acbel/20230320-235222
git checkout e44825c6557c3020131598f7a5e842cbaf29cb1f
make menuconfig
# enable CONFIG_COMPILE_TEST, CONFIG_WARN_MISSING_DOCUMENTS, CONFIG_WARN_ABI_ERRORS
make htmldocs

If you fix the issue, kindly add following tag where applicable
| Reported-by: kernel test robot <lkp@xxxxxxxxx>
| Link: https://lore.kernel.org/oe-kbuild-all/202303211050.D9YSILr1-lkp@xxxxxxxxx/

All warnings (new ones prefixed by >>):

>> Documentation/hwmon/acbel-crps.rst:2: WARNING: Title underline too short.
>> Documentation/hwmon/acbel-crps.rst:7: WARNING: Bullet list ends without a blank line; unexpected unindent.
>> Documentation/hwmon/acbel-crps.rst:30: WARNING: Malformed table.
>> Documentation/hwmon/acbel-crps.rst: WARNING: document isn't included in any toctree

vim +2 Documentation/hwmon/acbel-crps.rst

> 2 =======================
3
4 Supported chips:
5
6 * ACBEL Common Redundant Power Supply.
> 7 Supported models: FSG032-00xG
8
9 Author: Lakshmi Yadlapati <lakshmiy@xxxxxxxxxx>
10
11 Description
12 -----------
13
14 This driver supports ACBEL Common Redundant Power Supply. This driver
15 is a client to the core PMBus driver.
16
17 Usage Notes
18 -----------
19
20 This driver does not auto-detect devices. You will have to instantiate the
21 devices explicitly. Please see Documentation/i2c/instantiating-devices.rst for
22 details.
23
24 Sysfs entries
25 -------------
26
27 The following attributes are supported:
28
29 ======================= ======================================================
> 30 curr1_crit Critical maximum current.
31 curr1_crit_alarm Input current critical alarm.
32 curr1_input Measured output current.
33 curr1_label "iin"
34 curr1_max Maximum input current.
35 curr1_max_alarm Maximum input current high alarm.
36 curr1_rated_max Maximum rated input current.
37 curr2_crit Critical maximum current.
38 curr2_crit_alarm Output current critical alarm.
39 curr2_input Measured output current.
40 curr2_label "iout1"
41 curr2_max Maximum output current.
42 curr2_max_alarm Output current high alarm.
43 curr2_rated_max Maximum rated output current.
44
45

--
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests