diff --git a/CMakeLists.txt b/CMakeLists.txt --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -31,3 +31,4 @@ add_subdirectory(src) add_subdirectory(test) +add_subdirectory(doc) diff --git a/configure.ac b/configure.ac --- a/configure.ac +++ b/configure.ac @@ -1219,6 +1219,7 @@ AC_CONFIG_FILES([Makefile src/Makefile doc/man/Makefile share/setup.nsi share/qt/Info.plist test/config.ini]) AC_CONFIG_FILES([contrib/devtools/split-debug.sh],[chmod +x contrib/devtools/split-debug.sh]) AC_CONFIG_LINKS([contrib/filter-lcov.py:contrib/filter-lcov.py]) +AC_CONFIG_FILES([doc/Doxyfile]) AC_CONFIG_FILES([src/config/version.h]) AC_CONFIG_LINKS([test/functional/test_runner.py:test/functional/test_runner.py]) AC_CONFIG_LINKS([test/util/bitcoin-util-test.py:test/util/bitcoin-util-test.py]) diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt new file mode 100644 --- /dev/null +++ b/doc/CMakeLists.txt @@ -0,0 +1,3 @@ +# Copyright (c) 2019 The Bitcoin developers + +configure_file(Doxyfile.cmake.in Doxyfile ESCAPE_QUOTES) diff --git a/doc/Doxyfile b/doc/Doxyfile.cmake.in rename from doc/Doxyfile rename to doc/Doxyfile.cmake.in --- a/doc/Doxyfile +++ b/doc/Doxyfile.cmake.in @@ -32,13 +32,13 @@ # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "Bitcoin ABC" +PROJECT_NAME = "${PACKAGE_NAME}" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 0.19.10 +PROJECT_NUMBER = ${CLIENT_VERSION_MAJOR}.${CLIENT_VERSION_MINOR}.${CLIENT_VERSION_REVISION} # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/doc/Doxyfile b/doc/Doxyfile.in rename from doc/Doxyfile rename to doc/Doxyfile.in --- a/doc/Doxyfile +++ b/doc/Doxyfile.in @@ -32,13 +32,13 @@ # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "Bitcoin ABC" +PROJECT_NAME = "@PACKAGE_NAME@" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 0.19.10 +PROJECT_NUMBER = @PACKAGE_VERSION@ # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/doc/developer-notes.md b/doc/developer-notes.md --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -158,7 +158,7 @@ To build doxygen locally to test changes to the Doxyfile or visualize your comments before landing changes: ``` -# at the project root, call: +# In the build directory, call: doxygen doc/Doxyfile # output goes to doc/doxygen/html/ ``` diff --git a/doc/release-process.md b/doc/release-process.md --- a/doc/release-process.md +++ b/doc/release-process.md @@ -51,7 +51,6 @@ 9. Notify maintainers of Ubuntu PPA, AUR, and Docker images to build their packages. 10. Increment version number in: - - doc/Doxyfile - doc/release-notes.md (and copy existing one to versioned doc/release-notes/*.md) - configure.ac - src/config/CMakeLists.txt diff --git a/src/config/CMakeLists.txt b/src/config/CMakeLists.txt --- a/src/config/CMakeLists.txt +++ b/src/config/CMakeLists.txt @@ -8,13 +8,13 @@ include(CheckCXXSourceCompiles) # Package information -set(PACKAGE_NAME "Bitcoin ABC") +set(PACKAGE_NAME "Bitcoin ABC" CACHE STRING "Package name") # Version -set(CLIENT_VERSION_MAJOR 0) -set(CLIENT_VERSION_MINOR 19) -set(CLIENT_VERSION_REVISION 10) -set(CLIENT_VERSION_BUILD 0) +set(CLIENT_VERSION_MAJOR 0 CACHE STRING "Major version number") +set(CLIENT_VERSION_MINOR 19 CACHE STRING "Minor version number") +set(CLIENT_VERSION_REVISION 10 CACHE STRING "Revision version number") +set(CLIENT_VERSION_BUILD 0 CACHE STRING "Build version number") option(CLIENT_VERSION_IS_RELEASE "Build a release version" OFF)