summaryrefslogtreecommitdiff
path: root/docs/doxygen
diff options
context:
space:
mode:
Diffstat (limited to 'docs/doxygen')
-rw-r--r--docs/doxygen/Doxyfile.in2
-rw-r--r--docs/doxygen/Doxyfile.swig_doc.in4
-rw-r--r--docs/doxygen/other/build_guide.dox.in19
-rw-r--r--docs/doxygen/other/logger.dox18
-rw-r--r--docs/doxygen/other/releasing.dox25
5 files changed, 60 insertions, 8 deletions
diff --git a/docs/doxygen/Doxyfile.in b/docs/doxygen/Doxyfile.in
index 698798d762..72e7977dff 100644
--- a/docs/doxygen/Doxyfile.in
+++ b/docs/doxygen/Doxyfile.in
@@ -1096,7 +1096,7 @@ HTML_COLORSTYLE_GAMMA = 80
# page will contain the date and time when the page was generated. Setting
# this to NO can help when comparing the output of multiple runs.
-HTML_TIMESTAMP = YES
+HTML_TIMESTAMP = NO
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
diff --git a/docs/doxygen/Doxyfile.swig_doc.in b/docs/doxygen/Doxyfile.swig_doc.in
index 48e01f5cd2..86b9dc8522 100644
--- a/docs/doxygen/Doxyfile.swig_doc.in
+++ b/docs/doxygen/Doxyfile.swig_doc.in
@@ -121,7 +121,7 @@ INLINE_INHERITED_MEMB = NO
# path before files name in the file list and in the header files. If set
# to NO the shortest path that makes the file name unique will be used.
-FULL_PATH_NAMES = YES
+FULL_PATH_NAMES = NO
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
# can be used to strip a user-defined part of the path. Stripping is
@@ -957,7 +957,7 @@ HTML_COLORSTYLE_GAMMA = 80
# page will contain the date and time when the page was generated. Setting
# this to NO can help when comparing the output of multiple runs.
-HTML_TIMESTAMP = YES
+HTML_TIMESTAMP = NO
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
diff --git a/docs/doxygen/other/build_guide.dox.in b/docs/doxygen/other/build_guide.dox.in
index f3b75cc231..ac28b0be7c 100644
--- a/docs/doxygen/other/build_guide.dox.in
+++ b/docs/doxygen/other/build_guide.dox.in
@@ -37,7 +37,6 @@ first. Most recent systems have these packages available.
\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/
@@ -55,7 +54,6 @@ Other compilers may work, but are not supported.
\subsection dep_docs docs: Building the documentation
\li doxygen (>= 1.5) http://www.stack.nl/~dimitri/doxygen/download.html
-\li latex* (>= 2.0) http://www.latex-project.org/
\subsection dep_grc grc: The GNU Radio Companion
\li Cheetah (>= 2.0) http://www.cheetahtemplate.org/
@@ -64,6 +62,12 @@ Other compilers may work, but are not supported.
\subsection dep_fft gr-fft: Fast Frequency Transform
\li fftw3f (>= 3.0.1) http://www.fftw.org/download.html
+\subsection dep_zeromq gr-zeromq: ZeroMQ Network layer
+\li ZeroMQ (>= 3.2.5) http://www.zeromq.org/
+\li cppzmq (>= git 6c17af2) https://github.com/zeromq/cppzmq
+
+cppzmq is included (undocumentedly) in the debian and Ubuntu libzmq3-dev packages.
+
\subsection dep_wavelet gr-wavelet: Collection of wavelet blocks
\li gsl (>= 1.10) http://gnuwin32.sourceforge.net/packages/gsl.htm
@@ -82,7 +86,7 @@ Other compilers may work, but are not supported.
\li audio-osx
\li audio-windows
-<b>Optional but recommended dependencies.</b>
+<b>Optional</b>
It is not necessary to satisfy all of these dependencies; just the
one(s) that are right for your system. On Linux, don't expect
@@ -91,14 +95,15 @@ 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_fdc gr-fcd: The FunCube Dongle hardware interface (only if you want to use one)
+\li libUSB(x) (version platform-dependent) http://www.libusb.info/
+
\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 (only if you know what this is)
\li comedilib (>= 0.8.1) http://www.comedi.org/
-<b>Optional</b>
-
\ref page_ctrlport may use various backends to perform the RPC
process, and each is its own dependency.
@@ -106,6 +111,10 @@ Currently, ControlPort only supports the Apache Thrift backend.
\li thrift (>= 0.9.2) https://thrift.apache.org/
+To have nice formula formatting in doxygen, you'll need LaTeX; for python docs, sphinx:
+
+\li latex (>= 2.0) http://www.latex-project.org/
+\li sphinx (>= 1.2.2) http://www.sphinx-doc.org/
\section build_gr_cmake Building GNU Radio
diff --git a/docs/doxygen/other/logger.dox b/docs/doxygen/other/logger.dox
index 6501195750..00387768c0 100644
--- a/docs/doxygen/other/logger.dox
+++ b/docs/doxygen/other/logger.dox
@@ -206,6 +206,24 @@ This creates a pointer called LOG (which is instantiated as a
log4cpp:LoggerPtr in the macro) that we can now use locally as the
input to our logging macros like 'GR_LOG_INFO(LOG, "message")'.
+\subsection using_logging Using Logging in Out of Tree Modules
+
+In order to use the logging interface in an out of tree module based on a
+gr_modtool template module, several CMake modifications are required.
+Without these changes, logging will be disabled.
+
+GrMiscUtils.cmake module must be included in the OOT module top level
+CMakeLists.Texts file, and the GR_LOGGING() function provided by GrMiscUtils
+must be called from the same top level CMakeLists.txt file. This will
+set the appropriate build environment and during that process, attempt
+to find the log4cpp package using the FindLog4Cpp.cmake module.
+This module is not included in the module by gr_modtool, but is part of
+the GNU Radio codebase and can be copied directly into the cmake/Modules/
+directory of the OOT module.
+
+Once these CMake changes are made, the GR logging interface will function
+as documented on this page.
+
\section logPy Logging from Python
The logging capability has been brought out python via swig. The configuration
diff --git a/docs/doxygen/other/releasing.dox b/docs/doxygen/other/releasing.dox
new file mode 100644
index 0000000000..1ed3c37ad5
--- /dev/null
+++ b/docs/doxygen/other/releasing.dox
@@ -0,0 +1,25 @@
+/*! \page page_releasing Release Process Documentation
+
+\section Preparation
+
+\li make sure a clean build works
+\li Check whether all significant changes are in CHANGELOG
+\li List of contributors `git log --format="* %aN <%aE>" vLASTRELEASE..HEAD | sort -u > /tmp/authors.txt`
+\li Check for ABI / API break, determine Version (MAJOR.MINOR.ABI.PATCH)
+\li Change [unreleased] to [MAJOR.MINOR.ABI.PATCH] in CHANGELOG
+\li Update version in CMakeList
+\li Commit with message: `git commit -m "Release MAJOR.MINOR.ABI.PATCH" CMakeLists.txt CHANGELOG.md
+\li prepare release statement / tag annotation file: copy last Tag's annotation format (basically, contributors top, new Changelog bottom
+
+\section Release Tagging
+
+\li `git tag --annotate --sign -F /path/to/release_statement.md vMAJOR.MINOR.ABI.PATCH`
+\li `git push yourrepo vMAJOR.MINOR.ABI.PATCH && hub pull-request -b {master|maint-MAJOR.MINOR}`
+\li let CI do its thing; if that's OK:
+\li `git push origin {master|maint-MAJOR.MINOR} vMAJOR.MINOR.ABI.PATCH`
+\li on github, mark release
+
+\section Creation Of Archives
+
+\li `git checkout vMAJOR.MINOR.ABI.PATCH; git submodule update` should be clean
+\li `gnuradio/dtools/bin/roll-tarball.sh`