aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs/general.rst
diff options
context:
space:
mode:
authorNicholas Corgan <nick.corgan@ettus.com>2012-03-30 09:27:59 -0700
committerNicholas Corgan <nick.corgan@ettus.com>2012-03-30 09:27:59 -0700
commite8d9b4d94b201aa808c63f29b7edd6efdc56440e (patch)
tree0533184c37925d3f1c73bfd8be16697545733740 /host/docs/general.rst
parentd1ad808f78497db2770a346d560c9a7f21ff1f1f (diff)
downloaduhd-e8d9b4d94b201aa808c63f29b7edd6efdc56440e.tar.gz
uhd-e8d9b4d94b201aa808c63f29b7edd6efdc56440e.tar.bz2
uhd-e8d9b4d94b201aa808c63f29b7edd6efdc56440e.zip
docs: All instances of "the UHD" have been changed to "UHD". All paths, filenames, variables, etc. have been uniformly emphasized.
Diffstat (limited to 'host/docs/general.rst')
-rw-r--r--host/docs/general.rst14
1 files changed, 7 insertions, 7 deletions
diff --git a/host/docs/general.rst b/host/docs/general.rst
index ebba7b532..fc7caff3c 100644
--- a/host/docs/general.rst
+++ b/host/docs/general.rst
@@ -50,7 +50,7 @@ After tuning, the RF front-end will need time to settle into a usable state.
Typically, this means that the local oscillators must be given time to lock
before streaming begins. Lock time is not consistent; it varies depending upon
the device and requested settings. After tuning and before streaming, the user
-should wait for the "lo_locked" sensor to become true, or sleep for
+should wait for the **lo_locked** sensor to become true or sleep for
a conservative amount of time (perhaps a second).
Pseudo-code for dealing with settling time after tuning on receive:
@@ -184,12 +184,12 @@ This error is harmless; it simply means that the thread will have a normal sched
**Linux Notes:**
Non-privileged users need special permission to change the scheduling priority.
-Add the following line to */etc/security/limits.conf*:
+Add the following line to **/etc/security/limits.conf**:
::
@<my_group> - rtprio 99
-Replace <my_group> with a group to which your user belongs.
+Replace **<my_group>** with a group to which your user belongs.
Settings will not take effect until the user is in a different login session.
------------------------------------------------------------------------
@@ -201,9 +201,9 @@ Support for dynamically loadable modules
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
For a module to be loaded at runtime, it must be:
-* found in the UHD_MODULE_PATH environment variable,
-* installed into the <install-path>/share/uhd/modules directory,
-* or installed into /usr/share/uhd/modules directory (UNIX only).
+* found in the **UHD_MODULE_PATH** environment variable,
+* installed into the **<install-path>/share/uhd/modules** directory,
+* or installed into **/usr/share/uhd/modules** directory (UNIX only).
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Disabling or redirecting prints to stdout
@@ -211,7 +211,7 @@ Disabling or redirecting prints to stdout
The user can disable the UHD library from printing directly to stdout by registering a custom message handler.
The handler will intercept all messages, which can be dropped or redirected.
Only one handler can be registered at a time.
-Make "register_handler" your first call into UHD:
+Make **register_handler** your first call into UHD:
::