power: supply: Fix power limit documentation
PATCH 1/1 power: supply: Fix power limit documentation
The documentation for the input current and voltage limits recommends using those properties for problems that can be solved using a power limit. This contradicts the recommendation to prefer input_power_limit for such cases.
Similarly, the input_power_limit documentation recommends using the current or voltage limits for problems that can be solved with a power limit, which conveys the opposite of the intended meaning.
Fix the wording to clarify that input_power_limit should be preferred whenever a power limit can address the problem, while current or voltage limits should be used when it cannot.
--- Documentation/ABI/testing/sysfs-class-power | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)
Documentation/ABI/testing/sysfs-class-power +5 -5
@@ -600,8 +600,8 @@ Description: supply. Normally this is configured based on the type of connection made (e.g. A configured SDP should output a maximum of 500mA so the input current limit is set to the same value). - Use preferably input_power_limit, and for problems that can be - solved using power limit use input_current_limit. + Use preferably input_power_limit, and for problems that can not + be solved using power limit use input_current_limit. Access: Read, Write
@@ -618,8 +618,8 @@ Description: input power to 5V when the screen is on to meet Google's skin temperature targets). Note that this feature should not be used for safety critical things. - Use preferably input_power_limit, and for problems that can be - solved using power limit use input_voltage_limit. + Use preferably input_power_limit, and for problems that can not + be solved using power limit use input_voltage_limit. Access: Read, Write
@@ -633,7 +633,7 @@ Description: in the supply. Normally this is configured based on system-level knowledge or user input. Use preferably this feature to limit the incoming power and use current/voltage - limit only for problems that can be solved using power limit. + limit only for problems that can not be solved using power limit. Access: Read, Write
Signature · 1 line
2.43.0
Hi,
Quoted 5 lines · Daniel Lezcano
The documentation for the input current and voltage limits recommends using those properties for problems that can be solved using a power limit. This contradicts the recommendation to prefer
input_power_limitfor such cases.
Quoted 7 lines
Similarly, the
input_power_limitdocumentation recommends using the current or voltage limits for problems that can be solved with a power limit, which conveys the opposite of the intended meaning.Fix the wording to clarify that
input_power_limitshould be preferred whenever a power limit can address the problem, while current or voltage limits should be used when it cannot.
Patch LGTM.
Quoted 2 lines
Signed-off-by Daniel Lezcano <[email protected]>Signed-off-by Daniel Lezcano <[email protected]>
Is this intentional?
Greetings,
-- Sebastian
Quoted 42 lines
--- Documentation/ABI/testing/sysfs-class-power | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)Documentation/ABI/testing/sysfs-class-power +5
-5@@ -600,8 +600,8 @@ Description: supply. Normally this is configured based on the type of connection made (e.g. A configured SDP should output a maximum of 500mA so the input current limit is set to the same value). - Use preferably input_power_limit, and for problems that can be - solved using power limit use input_current_limit. + Use preferably input_power_limit, and for problems that can not + be solved using power limit use input_current_limit. Access: Read, Write@@ -618,8 +618,8 @@ Description: input power to 5V when the screen is on to meet Google's skin temperature targets). Note that this feature should not be used for safety critical things. - Use preferably input_power_limit, and for problems that can be - solved using power limit use input_voltage_limit. + Use preferably input_power_limit, and for problems that can not + be solved using power limit use input_voltage_limit. Access: Read, Write@@ -633,7 +633,7 @@ Description: in the supply. Normally this is configured based on system-level knowledge or user input. Use preferably this feature to limit the incoming power and use current/voltage - limit only for problems that can be solved using power limit. + limit only for problems that can not be solved using power limit. Access: Read, WriteSignature · 1 line
2.43.0
Quoted 16 lines · Sebastian Reichel
Hi,
Quoted 5 lines · Daniel Lezcano
The documentation for the input current and voltage limits recommends using those properties for problems that can be solved using a power limit. This contradicts the recommendation to prefer
input_power_limitfor such cases.Quoted 7 lines
Similarly, the
input_power_limitdocumentation recommends using the current or voltage limits for problems that can be solved with a power limit, which conveys the opposite of the intended meaning.Fix the wording to clarify that
input_power_limitshould be preferred whenever a power limit can address the problem, while current or voltage limits should be used when it cannot.
Quoted 6 lines
Patch LGTM.
Quoted 2 lines
Signed-off-by Daniel Lezcano <[email protected]>Signed-off-by Daniel Lezcano <[email protected]>Is this intentional?
No, my scripts again ...
Do you want me to resend or can you delete the kernel.org one ?
Sebastian Reichel
AppliedQuoted 10 lines · Daniel Lezcano
The documentation for the input current and voltage limits recommends using those properties for problems that can be solved using a power limit. This contradicts the recommendation to prefer
input_power_limitfor such cases.Similarly, the
input_power_limitdocumentation recommends using the current or voltage limits for problems that can be solved with a power limit, which conveys the opposite of the intended meaning.[...]
Applied, thanks!
[1/1] power: supply: Fix power limit documentation
commit: 23a00d8fb0452a4b182f4fea01e244f47758f4ee
Best regards,
Signature · 1 line
Sebastian Reichel <[email protected]>