You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by ig...@apache.org on 2019/04/12 00:12:15 UTC
[geode-native] branch develop updated: GEODE-6635: Native Client
API docs: Use a 3-part version header (#474)
This is an automated email from the ASF dual-hosted git repository.
igodwin pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/geode-native.git
The following commit(s) were added to refs/heads/develop by this push:
new e880e0a GEODE-6635: Native Client API docs: Use a 3-part version header (#474)
e880e0a is described below
commit e880e0a35b9fc0982f74e988427b3f0a9b32bbe6
Author: Dave Barnes <db...@pivotal.io>
AuthorDate: Thu Apr 11 17:12:10 2019 -0700
GEODE-6635: Native Client API docs: Use a 3-part version header (#474)
---
BUILDING.md | 4 +++-
CMakeLists.txt | 2 ++
docs/api/clicache/Doxyfile.in | 2 +-
docs/api/cppcache/Doxyfile.in | 2 +-
4 files changed, 7 insertions(+), 3 deletions(-)
diff --git a/BUILDING.md b/BUILDING.md
index be3b25b..0bf6d16 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -33,10 +33,12 @@ $ cmake .. <platform-specific generator parameters (see below)>
# build step
$ cmake --build . -- <platform-specific parallelism parameters (see below)>
```
-If OpenSSL is installed in a custom location, then one must pass `OPENSSL_ROOT_DIR` during the CMake configuration step. e.g. add `-DOPENSSL_ROOT_DIR=/path/to/openssl`.
+If OpenSSL is installed in a custom location, then you must pass `OPENSSL_ROOT_DIR` during the CMake configuration step. For example, `-DOPENSSL_ROOT_DIR=/path/to/openssl`.
To explicitly specify the location in which the Native Client will be installed, add `-DCMAKE_INSTALL_PREFIX=/path/to/installation/destination` to this initial `cmake` execution command.
+To set the version header on the API docs, specify PRODUCT_VERSION on the configuration command line. For example, `-DPRODUCT_VERSION=1.2.3`.
+
### Generator
CMake uses a "generator" to produce configuration files for use by a variety of build tools, e.g., UNIX makefiles, Visual Studio projects. By default a system-specific generator is used by CMake during configuration. (Please see [the CMake documentation](https://cmake.org/documentation/) for further information.) However, in many cases there is a better choice.
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 5118e1e..1a059ac 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -88,6 +88,8 @@ list(GET PRODUCT_VERSION_LIST 1 PRODUCT_VERSION_MINOR)
list(GET PRODUCT_VERSION_LIST 2 PRODUCT_VERSION_PATCH)
list(GET PRODUCT_VERSION_LIST 3 PRODUCT_VERSION_BUILD)
+set(APIDOC_VERSION ${PRODUCT_VERSION_MAJOR}.${PRODUCT_VERSION_MINOR}.${PRODUCT_VERSION_PATCH})
+
# Please note that attempts to set CMAKE_INSTALL_PREFIX to a *ROOTED*
# path here will fail due to the design of CMake according to its
# development team. Setting it to a relative path appears to work.
diff --git a/docs/api/clicache/Doxyfile.in b/docs/api/clicache/Doxyfile.in
index 703797b..4855120 100644
--- a/docs/api/clicache/Doxyfile.in
+++ b/docs/api/clicache/Doxyfile.in
@@ -82,7 +82,7 @@ JAVADOC_AUTOBRIEF = YES
MACRO_EXPANSION = YES
OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@
PROJECT_NAME = "@PRODUCT_VENDOR@ @PRODUCT_NAME@ .NET Reference"
-PROJECT_NUMBER = "@PRODUCT_VERSION_SHORT@"
+PROJECT_NUMBER = "@APIDOC_VERSION@"
PREDEFINED = "internal=private" \
"STATICCLASS=" \
"GFINDEXER(x)=Item"
diff --git a/docs/api/cppcache/Doxyfile.in b/docs/api/cppcache/Doxyfile.in
index da8c8d7..5f3d72a 100644
--- a/docs/api/cppcache/Doxyfile.in
+++ b/docs/api/cppcache/Doxyfile.in
@@ -71,7 +71,7 @@ JAVADOC_AUTOBRIEF = YES
MACRO_EXPANSION = YES
OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@
PROJECT_NAME = "@PRODUCT_VENDOR@ @PRODUCT_NAME@ C++ Reference"
-PROJECT_NUMBER = "@PRODUCT_VERSION_SHORT@"
+PROJECT_NUMBER = "@APIDOC_VERSION@"
PREDEFINED = DOXYGEN
SHOW_USED_FILES = NO
SKIP_FUNCTION_MACROS = NO