Skip to contentSkip to conversation

doc: Fix return description for POSIX sched_get_priority functions.

PATCH Applied Jeffrey Melville 2 participants 2 messages Jan 9, 2015 – Jan 12, 2015

lore
Share & tools
lore

Jeffrey Melville

author
#0 lore raw

PATCH 1/1 doc: Fix return description for POSIX sched_get_priority functions.

---

I found a minor issue in the documentation for scheduler priorities in the 2.6.x tree. See the patch below.

Cheers,
Jeff

 ksrc/skins/posix/sched.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
ksrc/skins/posix/sched.c +2 -2
index bdb79d3..b1af274 100644
@@ -69,7 +69,7 @@
  * @param policy scheduling policy, one of SCHED_FIFO, SCHED_RR,
  * SCHED_SPORADIC, SCHED_TP or SCHED_OTHER.
  *
- * @retval 0 on success;
+ * @retval The minimum priority of @a policy on success;
  * @retval -1 with @a errno set if:
  * - EINVAL, @a policy is invalid.
  *

@@ -105,7 +105,7 @@ int sched_get_priority_min(int policy)
  * @param policy scheduling policy, one of SCHED_FIFO, SCHED_RR,
  * SCHED_SPORADIC, SCHED_TP or SCHED_OTHER.
  *
- * @retval 0 on success;
+ * @retval The maximum priority of @a policy on success;
  * @retval -1 with @a errno set if:
  * - EINVAL, @a policy is invalid.
  *
Signature · 1 line
1.9.1
Applied
#1 lore raw
Quoted 4 lines · Jeffrey Melville

---

I found a minor issue in the documentation for scheduler priorities in the 2.6.x tree. See the patch below.

Merged, thanks.

Signature · 1 line
					    Gilles.