aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNeel Pandeya <neelpandeya@neelpandeya.com>2014-07-22 08:36:06 -0700
committerNicholas Corgan <nick.corgan@ettus.com>2014-07-22 09:56:51 -0700
commitc20b74040478b8fa50bfca5d9e085c548b6dba03 (patch)
treeb2c8c64b8e550c307f3f46f27b31909679e70782
parentdc9aab0ec64832129a30bd13512879315dab69fc (diff)
downloaduhd-c20b74040478b8fa50bfca5d9e085c548b6dba03.tar.gz
uhd-c20b74040478b8fa50bfca5d9e085c548b6dba03.tar.bz2
uhd-c20b74040478b8fa50bfca5d9e085c548b6dba03.zip
added explanation of Boost thread warning message
-rw-r--r--host/docs/general.dox21
1 files changed, 13 insertions, 8 deletions
diff --git a/host/docs/general.dox b/host/docs/general.dox
index 14f017d04..3a344ffe7 100644
--- a/host/docs/general.dox
+++ b/host/docs/general.dox
@@ -172,21 +172,26 @@ to use at most one thread context for manipulating device settings.
\subsection general_threading_prio Thread priority scheduling
-When UHD software spawns a new thread it may try to boost the thread's
-scheduling priority. When setting the priority fails, the UHD software
-prints out an error. This error is harmless; it simply means that the
-thread will have a normal scheduling priority.
+When UHD software spawns a new thread, it may try to boost the thread's
+scheduling priority. If setting the new priority fails, the UHD software
+prints a warning to the console, as shown below. This warning is harmless;
+it simply means that the thread will retain a normal or default scheduling priority.
+
+ UHD Warning:
+ Unable to set the thread priority. Performance may be negatively affected.
+ Please see the general application notes in the manual for instructions.
+ EnvironmentError: OSError: error in pthread_setschedparam
<b>Linux Notes:</b>
Non-privileged users need special permission to change the scheduling
-priority. Add the following line to `/etc/security/limits.conf`:
+priority. Add the following line to the file `/etc/security/limits.conf`:
@GROUP - rtprio 99
-Replace `GROUP` with a group to which your user belongs.
-Settings will not take effect until the user is in a different login
-session.
+Replace `GROUP` with a group in which your user is a member. You may need
+to log out and log back into the account for the settings to take effect.
+In most Linux distributions, a list of groups and group members can be found in the file `/etc/group`.
\section general_misc Miscellaneous Notes