summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCraig Scott <craig.scott@crascit.com>2019-07-16 13:25:46 (GMT)
committerCraig Scott <craig.scott@crascit.com>2019-07-17 11:35:12 (GMT)
commit0518e675eaa4fa7e539f4e1ec9cd7f3a40b3a0da (patch)
tree4d4ab741a24bf1bf0fa2e8ab6f547be4704695bd
parent79a21ba6804ea501365386ee2616441c9660f3ed (diff)
downloadCMake-0518e675eaa4fa7e539f4e1ec9cd7f3a40b3a0da.zip
CMake-0518e675eaa4fa7e539f4e1ec9cd7f3a40b3a0da.tar.gz
CMake-0518e675eaa4fa7e539f4e1ec9cd7f3a40b3a0da.tar.bz2
CMake.qch: Don't include the version in the file name
Fixes: #19374
-rw-r--r--Help/release/dev/cmake-qch-no-version-in-filename.rst8
-rw-r--r--Utilities/Sphinx/CMakeLists.txt3
-rw-r--r--Utilities/Sphinx/conf.py.in2
-rw-r--r--Utilities/Sphinx/fixup_qthelp_names.cmake9
4 files changed, 10 insertions, 12 deletions
diff --git a/Help/release/dev/cmake-qch-no-version-in-filename.rst b/Help/release/dev/cmake-qch-no-version-in-filename.rst
new file mode 100644
index 0000000..3c5cb04
--- /dev/null
+++ b/Help/release/dev/cmake-qch-no-version-in-filename.rst
@@ -0,0 +1,8 @@
+cmake-qch-no-version-in-filename
+--------------------------------
+
+* The Qt Compressed Help file is now named ``CMake.qch``, which no longer
+ contains the release version in the file name. When CMake is upgraded
+ in-place, the name and location of this file will remain constant.
+ Tools such as IDEs, help viewers, etc. should now be able to refer to this
+ file at a fixed location that remains valid across CMake upgrades.
diff --git a/Utilities/Sphinx/CMakeLists.txt b/Utilities/Sphinx/CMakeLists.txt
index c5b2bfe..e4e6e05 100644
--- a/Utilities/Sphinx/CMakeLists.txt
+++ b/Utilities/Sphinx/CMakeLists.txt
@@ -105,7 +105,6 @@ if(SPHINX_QTHELP)
# Workaround sphinx configurability:
# https://bitbucket.org/birkenfeld/sphinx/issue/1448/make-qthelp-more-configurable
COMMAND ${CMAKE_COMMAND} "-DQTHELP_DIR=${CMAKE_CURRENT_BINARY_DIR}/qthelp/"
- "-DCMake_VERSION=${CMake_VERSION_MAJOR}${CMake_VERSION_MINOR}${CMake_VERSION_PATCH}"
-P "${CMAKE_CURRENT_SOURCE_DIR}/fixup_qthelp_names.cmake"
# Create proper identifiers. Workaround for
@@ -216,7 +215,7 @@ endif()
if(SPHINX_QTHELP)
CMake_OPTIONAL_COMPONENT(sphinx-qthelp)
- install(FILES ${CMAKE_CURRENT_BINARY_DIR}/qthelp/CMake-${CMake_VERSION_MAJOR}${CMake_VERSION_MINOR}${CMake_VERSION_PATCH}.qch
+ install(FILES ${CMAKE_CURRENT_BINARY_DIR}/qthelp/CMake.qch
DESTINATION ${CMAKE_DOC_DIR} ${COMPONENT}
)
endif()
diff --git a/Utilities/Sphinx/conf.py.in b/Utilities/Sphinx/conf.py.in
index 70ba080..e50c4f9 100644
--- a/Utilities/Sphinx/conf.py.in
+++ b/Utilities/Sphinx/conf.py.in
@@ -82,4 +82,4 @@ html_favicon = '@conf_path@/static/cmake-favicon.ico'
# Not supported yet by sphinx:
# https://bitbucket.org/birkenfeld/sphinx/issue/1448/make-qthelp-more-configurable
# qthelp_namespace = "org.cmake"
-# qthelp_qch_name = "CMake-300.qch"
+# qthelp_qch_name = "CMake.qch"
diff --git a/Utilities/Sphinx/fixup_qthelp_names.cmake b/Utilities/Sphinx/fixup_qthelp_names.cmake
index e35ef25..179e846 100644
--- a/Utilities/Sphinx/fixup_qthelp_names.cmake
+++ b/Utilities/Sphinx/fixup_qthelp_names.cmake
@@ -10,15 +10,6 @@ string(REPLACE
QHCP_CONTENT "${QHCP_CONTENT}"
)
-string(REPLACE
- "<output>CMake.qch" "<output>CMake-${CMake_VERSION}.qch"
- QHCP_CONTENT "${QHCP_CONTENT}"
-)
-string(REPLACE
- "<file>CMake.qch" "<file>CMake-${CMake_VERSION}.qch"
- QHCP_CONTENT "${QHCP_CONTENT}"
-)
-
file(WRITE "${QTHELP_DIR}/CMake.qhcp" "${QHCP_CONTENT}")