aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Braun <martin.braun@ettus.com>2019-03-19 15:18:37 -0700
committerMartin Braun <martin.braun@ettus.com>2019-04-24 11:55:05 -0700
commitf6f2e96116164d416387d828121fb330d5108b05 (patch)
treebbb0ca714229d1c1bba7bf847f3549c2feae5de3
parent32869d2f345c38a17647b8b430f46e932992cbbe (diff)
downloaduhd-f6f2e96116164d416387d828121fb330d5108b05.tar.gz
uhd-f6f2e96116164d416387d828121fb330d5108b05.tar.bz2
uhd-f6f2e96116164d416387d828121fb330d5108b05.zip
docs: Auto-generate build page with min deps versions
The build guide manual page now takes the min versions for the dependencies straight from CMake. This avoids having to update the manual whenever we bump depdendencies.
-rw-r--r--host/CMakeLists.txt1
-rw-r--r--host/docs/CMakeLists.txt5
-rw-r--r--host/docs/build.dox.in (renamed from host/docs/build.dox)12
3 files changed, 12 insertions, 6 deletions
diff --git a/host/CMakeLists.txt b/host/CMakeLists.txt
index 78e9497be..84cc60f05 100644
--- a/host/CMakeLists.txt
+++ b/host/CMakeLists.txt
@@ -1,5 +1,6 @@
#
# Copyright 2010-2018 Ettus Research, a National Instruments Company
+# Copyright 2019 Ettus Research, a National Instruments Brand
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
diff --git a/host/docs/CMakeLists.txt b/host/docs/CMakeLists.txt
index dad958bc5..240a534db 100644
--- a/host/docs/CMakeLists.txt
+++ b/host/docs/CMakeLists.txt
@@ -1,6 +1,7 @@
#
# Copyright 2010-2013,2015 Ettus Research LLC
# Copyright 2018 Ettus Research, a National Instruments Company
+# Copyright 2019 Ettus Research, a National Instruments Brand
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
@@ -103,6 +104,10 @@ if(ENABLE_MANUAL_OR_DOXYGEN)
${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
@ONLY)
+ configure_file(
+ ${CMAKE_CURRENT_SOURCE_DIR}/build.dox.in
+ ${CMAKE_CURRENT_BINARY_DIR}/build.dox
+ @ONLY)
#make doxygen directory depend on the header files
file(GLOB_RECURSE header_files ${CMAKE_SOURCE_DIR}/include/*.hpp)
diff --git a/host/docs/build.dox b/host/docs/build.dox.in
index 22f21cbd6..9e4f91ce4 100644
--- a/host/docs/build.dox
+++ b/host/docs/build.dox.in
@@ -26,16 +26,16 @@ follow the auxiliary download URL for the Windows installer (below).
The following compilers are known to work and officially supported:
-- GCC >= 5.4
-- Clang >= 3.8
-- MSVC >= 2015 (14.0); the free version works. Users need to install the "Desktop Development with C++" Workload for Visual Studio. On Windows, it can be found in: Tools -> Get Tools and Features... -> Workloads -> Windows
+- GCC >= @GCC_MIN_VERSION@
+- Clang >= @CLANG_MIN_VERSION@
+- MSVC >= @MSVC_MIN_VERSION_READABLE@; the free version works. Users need to install the "Desktop Development with C++" Workload for Visual Studio. On Windows, it can be found in: Tools -> Get Tools and Features... -> Workloads -> Windows
Other compilers (or lower versions) may work, but are unsupported.
### CMake
- **Purpose:** generates project build files
-- **Minimum Version:** 3.5.1
+- **Minimum Version:** @CMAKE_MIN_VERSION@
- **Usage:** build time (required)
- **Download URL:** http://www.cmake.org/cmake/resources/software.html
@@ -44,7 +44,7 @@ For Windows users, copy the CMake file to Program Files, e.g. `C:\Program Files\
### Boost
- **Purpose:** C++ library
-- **Minimum Version:** 1.58
+- **Minimum Version:** @BOOST_MIN_VERSION@
- **Usage:** build time + runtime (required)
- **Download URL:** http://www.boost.org/users/download/
- **Download URL (Windows installer):** http://sourceforge.net/projects/boost/files/boost-binaries/
@@ -90,7 +90,7 @@ The directory to which you extract libusb must not contain spaces. This is to sa
### Mako
- **Purpose:** source code generation
-- **Minimum Version:** 0.5.0
+- **Minimum Version:** @PY_MAKO_MIN_VERSION@
- **Usage:** build time (required)
- **Download URL:** http://www.makotemplates.org/download.html
- **Alternative method:** You can use `pip` or `easy_install` to install Mako from PyPi. To install it using 'pip' on Windows, navigate to Python scripts folder, e.g. ´C:\local\Python37\Scripts`, and run the following command: