summaryrefslogtreecommitdiff
path: root/docs/doxygen
diff options
context:
space:
mode:
Diffstat (limited to 'docs/doxygen')
-rw-r--r--docs/doxygen/CMakeLists.txt4
-rw-r--r--docs/doxygen/Doxyfile.in2
-rw-r--r--docs/doxygen/Doxyfile.swig_doc.in2
-rw-r--r--docs/doxygen/other/build_guide.dox.in (renamed from docs/doxygen/other/build_guide.dox)37
-rw-r--r--docs/doxygen/other/packet_txrx.dox2
5 files changed, 31 insertions, 16 deletions
diff --git a/docs/doxygen/CMakeLists.txt b/docs/doxygen/CMakeLists.txt
index a837bd8e11..faa1fbc891 100644
--- a/docs/doxygen/CMakeLists.txt
+++ b/docs/doxygen/CMakeLists.txt
@@ -34,6 +34,10 @@ configure_file(
${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
@ONLY)
+configure_file(
+ ${CMAKE_CURRENT_SOURCE_DIR}/other/build_guide.dox.in
+ ${CMAKE_CURRENT_BINARY_DIR}/other/build_guide.dox
+@ONLY)
set(BUILT_DIRS ${CMAKE_CURRENT_BINARY_DIR}/xml ${CMAKE_CURRENT_BINARY_DIR}/html)
diff --git a/docs/doxygen/Doxyfile.in b/docs/doxygen/Doxyfile.in
index 8d06249abb..fe350d7a9d 100644
--- a/docs/doxygen/Doxyfile.in
+++ b/docs/doxygen/Doxyfile.in
@@ -1080,7 +1080,7 @@ HTML_STYLESHEET =
# user-defined cascading style sheet that is included after the standard
# style sheets created by doxygen. Using this option one can overrule
# certain style aspects. This is preferred over using HTML_STYLESHEET
-# since it does not replace the standard style sheet and is therefor more
+# since it does not replace the standard style sheet and is therefore more
# robust against future updates. Doxygen will copy the style sheet file to
# the output directory.
diff --git a/docs/doxygen/Doxyfile.swig_doc.in b/docs/doxygen/Doxyfile.swig_doc.in
index 63bd51de42..48e01f5cd2 100644
--- a/docs/doxygen/Doxyfile.swig_doc.in
+++ b/docs/doxygen/Doxyfile.swig_doc.in
@@ -913,7 +913,7 @@ HTML_STYLESHEET =
# user-defined cascading style sheet that is included after the standard
# style sheets created by doxygen. Using this option one can overrule
# certain style aspects. This is preferred over using HTML_STYLESHEET
-# since it does not replace the standard style sheet and is therefor more
+# since it does not replace the standard style sheet and is therefore more
# robust against future updates. Doxygen will copy the style sheet file to
# the output directory.
diff --git a/docs/doxygen/other/build_guide.dox b/docs/doxygen/other/build_guide.dox.in
index 743dc73118..8169cea9fc 100644
--- a/docs/doxygen/other/build_guide.dox
+++ b/docs/doxygen/other/build_guide.dox.in
@@ -16,8 +16,8 @@ if any, to build the various GNU Radio components.
Most of these components do not need to be individually compiled or
installed. Instead, rely on your operating system's package manager or
-binary installation process (the <b>apt-get</b> system in Debian and
-Ubuntu, <b>yum</b> in RedHat and Fedora, etc.). GNU Radio tries to keep an
+binary installation process (the <b>apt-get</b> or \b apt system in Debian and
+Ubuntu, <b>yum</b> or \b dnf in RedHat and Fedora, etc.). GNU Radio tries to keep an
up-to-date build guide for the majority of the supported operating
systems on gnuradio.org
(https://wiki.gnuradio.org/index.php/BuildGuide).
@@ -33,17 +33,25 @@ installation tool (apt-get, pkg_install, YaST, yum, urpmi, etc.)
first. Most recent systems have these packages available.
\subsection dep_global Global Dependencies
-\li git http://git-scm.com/downloads
-\li cmake (>= 2.6.3) http://www.cmake.org/cmake/resources/software.html
-\li boost (>= 1.35) http://www.boost.org/users/download/
-\li cppunit (>= 1.9.14) http://freedesktop.org/wiki/Software/cppunit/
-\li fftw3f (>= 3.0.1) http://www.fftw.org/download.html
-\li log4cpp (>= 1.0) http://log4cpp.sourceforge.net/
+
+\li git http://git-scm.com/downloads
+\li cmake (>= @GR_CMAKE_MIN_VERSION@) http://www.cmake.org/cmake/resources/software.html
+\li boost (>= @GR_BOOST_MIN_VERSION@) http://www.boost.org/users/download/
+\li cppunit (>= @GR_CPPUNIT_MIN_VERSION@) http://freedesktop.org/wiki/Software/cppunit/
+\li mako (>= @GR_MAKO_MIN_VERSION@) http://www.makotemplates.org/download.html
+\li log4cpp (>= 1.0) http://log4cpp.sourceforge.net/
+
+A C/C++ compiler is also required. These are known to work:
+
+\li gcc/g++ (>= @GCC_MIN_VERSION@) https://gcc.gnu.org/install/download.html
+\li clang/clang++ (>= @CLANG_MIN_VERSION@) http://releases.llvm.org/download.html
+
+Other compilers may work, but are not supported.
\subsection dep_python Python Wrappers
-\li python (>= 2.5) http://www.python.org/download/
-\li swig (>= 1.3.31) http://www.swig.org/download.html
-\li numpy (>= 1.1.0) http://sourceforge.net/projects/numpy/files/NumPy/
+\li python (>= @GR_PYTHON_MIN_VERSION@) http://www.python.org/download/
+\li swig (>= @GR_SWIG_MIN_VERSION@) http://www.swig.org/download.html
+\li numpy (>= 1.1.0) http://sourceforge.net/projects/numpy/files/NumPy/
\subsection dep_docs docs: Building the documentation
\li doxygen (>= 1.5) http://www.stack.nl/~dimitri/doxygen/download.html
@@ -53,6 +61,9 @@ first. Most recent systems have these packages available.
\li Cheetah (>= 2.0) http://www.cheetahtemplate.org/
\li pygtk (>= 2.10) http://www.pygtk.org/downloads.html
+\subsection dep_fft gr-fft: Fast Frequency Transform
+\li fftw3f (>= 3.0.1) http://www.fftw.org/download.html
+
\subsection dep_wavelet gr-wavelet: Collection of wavelet blocks
\li gsl (>= 1.10) http://gnuwin32.sourceforge.net/packages/gsl.htm
@@ -80,7 +91,7 @@ one(s) that are right for your system. On Linux, don't expect
audio-osx and audio-windows to be either satisfied or built.
\subsection dep_uhd uhd: The Ettus USRP Hardware Driver Interface
-\li uhd (>= 3.0.0) http://ettus.com/
+\li uhd (>= 3.5.5) https://www.ettus.com/downloads
\subsection dep_gr_video_sdl gr-video-sdl: PAL and NTSC display (rarely used)
\li SDL (>= 1.2.0) http://www.libsdl.org/download-1.2.php
@@ -179,7 +190,7 @@ If not specified, the "Release" mode is the default.
\li ENABLE_STATIC_LIBS: build static library files. Default is False.
\li CMAKE_TOOLCHAIN_FILE: A toolchain file to setup the CMake environment for cross-compiling.
-Here are som other potentially helpful CMake flags. These are to help you specifically locate certain dependencies. While the CMake scripts themselves should generally find these for us, we can use these to help direct CMake to specific locations if we have installed a different version elsewhere on the system that CMake doesn't know about.
+Here are some other potentially helpful CMake flags. These are to help you specifically locate certain dependencies. While the CMake scripts themselves should generally find these for us, we can use these to help direct CMake to specific locations if we have installed a different version elsewhere on the system that CMake doesn't know about.
\li QWT_LIBRARIES: shared library to use for Qwt (in the form \<path\>/libqwt.so).
\li QWT_INCLUDE_DIRS: path to Qwt include files (e.g., /usr/include/qwt).
diff --git a/docs/doxygen/other/packet_txrx.dox b/docs/doxygen/other/packet_txrx.dox
index c481e7e207..31417779c0 100644
--- a/docs/doxygen/other/packet_txrx.dox
+++ b/docs/doxygen/other/packet_txrx.dox
@@ -29,7 +29,7 @@ Typically, a packet consists of the following elements:
- The payload.
- A checksum, typically a CRC value, to validate the packet contents.
-At the transmitter stage, these are modulated and prepared for transmission (a forward error correction code may also be applied). Because the transmitter knows te packet length, is a trivial matter to create the transmit frames using the tagged stream blocks.
+At the transmitter stage, these are modulated and prepared for transmission (a forward error correction code may also be applied). Because the transmitter knows the packet length, is a trivial matter to create the transmit frames using the tagged stream blocks.
The receiver has to perform a multitude of things to obtain the packet again.
Most importantly, it has to convert an infinite stream (coming from the receiver