Quellcode durchsuchen

Use the release number and commit id from git in the generation documentation.

Julius Pfrommer vor 8 Jahren
Ursprung
Commit
67f0130946
3 geänderte Dateien mit 14 neuen und 6 gelöschten Zeilen
  1. 8 3
      CMakeLists.txt
  2. 2 0
      doc/CMakeLists.txt
  3. 4 3
      doc/conf.py

+ 8 - 3
CMakeLists.txt

@@ -10,16 +10,21 @@ set(CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/tools/cmake")
 find_package(PythonInterp REQUIRED)
 find_package(Git)
 if(GIT_FOUND)
-  execute_process(COMMAND ${GIT_EXECUTABLE} describe --abbrev=7 --dirty --always --tags
+  execute_process(COMMAND ${GIT_EXECUTABLE} describe --always --tags
                   RESULT_VARIABLE res_var OUTPUT_VARIABLE GIT_COM_ID WORKING_DIRECTORY ${CMAKE_SOURCE_DIR})
+  execute_process(COMMAND ${GIT_EXECUTABLE} describe --abbrev=0 --always --tags
+                  RESULT_VARIABLE res_var OUTPUT_VARIABLE GIT_REL_ID WORKING_DIRECTORY ${CMAKE_SOURCE_DIR})
     if(NOT ${res_var} EQUAL 0)
-        set(GIT_COMMIT_ID "unknown--git-commit-id-unknown")
+        set(GIT_COMMIT_ID "commit id unknown")
+        set(GIT_RELEASE_ID "release unknown")
         message(STATUS "Git failed (not a repo, or no tags). Build will not contain git revision info." )
     else()
         string(REPLACE "\n" "" GIT_COMMIT_ID ${GIT_COM_ID} )
+        string(REPLACE "\n" "" GIT_RELEASE_ID ${GIT_REL_ID} )
     endif()
 else()
-    set(GIT_COMMIT_ID "unknown--no-git-found")
+    set(GIT_COMMIT_ID "commit id unknown")
+    set(GIT_RELEASE_ID "release unknown")
     message(STATUS "Git not found. Build will not contain git revision info." )
 endif()
 message(STATUS "Git version: "  ${GIT_COMMIT_ID})

+ 2 - 0
doc/CMakeLists.txt

@@ -7,6 +7,8 @@ set(DOC_SRC_DIR   ${PROJECT_BINARY_DIR}/doc_src)
 
 make_directory(${DOC_SRC_DIR})
 file(GLOB DOC_SRC "${PROJECT_SOURCE_DIR}/doc/*")
+list(REMOVE_ITEM DOC_SRC "${PROJECT_SOURCE_DIR}/doc/conf.py")
+configure_file("${PROJECT_SOURCE_DIR}/doc/conf.py" "${DOC_SRC_DIR}/conf.py")
 file(COPY ${DOC_SRC} DESTINATION ${DOC_SRC_DIR})
 
 function(generate_rst in out)

+ 4 - 3
doc/conf.py

@@ -55,16 +55,17 @@ author = u'The open62541 authors'
 # built documents.
 #
 # The short X.Y version.
-version = '0.2'
+version = "${GIT_RELEASE_ID}"
+# The full version, including alpha/beta/rc tags.
+release = "${GIT_COMMIT_ID}"
 # The full version, including alpha/beta/rc tags.
-release = '1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used: