From: kernel test robot <lkp@intel.com>
To: " Iván Ezequiel Rodriguez" <ivanrwcm25@gmail.com>
Cc: oe-kbuild-all@lists.linux.dev,
Sebastian Reichel <sebastian.reichel@collabora.com>,
linux-doc@vger.kernel.org
Subject: [sre-power-supply:for-next 45/66] htmldocs: Documentation/power/power_supply_class.rst:211: WARNING: Inline emphasis start-string without end-string. [docutils]
Date: Mon, 05 Oct 2026 04:59:32 +0200 [thread overview]
Message-ID: <202610050416.L69x2Wpo-lkp@intel.com> (raw)
tree: https://git.kernel.org/pub/scm/linux/kernel/git/sre/linux-power-supply.git for-next
head: 5c1c602463d597c5189ddc5a73dece588ba2c57a
commit: 420a1e2763b5df3ed90f92d97cf30fe43822bba8 [45/66] docs: power: supply: fix power_supply_class.rst status, health and time_to
compiler: clang version 22.1.8 (https://github.com/llvm/llvm-project ca7933e47d3a3451d81e72ac174dcb5aa28b59d1)
docutils: docutils (Docutils 0.21.2, Python 3.13.5, on linux)
reproduce: (https://download.01.org/0day-ci/archive/20261005/202610050416.L69x2Wpo-lkp@intel.com/reproduce)
If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202610050416.L69x2Wpo-lkp@intel.com/
All warnings (new ones prefixed by >>):
Implicit creation
----------------- [docutils]
WARNING: ./include/net/page_pool/types.h:105 Excess struct member 'fast' description in 'page_pool_params' (did you mean one of: 'flags', 'offset')
WARNING: ./include/net/page_pool/types.h:105 Excess struct member 'slow' description in 'page_pool_params'
>> Documentation/power/power_supply_class.rst:211: WARNING: Inline emphasis start-string without end-string. [docutils]
>> Documentation/power/power_supply_class.rst:211: WARNING: Inline emphasis start-string without end-string. [docutils]
Documentation/trace/events-landlock:314: ./include/trace/events/landlock.h:155: ERROR: Unexpected section title.
vim +211 Documentation/power/power_supply_class.rst
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 73
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 74 Postfixes:
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 75
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 76 _AVG
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 77 *hardware* averaged value, use it if your hardware is really able to
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 78 report averaged values.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 79 _NOW
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 80 momentary/instantaneous values.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 81
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 82 STATUS
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 83 this attribute represents operating status (charging, full,
06b54f2d741b63e Randy Dunlap 2025-10-14 84 discharging (i.e., powering a load), etc.). This corresponds to
420a1e2763b5df3 Iván Ezequiel Rodriguez 2026-08-31 85 `POWER_SUPPLY_STATUS_*` values, as defined in
420a1e2763b5df3 Iván Ezequiel Rodriguez 2026-08-31 86 include/linux/power_supply.h.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 87
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 88 CHARGE_TYPE
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 89 batteries can typically charge at different rates.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 90 This defines trickle and fast charges. For batteries that
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 91 are already charged or discharging, 'n/a' can be displayed (or
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 92 'unknown', if the status is not known).
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 93
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 94 AUTHENTIC
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 95 indicates the power supply (battery or charger) connected
06b54f2d741b63e Randy Dunlap 2025-10-14 96 to the platform is authentic(1) or non-authentic(0).
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 97
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 98 HEALTH
420a1e2763b5df3 Iván Ezequiel Rodriguez 2026-08-31 99 represents health of the battery. Values correspond to
420a1e2763b5df3 Iván Ezequiel Rodriguez 2026-08-31 100 POWER_SUPPLY_HEALTH_*, defined in include/linux/power_supply.h.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 101
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 102 VOLTAGE_OCV
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 103 open circuit voltage of the battery.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 104
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 105 VOLTAGE_MAX_DESIGN, VOLTAGE_MIN_DESIGN
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 106 design values for maximal and minimal power supply voltages.
06b54f2d741b63e Randy Dunlap 2025-10-14 107 Maximal/minimal means values of voltages when battery is considered
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 108 "full"/"empty" at normal conditions. Yes, there is no direct relation
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 109 between voltage and battery capacity, but some dumb
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 110 batteries use voltage for very approximated calculation of capacity.
06b54f2d741b63e Randy Dunlap 2025-10-14 111 A battery driver also can use this attribute just to inform userspace
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 112 about maximal and minimal voltage thresholds of a given battery.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 113
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 114 VOLTAGE_MAX, VOLTAGE_MIN
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 115 same as _DESIGN voltage values except that these ones should be used
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 116 if hardware could only guess (measure and retain) the thresholds of a
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 117 given power supply.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 118
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 119 VOLTAGE_BOOT
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 120 Reports the voltage measured during boot
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 121
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 122 CURRENT_BOOT
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 123 Reports the current measured during boot
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 124
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 125 CHARGE_FULL_DESIGN, CHARGE_EMPTY_DESIGN
06b54f2d741b63e Randy Dunlap 2025-10-14 126 design charge values, when battery is considered full/empty.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 127
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 128 ENERGY_FULL_DESIGN, ENERGY_EMPTY_DESIGN
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 129 same as above but for energy.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 130
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 131 CHARGE_FULL, CHARGE_EMPTY
06b54f2d741b63e Randy Dunlap 2025-10-14 132 These attributes mean "last remembered value of charge when battery
06b54f2d741b63e Randy Dunlap 2025-10-14 133 became full/empty". They also could mean "value of charge when battery is
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 134 considered full/empty at given conditions (temperature, age)".
06b54f2d741b63e Randy Dunlap 2025-10-14 135 I.e., these attributes represents real thresholds, not design values.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 136
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 137 ENERGY_FULL, ENERGY_EMPTY
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 138 same as above but for energy.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 139
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 140 CHARGE_COUNTER
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 141 the current charge counter (in µAh). This could easily
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 142 be negative; there is no empty or full value. It is only useful for
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 143 relative, time-based measurements.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 144
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 145 PRECHARGE_CURRENT
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 146 the maximum charge current during precharge phase of charge cycle
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 147 (typically 20% of battery capacity).
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 148
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 149 CHARGE_TERM_CURRENT
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 150 Charge termination current. The charge cycle terminates when battery
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 151 voltage is above recharge threshold, and charge current is below
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 152 this setting (typically 10% of battery capacity).
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 153
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 154 CONSTANT_CHARGE_CURRENT
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 155 constant charge current programmed by charger.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 156
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 157 CONSTANT_CHARGE_CURRENT_MAX
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 158 maximum charge current supported by the power supply object.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 159
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 160 CONSTANT_CHARGE_VOLTAGE
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 161 constant charge voltage programmed by charger.
06b54f2d741b63e Randy Dunlap 2025-10-14 162
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 163 CONSTANT_CHARGE_VOLTAGE_MAX
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 164 maximum charge voltage supported by the power supply object.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 165
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 166 INPUT_CURRENT_LIMIT
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 167 input current limit programmed by charger. Indicates
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 168 the current drawn from a charging source.
5fe7b600a116187 Linus Torvalds 2019-07-15 169 INPUT_VOLTAGE_LIMIT
5fe7b600a116187 Linus Torvalds 2019-07-15 170 input voltage limit programmed by charger. Indicates
5fe7b600a116187 Linus Torvalds 2019-07-15 171 the voltage limit from a charging source.
5fe7b600a116187 Linus Torvalds 2019-07-15 172 INPUT_POWER_LIMIT
5fe7b600a116187 Linus Torvalds 2019-07-15 173 input power limit programmed by charger. Indicates
5fe7b600a116187 Linus Torvalds 2019-07-15 174 the power limit from a charging source.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 175
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 176 CHARGE_CONTROL_LIMIT
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 177 current charge control limit setting
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 178 CHARGE_CONTROL_LIMIT_MAX
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 179 maximum charge control limit setting
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 180
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 181 CALIBRATE
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 182 battery or coulomb counter calibration status
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 183
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 184 CAPACITY
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 185 capacity in percents.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 186 CAPACITY_ALERT_MIN
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 187 minimum capacity alert value in percents.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 188 CAPACITY_ALERT_MAX
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 189 maximum capacity alert value in percents.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 190 CAPACITY_LEVEL
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 191 capacity level. This corresponds to POWER_SUPPLY_CAPACITY_LEVEL_*.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 192
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 193 TEMP
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 194 temperature of the power supply.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 195 TEMP_ALERT_MIN
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 196 minimum battery temperature alert.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 197 TEMP_ALERT_MAX
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 198 maximum battery temperature alert.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 199 TEMP_AMBIENT
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 200 ambient temperature.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 201 TEMP_AMBIENT_ALERT_MIN
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 202 minimum ambient temperature alert.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 203 TEMP_AMBIENT_ALERT_MAX
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 204 maximum ambient temperature alert.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 205 TEMP_MIN
420a1e2763b5df3 Iván Ezequiel Rodriguez 2026-08-31 206 minimum operable temperature
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 207 TEMP_MAX
420a1e2763b5df3 Iván Ezequiel Rodriguez 2026-08-31 208 maximum operable temperature
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 209
420a1e2763b5df3 Iván Ezequiel Rodriguez 2026-08-31 210 TIME_TO_EMPTY_NOW, TIME_TO_EMPTY_AVG
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 @211 seconds left for battery to be considered empty
420a1e2763b5df3 Iván Ezequiel Rodriguez 2026-08-31 212 (i.e., while battery powers a load). *_NOW is a
420a1e2763b5df3 Iván Ezequiel Rodriguez 2026-08-31 213 momentary reading; *_AVG is averaged over a fixed period.
420a1e2763b5df3 Iván Ezequiel Rodriguez 2026-08-31 214 TIME_TO_FULL_NOW, TIME_TO_FULL_AVG
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 215 seconds left for battery to be considered full
420a1e2763b5df3 Iván Ezequiel Rodriguez 2026-08-31 216 (i.e., while battery is charging). Same now/avg distinction.
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 217
151f4e2bdc7a040 Mauro Carvalho Chehab 2019-06-13 218
:::::: The code at line 211 was first introduced by commit
:::::: 151f4e2bdc7a04020ae5c533896fb91a16e1f501 docs: power: convert docs to ReST and rename to *.rst
:::::: TO: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
:::::: CC: Bjorn Helgaas <bhelgaas@google.com>
--
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki
reply other threads:[~2026-10-05 3:00 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=202610050416.L69x2Wpo-lkp@intel.com \
--to=lkp@intel.com \
--cc=ivanrwcm25@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=oe-kbuild-all@lists.linux.dev \
--cc=sebastian.reichel@collabora.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.