Module: xenomai-2.6
Branch: master
Commit: afd5bdfc3e155722219d181483aa2235e5305039
URL:
http://git.xenomai.org/?p=xenomai-2.6.git;a=commit;h=afd5bdfc3e155722219d181483aa2235e5305039
Author: Gilles Chanteperdrix <gilles.chanteperd...@xenomai.org>
Date: Thu Jul 7 12:36:51 2016 +0200
doc/sched: move sched documentation under nucleus section
---
include/nucleus/sched.h | 18 +++++++++---------
ksrc/nucleus/sched.c | 9 +++++++++
2 files changed, 18 insertions(+), 9 deletions(-)
diff --git a/include/nucleus/sched.h b/include/nucleus/sched.h
index 509312d..5bbf757 100644
--- a/include/nucleus/sched.h
+++ b/include/nucleus/sched.h
@@ -38,19 +38,19 @@
#include <nucleus/vfile.h>
/* Sched status flags */
-#define XNKCOUT 0x80000000 /* Sched callout context */
-#define XNINTCK 0x40000000 /* In master tick handler
context */
-#define XNINSW 0x20000000 /* In context switch */
-#define XNRESCHED 0x10000000 /* Needs rescheduling */
+#define XNKCOUT 0x80000000 /*!< Sched callout context */
+#define XNINTCK 0x40000000 /*!< In master tick handler
context */
+#define XNINSW 0x20000000 /*!< In context switch */
+#define XNRESCHED 0x10000000 /*!< Needs rescheduling */
/* Sched local flags */
-#define XNHTICK 0x00008000 /* Host tick pending */
-#define XNINIRQ 0x00004000 /* In IRQ handling context */
-#define XNHDEFER 0x00002000 /* Host tick deferred */
-#define XNINLOCK 0x00001000 /* Scheduler locked */
+#define XNHTICK 0x00008000 /*!< Host tick pending */
+#define XNINIRQ 0x00004000 /*!< In IRQ handling context */
+#define XNHDEFER 0x00002000 /*!< Host tick deferred */
+#define XNINLOCK 0x00001000 /*!< Scheduler locked */
/* Sched RPI status flags */
-#define XNRPICK 0x80000000 /* Check RPI state */
+#define XNRPICK 0x80000000 /*!< Check RPI state */
struct xnsched_rt {
xnsched_queue_t runnable; /*!< Runnable thread queue. */
diff --git a/ksrc/nucleus/sched.c b/ksrc/nucleus/sched.c
index e59f48e..159f416 100644
--- a/ksrc/nucleus/sched.c
+++ b/ksrc/nucleus/sched.c
@@ -21,6 +21,13 @@
* \ingroup sched
*/
+/*!
+ * \ingroup nucleus
+ * \defgroup sched Real-time scheduler services.
+ *
+ * Real-time pod services.
+ *@{*/
+
#include <nucleus/pod.h>
#include <nucleus/thread.h>
#include <nucleus/timer.h>
@@ -1060,3 +1067,5 @@ void xnsched_cleanup_proc(void)
}
#endif /* CONFIG_XENO_OPT_VFILE */
+
+/*@}*/
_______________________________________________
Xenomai-git mailing list
Xenomai-git@xenomai.org
https://xenomai.org/mailman/listinfo/xenomai-git
