Commit e0a99a83 authored by Anna-Maria Behnsen's avatar Anna-Maria Behnsen Committed by Thomas Gleixner
Browse files

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: default avatarAnna-Maria Behnsen <anna-maria@linutronix.de>
Signed-off-by: default avatarThomas Gleixner <tglx@linutronix.de>
Link: https://lore.kernel.org/r/20230515162038.62703-1-anna-maria@linutronix.de
parent 33af38d8

Documentation/core-api/cpu_hotplug.rst

+5 −5
Original line number Diff line number Diff line
@@ -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;

   ....

include/linux/cpuhotplug.h

+1 −1
Original line number Diff line number Diff line
@@ -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