diff options
| author | Martin Braun <martin.braun@ettus.com> | 2018-02-03 16:58:15 +0100 |
|---|---|---|
| committer | Martin Braun <martin.braun@ettus.com> | 2018-02-03 16:58:43 +0100 |
| commit | db7e26bc73fd71bc88249131f57f7edef308fa63 (patch) | |
| tree | d084ad2615012d53c50a230821761349eb978d56 /docs/doxygen | |
| parent | 3c63f7334d6de70d655aa97fcccbfb950645f4d4 (diff) | |
| parent | a35e10870bbb9a71b3ab66b1dc58135e08c9543e (diff) | |
Merge branch 'master' into next
Diffstat (limited to 'docs/doxygen')
| -rw-r--r-- | docs/doxygen/Doxyfile.in | 2 | ||||
| -rw-r--r-- | docs/doxygen/Doxyfile.swig_doc.in | 2 | ||||
| -rw-r--r-- | docs/doxygen/other/build_guide.dox.in | 14 | ||||
| -rw-r--r-- | docs/doxygen/other/packet_txrx.dox | 2 | ||||
| -rw-r--r-- | docs/doxygen/other/volk_guide.dox | 3 |
5 files changed, 9 insertions, 14 deletions
diff --git a/docs/doxygen/Doxyfile.in b/docs/doxygen/Doxyfile.in index c47a758a5a..3be1cbc23a 100644 --- a/docs/doxygen/Doxyfile.in +++ b/docs/doxygen/Doxyfile.in @@ -1054,7 +1054,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.in b/docs/doxygen/other/build_guide.dox.in index d729e19976..f3b75cc231 100644 --- a/docs/doxygen/other/build_guide.dox.in +++ b/docs/doxygen/other/build_guide.dox.in @@ -20,7 +20,7 @@ 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 -(http://gnuradio.org/redmine/projects/gnuradio/wiki/BuildGuide). +(https://wiki.gnuradio.org/index.php/BuildGuide). Not all dependencies are required for all components, and not all components are required for a given installation. The list of required @@ -39,6 +39,7 @@ first. Most recent systems have these packages available. \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: @@ -90,16 +91,12 @@ audio-osx and audio-windows to be either satisfied or built. \subsection dep_uhd uhd: The Ettus USRP Hardware Driver Interface \li uhd (>= 3.5.5) https://www.ettus.com/downloads -\subsection dep_gr_video_sdl gr-video-sdl: PAL and NTSC display +\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 -\subsection dep_gr_comedi gr-comedi: Comedi hardware interface +\subsection dep_gr_comedi gr-comedi: Comedi hardware interface (only if you know what this is) \li comedilib (>= 0.8.1) http://www.comedi.org/ -\subsection dep_gr_log gr-log: Logging Tools (Optional) -\li log4cpp (>= 1.0) http://log4cpp.sourceforge.net/ - - <b>Optional</b> \ref page_ctrlport may use various backends to perform the RPC @@ -110,7 +107,6 @@ Currently, ControlPort only supports the Apache Thrift backend. \li thrift (>= 0.9.2) https://thrift.apache.org/ - \section build_gr_cmake Building GNU Radio GNU Radio is built using the CMake build system @@ -192,7 +188,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 diff --git a/docs/doxygen/other/volk_guide.dox b/docs/doxygen/other/volk_guide.dox index e5a55c1719..1f8f128e4b 100644 --- a/docs/doxygen/other/volk_guide.dox +++ b/docs/doxygen/other/volk_guide.dox @@ -51,8 +51,7 @@ all else fails, VOLK can fall back on the generic proto-kernel, which will always work. See <a -href="http://gnuradio.org/redmine/projects/gnuradio/wiki/Volk">VOLK on -gnuradio.org</a> for details on the VOLK naming scheme. +href="http://libvolk.org</a> for details on the VOLK naming scheme. \section volk_alignment Setting and Using Memory Alignment Information |