summaryrefslogtreecommitdiff
path: root/docs/doxygen
diff options
context:
space:
mode:
Diffstat (limited to 'docs/doxygen')
-rw-r--r--docs/doxygen/.gitignore13
-rw-r--r--docs/doxygen/Makefile.am56
-rw-r--r--docs/doxygen/doxyxml/.gitignore3
-rw-r--r--docs/doxygen/doxyxml/Makefile.am52
-rw-r--r--docs/doxygen/doxyxml/run_tests.in16
-rw-r--r--docs/doxygen/other/.gitignore8
-rw-r--r--docs/doxygen/other/Makefile.am29
-rw-r--r--docs/doxygen/other/build_guide.dox35
8 files changed, 34 insertions, 178 deletions
diff --git a/docs/doxygen/.gitignore b/docs/doxygen/.gitignore
deleted file mode 100644
index f44627c9d..000000000
--- a/docs/doxygen/.gitignore
+++ /dev/null
@@ -1,13 +0,0 @@
-/Makefile
-/Makefile.in
-/html
-/latex
-/xml
-/man
-/Doxyfile
-/.la
-/.lo
-/.deps
-/.libs
-/*.la
-/*.lo
diff --git a/docs/doxygen/Makefile.am b/docs/doxygen/Makefile.am
deleted file mode 100644
index 65fe864f2..000000000
--- a/docs/doxygen/Makefile.am
+++ /dev/null
@@ -1,56 +0,0 @@
-#
-# Copyright 2001,2005,2009 Free Software Foundation, Inc.
-#
-# This file is part of GNU Radio
-#
-# GNU Radio is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 3, or (at your option)
-# any later version.
-#
-# GNU Radio is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with GNU Radio; see the file COPYING. If not, write to
-# the Free Software Foundation, Inc., 51 Franklin Street,
-# Boston, MA 02110-1301, USA.
-#
-
-include $(top_srcdir)/Makefile.common
-
-SUBDIRS = other
-
-dist_gr_doc_DATA = \
- $(top_srcdir)/README \
- $(top_srcdir)/README.hacking \
- README.doxyxml
-
-EXTRA_DIST = doxyxml swig_doc.py
-
-all-local: prep @generate_docs@
-doc: docs # alias
-
-docs: prep html/index.html
-html/index.html:
- @DOXYGEN@
-
-EXTRA_DIST = images/gnuradio-logo.png
-
-prep:
- $(MKDIR_P) html
- $(MKDIR_P) xml
-
-install-data-local:
- $(MKDIR_P) $(DESTDIR)$(gr_docdir)
- cp -r html $(DESTDIR)$(gr_docdir)
- cp -r xml $(DESTDIR)$(gr_docdir)
-
-uninstall-local:
- $(RM) -fr $(DESTDIR)$(gr_docdir)/html
- $(RM) -fr $(DESTDIR)$(gr_docdir)/xml
-
-clean-local:
- $(RM) -fr latex html man xml
diff --git a/docs/doxygen/doxyxml/.gitignore b/docs/doxygen/doxyxml/.gitignore
deleted file mode 100644
index 0a864cc38..000000000
--- a/docs/doxygen/doxyxml/.gitignore
+++ /dev/null
@@ -1,3 +0,0 @@
-/Makefile
-/Makefile.in
-
diff --git a/docs/doxygen/doxyxml/Makefile.am b/docs/doxygen/doxyxml/Makefile.am
deleted file mode 100644
index 141f46e5a..000000000
--- a/docs/doxygen/doxyxml/Makefile.am
+++ /dev/null
@@ -1,52 +0,0 @@
-#
-# Copyright 2007,2009,2011 Free Software Foundation, Inc.
-#
-# This file is part of GNU Radio
-#
-# GNU Radio is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 3, or (at your option)
-# any later version.
-#
-# GNU Radio is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with GNU Radio; see the file COPYING. If not, write to
-# the Free Software Foundation, Inc., 51 Franklin Street,
-# Boston, MA 02110-1301, USA.
-#
-
-include $(top_srcdir)/Makefile.common
-
-EXTRA_DIST = \
- example/aadvark.cc \
- example/aadvark.h \
- example/Doxyfile \
- example/xml/aadvark_8cc.xml \
- example/xml/aadvark_8h.xml \
- example/xml/classAadvark.xml \
- example/xml/combine.xslt \
- example/xml/compound.xsd \
- example/xml/index.xml \
- example/xml/index.xsd
-
-if PYTHON
-utilspythondir = $(grpythondir)/doxyxml
-
-TESTS = \
- run_tests
-
-nobase_utilspython_PYTHON = \
- __init__.py \
- base.py \
- doxyindex.py \
- text.py \
- generated/__init__.py \
- generated/index.py \
- generated/indexsuper.py \
- generated/compound.py \
- generated/compoundsuper.py
-endif \ No newline at end of file
diff --git a/docs/doxygen/doxyxml/run_tests.in b/docs/doxygen/doxyxml/run_tests.in
deleted file mode 100644
index db9cc62bc..000000000
--- a/docs/doxygen/doxyxml/run_tests.in
+++ /dev/null
@@ -1,16 +0,0 @@
-#!/bin/sh
-
-# 1st parameter is absolute path to component source directory
-# 2nd parameter is absolute path to component build directory
-# 3rd parameter is path to Python QA directory
-
-# Note: calling master run_tests.sh in gnuradio core is not strictly
-# correct, as it will result in a partially bogus PYTHONPATH, but it
-# does make the correct paths in the second half so all is well.
-
-@PYTHON@ @srcdir@/__init__.py
-
-# @top_builddir@/run_tests.sh \
-# @abs_top_srcdir@/gnuradio-core \
-# @abs_top_builddir@/gnuradio-core \
-# @srcdir@
diff --git a/docs/doxygen/other/.gitignore b/docs/doxygen/other/.gitignore
deleted file mode 100644
index a02b6ff73..000000000
--- a/docs/doxygen/other/.gitignore
+++ /dev/null
@@ -1,8 +0,0 @@
-/Makefile
-/Makefile.in
-/.la
-/.lo
-/.deps
-/.libs
-/*.la
-/*.lo
diff --git a/docs/doxygen/other/Makefile.am b/docs/doxygen/other/Makefile.am
deleted file mode 100644
index 82ee0f945..000000000
--- a/docs/doxygen/other/Makefile.am
+++ /dev/null
@@ -1,29 +0,0 @@
-#
-# Copyright 2001,2004,2010 Free Software Foundation, Inc.
-#
-# This file is part of GNU Radio
-#
-# GNU Radio is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 3, or (at your option)
-# any later version.
-#
-# GNU Radio is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with GNU Radio; see the file COPYING. If not, write to
-# the Free Software Foundation, Inc., 51 Franklin Street,
-# Boston, MA 02110-1301, USA.
-#
-
-include $(top_srcdir)/Makefile.common
-
-EXTRA_DIST += \
- doxypy.py \
- group_defs.dox \
- shared_ptr_docstub.h \
- tv-channel-frequencies \
- vector_docstub.h
diff --git a/docs/doxygen/other/build_guide.dox b/docs/doxygen/other/build_guide.dox
index 207f553a1..734fb9e25 100644
--- a/docs/doxygen/other/build_guide.dox
+++ b/docs/doxygen/other/build_guide.dox
@@ -21,7 +21,7 @@ about building gr-comedi.
\subsection dep_global Global Dependencies
\li git http://code.google.com/p/msysgit
-\li cmake http://www.cmake.org/cmake/resources/software.html
+\li cmake (>= 2.6) http://www.cmake.org/cmake/resources/software.html
\li boost (>= 1.35) http://www.boostpro.com/download
\li cppunit (>= 1.9.14) http://gaiacrtn.free.fr/cppunit/index.html
\li fftw3f (>= 3.0) http://www.fftw.org/install/windows.html
@@ -89,6 +89,8 @@ 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
+
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
@@ -101,6 +103,37 @@ cmake is not case sensitive about these options. Similarly, "true",
"on", or "yes" will turn this component on. All components are enabled
by default.
+An example is -DENABLE_PYTHON=False turns off building any Python or
+Swigging components. The result will be the GNU Radio libraries and
+C++ programs/applications/examples. No Python or GRC files will be
+built or installed.
+
+The -DENABLE_DEFAULT=False can be used to disable all
+components. Individual components can then be selectively turned back
+on. For example, just buidling the Volk and Gruel libraries can be
+done with this:
+
+\code
+cmake -DENABLE_DEFAULT=Off -DENABLE_VOLK=True -DENABLE_GRUEL=True <srcdir>
+\endcode
+
+
+The build type allows you to specify the build as a debug or release
+version. Each type sets different flags for different purposes. To set
+the build type, use:
+
+\code
+-DCMAKE_BUILD_TYPE="Release"|"Debug"
+\endcode
+
+If not specified, the "Release" mode is the defaulted to.
+
+"Release" mode sets the '-O3' optimization flag.
+
+"Debug" mode sets '-g -O2' flags to export debug symbols and reduce
+the optimization to make the libraries easier to debug and step
+through.
+
\subsection build_gr_cmake_e100 Building for the E100