Update CMake options in READMEs (#285)

Found all the cmake options I could, put them into the appropriate
READMEs.  There is some overlap between files but this may be a good
starting point at least.
This commit is contained in:
Ryan Tucker 2014-07-26 14:18:04 -04:00 • committed by Jon Szymaniak
commit 9e98e38e33
4 changed files with 58 additions and 13 deletions

View file

@ -25,6 +25,17 @@ The source is organized as follows:
For more information, see the [bladeRF wiki].
## Build Variables ##
Below are global options to choose which parts of the bladeRF project should
be built from the top level. Please see the [fx3_firmware] and [host]
subdirectories for more specific options.
| Option | Description
| --------------------------------- |:--------------------------------------------------------------------------|
| -DENABLE_FX3_BUILD=\<ON/OFF\> | Enables building the FX3 firmware. Default: OFF | |
| -DENABLE_HOST_BUILD=\<ON/OFF\> | Enables building the host library and utilities overall. Default: ON |
[firmware_common]: ./firmware_common (Host-Firmware common files)
[fx3_firmware]: ./fx3_firmware (FX3 Firmware)
[hdl]: ./hdl (HDL)

View file

@ -38,18 +38,22 @@ Below is a list of useful and project-specific CMake options. Please see the CMa
more information.
| Option | Description
| ----------------------------------------- |:---------------------------------------------------------------------------------------------------------|
| -DENABLE_HOST_BUILD=\<ON/OFF\> | Enables building of the Host components overall. Default is ON. |
| -DCMAKE_BUILD_TYPE=\<type\> | Set <type> to "Debug" to enable a debug build. "Release" is the default. |
| -DBUILD_DOCUMENTATION=\<ON/OFF\> | Build libbladeRF API documentation and manpages for utilities. OFF by default. |
| -DCMAKE_C_COMPILER=\<compiler\> | Specify the compiler to use. Otherwise, CMake will determine a default. |
| -DENABLE_GDB_EXTENSIONS=\<ON/OFF\> | GCC & GDB users may want to set this to use -ggdb3 instead of -g. Disabled by default. |
| -DENABLE_BACKEND_LIBUSB=\<ON/OFF\> | Enables libusb backend in libbladeRF. Enabled by default. |
| -DENABLE_BACKEND_LINUX_DRIVER=\<ON/OFF\> | Enables Linux driver in libbladeRF. Disabled by default. |
| -DENABLE_LIBTECLA=\<ON/OFF\> | Enable libtecla support in the bladeRF-cli program. Default: ON if libtecla is detected, OFF otherwise. |
| -DINSTALL_UDEV_RULES=\<ON/OFF\> | Install udev rules to /etc/udev/rules.d/. Default: ON for Linux, OFF default otherwise. |
| -DBLADERF_GROUP=\<group\> | Sets the group associated with the bladeRF in the installed udev rules. The default is plugdev. |
| -DTREAT_WARNINGS_AS_ERRORS=\<Yes/No\> | Treat compiler warnings as errors, defaults to Yes. Contributors should keep this enabled. |
| ----------------------------------------- |:----------------------------------------------------------------------------------------------------------|
| -DCMAKE_BUILD_TYPE=\<type\> | Set <type> to "Debug" to enable a debug build. Default: "Release" |
| -DBUILD_DOCUMENTATION=\<ON/OFF\> | Build libbladeRF API documentation and manpages for utilities. Default: OFF |
| -DCMAKE_C_COMPILER=\<compiler\> | Specify the compiler to use. Otherwise, CMake will determine a default. |
| -DCMAKE_INSTALL_PREFIX=\</prefix/path\> | Override system-specific path to install output files. Default depends on system; see ```cmake -L``` |
| -DENABLE_GDB_EXTENSIONS=\<ON/OFF\> | GCC & GDB users may want to set this to use -ggdb3 instead of -g. Default: OFF |
| -DENABLE_BACKEND_LIBUSB=\<ON/OFF\> | Enables libusb backend in libbladeRF. Default: ON |
| -DENABLE_BACKEND_USB=\<ON/OFF\> | Enables USB backends in libbladeRF. Default: ON |
| -DENABLE_BACKEND_LINUX_DRIVER=\<ON/OFF\> | Enables Linux driver in libbladeRF. Default: OFF |
| -DENABLE_BACKEND_DUMMY=\<ON/OFF\> | Enables dummy backend support in libbladeRF. Only useful for some developers. Default: OFF |
| -DENABLE_LIBTECLA=\<ON/OFF\> | Enable libtecla support in the bladeRF-cli program. Default: ON if libtecla is detected, OFF otherwise. |
| -DINSTALL_UDEV_RULES=\<ON/OFF\> | Install udev rules to /etc/udev/rules.d/. Default: ON for Linux, OFF default otherwise. |
| -DUDEV_RULES_PATH=\</path/to/udev/rules\> | Override the path for installing udev rules. Default: /etc/udev/rules.d |
| -DBLADERF_GROUP=\<group\> | Sets the group associated with the bladeRF in the installed udev rules. Default: ```plugdev``` |
| -DTREAT_WARNINGS_AS_ERRORS=\<ON/OFF\> | Treat compiler warnings as errors. Contributors should keep this enabled. Default: ON |
| -DENABLE_LOG_FILE_INFO=\<ON/OFF\> | Enable source file and line number information in log messages. Default: OFF |
[cmake]: ./cmake (CMake scripts)
[drivers]: ./drivers (Drivers)

View file

@ -21,3 +21,21 @@ make libbladeRF-doxygen
The HTML documentation will be placed in **\<build dir\>/libraries/libbladerf/doc/doxygen/html**. The **index.html** file is the "main" documentation page.
Please see the [CHANGELOG](CHANGELOG) file for a summary of changes across libbladeRF versions.
## Build Variables ##
Below is a list of useful and project-specific CMake options. Please see the CMake [variable list] in CMake's documentation for
more information.
| Option | Description
| ------------------------------------------------- |:------------------------------------------------------------------------------------------------------------------|
| -DBUILD_LIBBLADERF_DOCUMENTATION=\<ON/OFF\> | Builds API documentation using Doxygen. Default: equal to BUILD_DOCUMENTATION |
| -DENABLE_BACKEND_LIBUSB=\<ON/OFF\> | Enables libusb backend in libbladeRF. Default: ON |
| -DENABLE_BACKEND_USB=\<ON/OFF\> | Enables USB backends in libbladeRF. Default: ON |
| -DENABLE_BACKEND_LINUX_DRIVER=\<ON/OFF\> | Enables Linux driver in libbladeRF. Default: OFF |
| -DENABLE_BACKEND_DUMMY=\<ON/OFF\> | Enables dummy backend support in libbladeRF. Only useful for some developers. Default: OFF |
| -DENABLE_LIBBLADERF_LOGGING=\<ON/OFF\> | Enable log messages in libbladeRF. Default: ON |
| -DENABLE_LIBBLADERF_SYNC=\<ON/OFF\> | Enable the libbladeRF synchronous data interface. Requires pthreads. Default: ON |
| -DENABLE_LIBBLADERF_SYNC_LOG_VERBOSE=\<ON/OFF\> | Enable log_verbose() calls in the sync interface's data path. Note that this may harm performance. Default: OFF |
| -DLIBUSB_DETACH_KERNEL_DRIVER=\<ON/OFF\> | Enable calls to libusb_detach_kernel_driver(). Not supported in Windows. Default: ON |
| -DLIBUSB_PATH=\</path/to/libusb\> | Path to libusb files. (This is generally only needed for Windows users who downloaded binary distributions.) |

View file

@ -3,14 +3,26 @@ This tool is intended to aid in development and testing. bladeRF-cli can be use
## Dependencies ##
- [libbladeRF][libbladeRF]
- [help2man][help2man] (optional)
- [libtecla][libtecla] (optional)
- [pandoc][pandoc] (optional)
[libbladeRF]: ../../libraries/libbladeRF (libbladeRF)
[help2man]: https://www.gnu.org/software/help2man/ (help2man)
[libtecla]: http://www.astro.caltech.edu/~mcs/tecla/ (libtecla)
[pandoc]: http://johnmacfarlane.net/pandoc/ (pandoc)
## Build Variables ##
The bladeRF-cli build should detect whether libtecla is installed, and configure the ENABLE_LIBTECLA variable accordingly. You can override this when configuring the build with CMake via a ```-DENABLE_LIBTECLA=OFF``` argument.
Below is a list of useful and project-specific CMake options. Please see the CMake [variable list] in CMake's documentation for
more information.
| Option | Description
| --------------------------------------------- |:---------------------------------------------------------------------------------------------------------|
| -DENABLE_LIBTECLA=\<ON/OFF\> | Enable libtecla support in the bladeRF-cli program. Default: ON if libtecla is detected, OFF otherwise. |
| -DBUILD_BLADERF_CLI_DOCUMENTATION=\<ON/OFF\> | Builds a man page for the bladeRF-cli utility, using help2man. Default: equal to BUILD_DOCUMENTATION |
When pandoc is installed, the documentation for each bladeRF-cli command will be re-generated for the interactive 'help' command and the man page.
## Basic Usage ##
For usage information, run: