kernel: fix cpu_mask api documentation

nashif · mbolivar-nordic · commit 8d7a4f79fb1c · 2022-04-15T16:14:14.000-07:00
wrong kconfig is being used in the note, DEADLINE is not related to cpu
mask APIs.

Signed-off-by: Anas Nashif &lt;anas.nashif@intel.com&gt;
diff --git a/include/zephyr/kernel.h b/include/zephyr/kernel.h
@@ -756,7 +756,7 @@ __syscall void k_thread_deadline_set(k_tid_t thread, int deadline);
  * After this returns, the thread will no longer be schedulable on any
  * CPUs.  The thread must not be currently runnable.
  *
- * @note You should enable @kconfig{CONFIG_SCHED_DEADLINE} in your project
+ * @note You should enable @kconfig{CONFIG_SCHED_CPU_MASK} in your project
  * configuration.
  *
  * @param thread Thread to operate upon
@@ -770,7 +770,7 @@ int k_thread_cpu_mask_clear(k_tid_t thread);
  * After this returns, the thread will be schedulable on any CPU.  The
  * thread must not be currently runnable.
  *
- * @note You should enable @kconfig{CONFIG_SCHED_DEADLINE} in your project
+ * @note You should enable @kconfig{CONFIG_SCHED_CPU_MASK} in your project
  * configuration.
  *
  * @param thread Thread to operate upon
@@ -783,7 +783,7 @@ int k_thread_cpu_mask_enable_all(k_tid_t thread);
  *
  * The thread must not be currently runnable.
  *
- * @note You should enable @kconfig{CONFIG_SCHED_DEADLINE} in your project
+ * @note You should enable @kconfig{CONFIG_SCHED_CPU_MASK} in your project
  * configuration.
  *
  * @param thread Thread to operate upon
@@ -797,7 +797,7 @@ int k_thread_cpu_mask_enable(k_tid_t thread, int cpu);
  *
  * The thread must not be currently runnable.
  *
- * @note You should enable @kconfig{CONFIG_SCHED_DEADLINE} in your project
+ * @note You should enable @kconfig{CONFIG_SCHED_CPU_MASK} in your project
  * configuration.
  *
  * @param thread Thread to operate upon

Original file line number	Diff line number	Diff line change
`@@ -756,7 +756,7 @@ __syscall void k_thread_deadline_set(k_tid_t thread, int deadline);`
`756`	`756`	`* After this returns, the thread will no longer be schedulable on any`
`757`	`757`	`* CPUs. The thread must not be currently runnable.`
`758`	`758`	`*`
`759`		`- * @note You should enable @kconfig{CONFIG_SCHED_DEADLINE} in your project`
	`759`	`+ * @note You should enable @kconfig{CONFIG_SCHED_CPU_MASK} in your project`
`760`	`760`	`* configuration.`
`761`	`761`	`*`
`762`	`762`	`* @param thread Thread to operate upon`
`@@ -770,7 +770,7 @@ int k_thread_cpu_mask_clear(k_tid_t thread);`
`770`	`770`	`* After this returns, the thread will be schedulable on any CPU. The`
`771`	`771`	`* thread must not be currently runnable.`
`772`	`772`	`*`
`773`		`- * @note You should enable @kconfig{CONFIG_SCHED_DEADLINE} in your project`
	`773`	`+ * @note You should enable @kconfig{CONFIG_SCHED_CPU_MASK} in your project`
`774`	`774`	`* configuration.`
`775`	`775`	`*`
`776`	`776`	`* @param thread Thread to operate upon`
`@@ -783,7 +783,7 @@ int k_thread_cpu_mask_enable_all(k_tid_t thread);`
`783`	`783`	`*`
`784`	`784`	`* The thread must not be currently runnable.`
`785`	`785`	`*`
`786`		`- * @note You should enable @kconfig{CONFIG_SCHED_DEADLINE} in your project`
	`786`	`+ * @note You should enable @kconfig{CONFIG_SCHED_CPU_MASK} in your project`
`787`	`787`	`* configuration.`
`788`	`788`	`*`
`789`	`789`	`* @param thread Thread to operate upon`
`@@ -797,7 +797,7 @@ int k_thread_cpu_mask_enable(k_tid_t thread, int cpu);`
`797`	`797`	`*`
`798`	`798`	`* The thread must not be currently runnable.`
`799`	`799`	`*`
`800`		`- * @note You should enable @kconfig{CONFIG_SCHED_DEADLINE} in your project`
	`800`	`+ * @note You should enable @kconfig{CONFIG_SCHED_CPU_MASK} in your project`
`801`	`801`	`* configuration.`
`802`	`802`	`*`
`803`	`803`	`* @param thread Thread to operate upon`