From: Jeffrey Melville <jmelville@mitre.org>
To: "xenomai@xenomai.org" <xenomai@xenomai.org>
Subject: [Xenomai] [PATCH] doc: Fix return description for POSIX sched_get_priority functions.
Date: Fri, 9 Jan 2015 11:10:41 -0500 [thread overview]
Message-ID: <54AFFD81.3030803@mitre.org> (raw)
---
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(-)
diff --git a/ksrc/skins/posix/sched.c b/ksrc/skins/posix/sched.c
index bdb79d3..b1af274 100644
--- a/ksrc/skins/posix/sched.c
+++ b/ksrc/skins/posix/sched.c
@@ -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.
*
--
1.9.1
next reply other threads:[~2015-01-09 16:10 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-01-09 16:10 Jeffrey Melville [this message]
2015-01-12 1:00 ` [Xenomai] [PATCH] doc: Fix return description for POSIX sched_get_priority functions Gilles Chanteperdrix
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=54AFFD81.3030803@mitre.org \
--to=jmelville@mitre.org \
--cc=xenomai@xenomai.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.