uhd: honor the LIB_SUFFIX option, added docs for LIB_SUFFIX and tweaked other docs

disabled -pedantic for now as well

3 files changed, 30 insertions, 17 deletions

diff --git a/host/CMakeLists.txt b/host/CMakeLists.txt
index ceea5d024..566bfd538 100644
--- a/host/CMakeLists.txt
+++ b/host/CMakeLists.txt
@@ -30,7 +30,7 @@ INCLUDE(${CMAKE_SOURCE_DIR}/config/CPack.cmake)
 # Install Dirs
 ########################################################################
 SET(RUNTIME_DIR bin)
-SET(LIBRARY_DIR lib)
+SET(LIBRARY_DIR lib${LIB_SUFFIX})
 SET(INCLUDE_DIR include)
 SET(PKG_DATA_DIR share/uhd)
 SET(PKG_DOC_DIR share/doc/uhd)
@@ -61,7 +61,9 @@ ENDIF(NOT CMAKE_BUILD_TYPE)
 IF(CMAKE_COMPILER_IS_GNUCXX)
     ADD_DEFINITIONS(-Wall)
     ADD_DEFINITIONS(-Wextra)
-    ADD_DEFINITIONS(-pedantic)
+    #causes trouble when compiling libusb1.0 on macintosh
+    #comment out until mac ports libusb gets its act together
+    #ADD_DEFINITIONS(-pedantic)
     ADD_DEFINITIONS(-ansi)
     #only export symbols that are declared to be part of the uhd api:
     UHD_ADD_OPTIONAL_CXX_COMPILER_FLAG(-fvisibility=hidden HAVE_VISIBILITY_HIDDEN)
diff --git a/host/docs/build.rst b/host/docs/build.rst
index d7dfd05e5..f37b5dce7 100644
--- a/host/docs/build.rst
+++ b/host/docs/build.rst
@@ -40,7 +40,7 @@ CMake
 ^^^^^^^^^^^^^^^^
 * **Purpose:** generates project build files
 * **Version:** at least 2.8
-* **Required for:** build time
+* **Usage:** build time (required)
 * **Download URL:** http://www.cmake.org/cmake/resources/software.html
 
 ^^^^^^^^^^^^^^^^
@@ -48,16 +48,16 @@ Boost
 ^^^^^^^^^^^^^^^^
 * **Purpose:** C++ library
 * **Version:** at least 3.6 unix, at least 4.0 windows
-* **Required for:** build time + run time
+* **Usage:** build time + run time (required)
 * **Download URL:** http://www.boost.org/users/download/
 * **Download URL (windows installer):** http://www.boostpro.com/download
 
 ^^^^^^^^^^^^^^^^
 LibUSB
 ^^^^^^^^^^^^^^^^
-* **Purpose:** USB userspace library
+* **Purpose:** USB-based hardware support
 * **Version:** at least 1.0
-* **Required for:** build time + run time (optional)
+* **Usage:** build time + run time (optional)
 * **Download URL:** http://www.libusb.org/
 
 ^^^^^^^^^^^^^^^^
@@ -65,7 +65,7 @@ Python
 ^^^^^^^^^^^^^^^^
 * **Purpose:** used by Cheetah and utility scripts
 * **Version:** at least 2.6
-* **Required for:** build time + run time utility scripts
+* **Usage:** build time + run time utility scripts (required)
 * **Download URL:** http://www.python.org/download/
 
 ^^^^^^^^^^^^^^^^
@@ -73,7 +73,7 @@ Cheetah
 ^^^^^^^^^^^^^^^^
 * **Purpose:** source code generation
 * **Version:** at least 2.0
-* **Required for:** build time
+* **Usage:** build time (required)
 * **Download URL:** http://www.cheetahtemplate.org/download.html
 * **Download URL (windows installer):** http://feisley.com/python/cheetah/
 
@@ -81,14 +81,14 @@ Cheetah
 Doxygen
 ^^^^^^^^^^^^^^^^
 * **Purpose:** generates html api documentation
-* **Required for:** build time (optional)
+* **Usage:** build time (optional)
 * **Download URL:** http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc
 
 ^^^^^^^^^^^^^^^^
 Docutils
 ^^^^^^^^^^^^^^^^
 * **Purpose:** generates html user manual
-* **Required for:** build time (optional)
+* **Usage:** build time (optional)
 * **Download URL:** http://docutils.sourceforge.net/
 
 ------------------------------------------------------------------------
@@ -105,9 +105,16 @@ Generate Makefiles with cmake
     cd build
     cmake ../
 
-**Notes:**
+Additionally, configuration variables can be passed into cmake via the command line.
+The following common-use configuration variables are listed below:
 
-* For a custom prefix, use: cmake -DCMAKE_INSTALL_PREFIX=<prefix> ../
+* For a custom install prefix: -DCMAKE_INSTALL_PREFIX=<prefix>
+* To install libs into lib64: cmake -DLIB_SUFFIX=64
+
+Example usage:
+::
+
+    cmake -DCMAKE_INSTALL_PREFIX=/opt/uhd ../
 
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Build and install
@@ -155,11 +162,15 @@ Build the project in MSVC
 **Note:** you may not have permission to build the install target.
 You need to be an administrator or to run MSVC as administrator.
 
-** alternative command line instructions **
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Build the project in MSVC (command line)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Open the Visual Studio Command Prompt Shorcut:
+::
 
-* Open the Visual Studio Command Prompt Shorcut
-* DevEnv <uhd-repo-path>\host\build\ALL_BUILD.vcproj /Build Release
-* DevEnv <uhd-repo-path>\host\build\INSTALL.vcproj /Build Release
+    cd <uhd-repo-path>\host\build
+    DevEnv ALL_BUILD.vcproj /Build Release
+    DevEnv INSTALL.vcproj /Build Release
 
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Setup the PATH environment variable
diff --git a/host/docs/usrp2.rst b/host/docs/usrp2.rst
index 745361b77..4c95fb24c 100644
--- a/host/docs/usrp2.rst
+++ b/host/docs/usrp2.rst
@@ -174,7 +174,7 @@ buffer incoming samples faster than they can be processed.
 However, if you application cannot process samples fast enough,
 no amount of buffering can save you.
 
-By default, the UHD will try to request a reasonably large buffer size for both send and receive.
+By default, the UHD will try to resize both the send and receive buffer for optimum performance.
 A warning will be printed on instantiation if the actual buffer size is insufficient.
 See the OS specific notes below: