Dynamic allocated hotplug states in documentation and comment above
cpuhp_state enum do not match the code. To not get confused by wrong
documentation, change to proper state names.
Signed-off-by: Anna-Maria Behnsen <[email protected]>
---
Documentation/core-api/cpu_hotplug.rst | 10 +++++-----
include/linux/cpuhotplug.h | 2 +-
2 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/Documentation/core-api/cpu_hotplug.rst b/Documentation/core-api/cpu_hotplug.rst
index f75778d37488..95ead18dd9e0 100644
--- a/Documentation/core-api/cpu_hotplug.rst
+++ b/Documentation/core-api/cpu_hotplug.rst
@@ -404,8 +404,8 @@ multi-instance state the following function is available:
* cpuhp_setup_state_multi(state, name, startup, teardown)
The @state argument is either a statically allocated state or one of the
-constants for dynamically allocated states - CPUHP_PREPARE_DYN,
-CPUHP_ONLINE_DYN - depending on the state section (PREPARE, ONLINE) for
+constants for dynamically allocated states - CPUHP_BP_PREPARE_DYN,
+CPUHP_AP_ONLINE_DYN - depending on the state section (PREPARE, ONLINE) for
which a dynamic state should be allocated.
The @name argument is used for sysfs output and for instrumentation. The
@@ -597,7 +597,7 @@ notifications on online and offline operations::
Setup and teardown a dynamically allocated state in the ONLINE section
for notifications on offline operations::
- state = cpuhp_setup_state(CPUHP_ONLINE_DYN, "subsys:offline", NULL, subsys_cpu_offline);
+ state = cpuhp_setup_state(CPUHP_AP_ONLINE_DYN, "subsys:offline", NULL, subsys_cpu_offline);
if (state < 0)
return state;
....
@@ -606,7 +606,7 @@ for notifications on offline operations::
Setup and teardown a dynamically allocated state in the ONLINE section
for notifications on online operations without invoking the callbacks::
- state = cpuhp_setup_state_nocalls(CPUHP_ONLINE_DYN, "subsys:online", subsys_cpu_online, NULL);
+ state = cpuhp_setup_state_nocalls(CPUHP_AP_ONLINE_DYN, "subsys:online", subsys_cpu_online, NULL);
if (state < 0)
return state;
....
@@ -615,7 +615,7 @@ for notifications on online operations without invoking the callbacks::
Setup, use and teardown a dynamically allocated multi-instance state in the
ONLINE section for notifications on online and offline operation::
- state = cpuhp_setup_state_multi(CPUHP_ONLINE_DYN, "subsys:online", subsys_cpu_online, subsys_cpu_offline);
+ state = cpuhp_setup_state_multi(CPUHP_AP_ONLINE_DYN, "subsys:online", subsys_cpu_online, subsys_cpu_offline);
if (state < 0)
return state;
....
diff --git a/include/linux/cpuhotplug.h b/include/linux/cpuhotplug.h
index 0f1001dca0e0..7b30f5cbf415 100644
--- a/include/linux/cpuhotplug.h
+++ b/include/linux/cpuhotplug.h
@@ -48,7 +48,7 @@
* same section.
*
* If neither #1 nor #2 apply, please use the dynamic state space when
- * setting up a state by using CPUHP_PREPARE_DYN or CPUHP_PREPARE_ONLINE
+ * setting up a state by using CPUHP_BP_PREPARE_DYN or CPUHP_AP_ONLINE_DYN
* for the @state argument of the setup function.
*
* See Documentation/core-api/cpu_hotplug.rst for further information and
--
2.30.2
On Mon, May 15 2023 at 18:20, Anna-Maria Behnsen wrote:
> Dynamic allocated hotplug states in documentation and comment above
> cpuhp_state enum do not match the code. To not get confused by wrong
> documentation, change to proper state names.
>
> Signed-off-by: Anna-Maria Behnsen <[email protected]>
Reviewed-by: Thomas Gleixner <[email protected]>
On Mon, 15 May 2023, Thomas Gleixner wrote:
> On Mon, May 15 2023 at 18:20, Anna-Maria Behnsen wrote:
>
> > Dynamic allocated hotplug states in documentation and comment above
> > cpuhp_state enum do not match the code. To not get confused by wrong
> > documentation, change to proper state names.
> >
> > Signed-off-by: Anna-Maria Behnsen <[email protected]>
>
> Reviewed-by: Thomas Gleixner <[email protected]>
>
Ping?
Anna-Maria Behnsen <[email protected]> writes:
> On Mon, 15 May 2023, Thomas Gleixner wrote:
>
>> On Mon, May 15 2023 at 18:20, Anna-Maria Behnsen wrote:
>>
>> > Dynamic allocated hotplug states in documentation and comment above
>> > cpuhp_state enum do not match the code. To not get confused by wrong
>> > documentation, change to proper state names.
>> >
>> > Signed-off-by: Anna-Maria Behnsen <[email protected]>
>>
>> Reviewed-by: Thomas Gleixner <[email protected]>
>>
>
> Ping?
I didn't pick this up because linux/cpuhotplug.h is a bit outside my
turf; I can certainly do so, though, if that seems like the best path.
jon
The following commit has been merged into the smp/core branch of tip:
Commit-ID: e0a99a839f04c90bf9f16919997c4b34f9c8f1f0
Gitweb: https://git.kernel.org/tip/e0a99a839f04c90bf9f16919997c4b34f9c8f1f0
Author: Anna-Maria Behnsen <[email protected]>
AuthorDate: Mon, 15 May 2023 18:20:38 +02:00
Committer: Thomas Gleixner <[email protected]>
CommitterDate: Tue, 08 Aug 2023 10:55:58 +02:00
Documentation: core-api/cpuhotplug: Fix state names
Dynamic allocated hotplug states in documentation and the comment above
cpuhp_state enum do not match the code. To not get confused by wrong
documentation, change to proper state names.
Signed-off-by: Anna-Maria Behnsen <[email protected]>
Signed-off-by: Thomas Gleixner <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
---
Documentation/core-api/cpu_hotplug.rst | 10 +++++-----
include/linux/cpuhotplug.h | 2 +-
2 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/Documentation/core-api/cpu_hotplug.rst b/Documentation/core-api/cpu_hotplug.rst
index e6f5bc3..b9ae591 100644
--- a/Documentation/core-api/cpu_hotplug.rst
+++ b/Documentation/core-api/cpu_hotplug.rst
@@ -395,8 +395,8 @@ multi-instance state the following function is available:
* cpuhp_setup_state_multi(state, name, startup, teardown)
The @state argument is either a statically allocated state or one of the
-constants for dynamically allocated states - CPUHP_PREPARE_DYN,
-CPUHP_ONLINE_DYN - depending on the state section (PREPARE, ONLINE) for
+constants for dynamically allocated states - CPUHP_BP_PREPARE_DYN,
+CPUHP_AP_ONLINE_DYN - depending on the state section (PREPARE, ONLINE) for
which a dynamic state should be allocated.
The @name argument is used for sysfs output and for instrumentation. The
@@ -588,7 +588,7 @@ notifications on online and offline operations::
Setup and teardown a dynamically allocated state in the ONLINE section
for notifications on offline operations::
- state = cpuhp_setup_state(CPUHP_ONLINE_DYN, "subsys:offline", NULL, subsys_cpu_offline);
+ state = cpuhp_setup_state(CPUHP_AP_ONLINE_DYN, "subsys:offline", NULL, subsys_cpu_offline);
if (state < 0)
return state;
....
@@ -597,7 +597,7 @@ for notifications on offline operations::
Setup and teardown a dynamically allocated state in the ONLINE section
for notifications on online operations without invoking the callbacks::
- state = cpuhp_setup_state_nocalls(CPUHP_ONLINE_DYN, "subsys:online", subsys_cpu_online, NULL);
+ state = cpuhp_setup_state_nocalls(CPUHP_AP_ONLINE_DYN, "subsys:online", subsys_cpu_online, NULL);
if (state < 0)
return state;
....
@@ -606,7 +606,7 @@ for notifications on online operations without invoking the callbacks::
Setup, use and teardown a dynamically allocated multi-instance state in the
ONLINE section for notifications on online and offline operation::
- state = cpuhp_setup_state_multi(CPUHP_ONLINE_DYN, "subsys:online", subsys_cpu_online, subsys_cpu_offline);
+ state = cpuhp_setup_state_multi(CPUHP_AP_ONLINE_DYN, "subsys:online", subsys_cpu_online, subsys_cpu_offline);
if (state < 0)
return state;
....
diff --git a/include/linux/cpuhotplug.h b/include/linux/cpuhotplug.h
index 25b6e6e..06dda85 100644
--- a/include/linux/cpuhotplug.h
+++ b/include/linux/cpuhotplug.h
@@ -48,7 +48,7 @@
* same section.
*
* If neither #1 nor #2 apply, please use the dynamic state space when
- * setting up a state by using CPUHP_PREPARE_DYN or CPUHP_PREPARE_ONLINE
+ * setting up a state by using CPUHP_BP_PREPARE_DYN or CPUHP_AP_ONLINE_DYN
* for the @state argument of the setup function.
*
* See Documentation/core-api/cpu_hotplug.rst for further information and
On Mon, Aug 07 2023 at 10:44, Jonathan Corbet wrote:
> Anna-Maria Behnsen <[email protected]> writes:
>
>> On Mon, 15 May 2023, Thomas Gleixner wrote:
>>
>>> On Mon, May 15 2023 at 18:20, Anna-Maria Behnsen wrote:
>>>
>>> > Dynamic allocated hotplug states in documentation and comment above
>>> > cpuhp_state enum do not match the code. To not get confused by wrong
>>> > documentation, change to proper state names.
>>> >
>>> > Signed-off-by: Anna-Maria Behnsen <[email protected]>
>>>
>>> Reviewed-by: Thomas Gleixner <[email protected]>
>>>
>>
>> Ping?
>
> I didn't pick this up because linux/cpuhotplug.h is a bit outside my
> turf; I can certainly do so, though, if that seems like the best path.
I'll pick it up.