Bug 861434: Document the limitations and current behavior of

PR_SetThreadPriority. r=gsvelto,jlebar.

1 files changed, 7 insertions, 0 deletions

diff --git a/pr/include/prthread.h b/pr/include/prthread.h
index 708c889c..f8b28a62 100644
--- a/pr/include/prthread.h
+++ b/pr/include/prthread.h
@@ -141,6 +141,13 @@ NSPR_API(PRThreadPriority) PR_GetThreadPriority(const PRThread *thread);
 
 /*
 ** Change the priority of the "thread" to "priority".
+**
+** PR_SetThreadPriority works in a best-effort manner. On some platforms a
+** special privilege, such as root access, is required to change thread
+** priorities, especially to raise thread priorities. If the caller doesn't
+** have enough privileges to change thread priorites, the function has no
+** effect except causing a future PR_GetThreadPriority call to return
+** |priority|.
 */
 NSPR_API(void) PR_SetThreadPriority(PRThread *thread, PRThreadPriority priority);