diff options
| author | Tom Rondeau <tom@trondeau.com> | 2014-07-25 21:58:09 -0400 |
|---|---|---|
| committer | Tom Rondeau <tom@trondeau.com> | 2014-07-25 21:58:09 -0400 |
| commit | 115254847e9c6db03a417749f4e476ed3db95e70 (patch) | |
| tree | dedf9a298e55384c1fdc6e0c1aa4ca6a44a3126e /docs/doxygen/other/build_guide.dox | |
| parent | dd7006e59d96e9961f243b2b17f468e6e1854bcc (diff) | |
docs: minor updates to the docs, including a new page for Python blocks.
Diffstat (limited to 'docs/doxygen/other/build_guide.dox')
| -rw-r--r-- | docs/doxygen/other/build_guide.dox | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/docs/doxygen/other/build_guide.dox b/docs/doxygen/other/build_guide.dox index e831e8a560..e5a1ae3cdd 100644 --- a/docs/doxygen/other/build_guide.dox +++ b/docs/doxygen/other/build_guide.dox @@ -98,11 +98,11 @@ The \$(builddir) is the directory in which the code is built. This <b>cannot</b> be the same path as where the source code resides. Often, \$(builddir) is \$(srcdir)/build. -\subsection Cmake Options +\subsection cmake_options Cmake Options Options can be used to specify where to find various library or include file dependencies that are not automatically being found -(-DCMAKE_PREFIX_PATH) or set the prefix +(-DCMAKE_PREFIX_PATH) or set the install prefix (-DCMAKE_INSTALL_PREFIX=(dir)). Components can also be enabled and disabled through the options. For a @@ -110,7 +110,7 @@ component named *gr-comp*, the option to disable would look like: -DENABLE_GR_COMP=off. The "off" could also be "false" or "no", and cmake is not case sensitive about these options. Similarly, "true", "on", or "yes" will turn this component on. All components are enabled -by default. +by default so long as their dependencies are met. An example is -DENABLE_PYTHON=False turns off building any Python or Swigging components. The result will be the GNU Radio libraries and @@ -132,7 +132,7 @@ version. Each type sets different flags for different purposes. To set the build type, use: \code --DCMAKE_BUILD_TYPE="Release"|"Debug" +-DCMAKE_BUILD_TYPE="Release"|"Debug"|"RelWithDebInfo" \endcode If not specified, the "Release" mode is the defaulted to. @@ -143,6 +143,9 @@ If not specified, the "Release" mode is the defaulted to. the optimization to make the libraries easier to debug and step through. +"RelWithDebInfo" builds with the release mode optimization of "-O3" +but also exports debug symbols with "-g". + \subsection build_gr_cmake_e100 Building for the E100 @@ -157,4 +160,3 @@ cmake -DCMAKE_CXX_FLAGS:STRING="-mcpu=cortex-a8 -mfpu=neon -mfloat-abi=softfp -g \endcode */ - |