Merge topic 'release-3.20-cleanups' into release-3.20

7c147b21c7 Help: Add Ninja Multi-Config and make generator types into links 5039ca1126 Help: Convert output directory variable mentions to cross-references 1a7e51b9d5 Help: Cleanup wording and links in 3.20 release notes d16830324f CPackIFW: Improve warning and docs for show page list option 7ed7db88a4 CPackIFW: Fix cppcheck warnings Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5810
2026-01-06 05:40:54 -06:00 · 2021-02-15 15:32:15 +00:00
parent c1e90c5544 7c147b21c7
commit 7f2203ab4a
7 changed files with 46 additions and 38 deletions
--- a/Help/cpack_gen/ifw.rst
+++ b/Help/cpack_gen/ifw.rst
@@ -111,9 +111,11 @@ Package

 .. variable:: CPACK_IFW_PACKAGE_WIZARD_SHOW_PAGE_LIST

+ .. versionadded:: 3.20
+
 Set to ``OFF`` if the widget listing installer pages on the left side of the wizard should not be shown.

- Is ``ON`` by default.
+ It is ``ON`` by default, but will only have an effect if using QtIFW 4.0 or later.

 .. variable:: CPACK_IFW_PACKAGE_TITLE_COLOR

--- a/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst
+++ b/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst
@@ -3,7 +3,7 @@ ARCHIVE_OUTPUT_DIRECTORY

 .. |XXX| replace:: :ref:`ARCHIVE <Archive Output Artifacts>`
 .. |xxx| replace:: archive
-.. |CMAKE_XXX_OUTPUT_DIRECTORY| replace:: CMAKE_ARCHIVE_OUTPUT_DIRECTORY
+.. |CMAKE_XXX_OUTPUT_DIRECTORY| replace:: :variable:`CMAKE_ARCHIVE_OUTPUT_DIRECTORY`
 .. include:: XXX_OUTPUT_DIRECTORY.txt

 See also the :prop_tgt:`ARCHIVE_OUTPUT_DIRECTORY_<CONFIG>` target property.
--- a/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst
+++ b/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst
@@ -3,7 +3,7 @@ LIBRARY_OUTPUT_DIRECTORY

 .. |XXX| replace:: :ref:`LIBRARY <Library Output Artifacts>`
 .. |xxx| replace:: library
-.. |CMAKE_XXX_OUTPUT_DIRECTORY| replace:: CMAKE_LIBRARY_OUTPUT_DIRECTORY
+.. |CMAKE_XXX_OUTPUT_DIRECTORY| replace:: :variable:`CMAKE_LIBRARY_OUTPUT_DIRECTORY`
 .. include:: XXX_OUTPUT_DIRECTORY.txt

 See also the :prop_tgt:`LIBRARY_OUTPUT_DIRECTORY_<CONFIG>` target property.
--- a/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst
+++ b/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst
@@ -3,7 +3,7 @@ RUNTIME_OUTPUT_DIRECTORY

 .. |XXX| replace:: :ref:`RUNTIME <Runtime Output Artifacts>`
 .. |xxx| replace:: runtime
-.. |CMAKE_XXX_OUTPUT_DIRECTORY| replace:: CMAKE_RUNTIME_OUTPUT_DIRECTORY
+.. |CMAKE_XXX_OUTPUT_DIRECTORY| replace:: :variable:`CMAKE_RUNTIME_OUTPUT_DIRECTORY`
 .. include:: XXX_OUTPUT_DIRECTORY.txt

 See also the :prop_tgt:`RUNTIME_OUTPUT_DIRECTORY_<CONFIG>` target property.
--- a/Help/prop_tgt/XXX_OUTPUT_DIRECTORY.txt
+++ b/Help/prop_tgt/XXX_OUTPUT_DIRECTORY.txt
@@ -3,9 +3,10 @@ Output directory in which to build |XXX| target files.
 This property specifies the directory into which |xxx| target files
 should be built.  The property value may use
 :manual:`generator expressions <cmake-generator-expressions(7)>`.
-Multi-configuration generators (VS, Xcode) append a per-configuration
-subdirectory to the specified directory unless a generator expression
-is used.
+Multi-configuration generators (:ref:`Visual Studio <Visual Studio Generators>`,
+:generator:`Xcode`, :generator:`Ninja Multi-Config`) append a
+per-configuration subdirectory to the specified directory unless a generator
+expression is used.

-This property is initialized by the value of the variable
-|CMAKE_XXX_OUTPUT_DIRECTORY| if it is set when a target is created.
+This property is initialized by the value of the
+|CMAKE_XXX_OUTPUT_DIRECTORY| variable if it is set when a target is created.
--- a/Help/release/3.20.rst
+++ b/Help/release/3.20.rst
@@ -103,16 +103,16 @@ Commands
 * The :command:`cmake_path` command was added for operations on
  filesystem paths.

-* The :command:`configure_file` command gained a ``USE_SOURCE_PERMISSIONS``
-  and ``FILE_PERMISSIONS`` option to support copying of permissions of source
-  file and specifying user defined permissions.
+* The :command:`configure_file` command gained ``USE_SOURCE_PERMISSIONS``
+  and ``FILE_PERMISSIONS`` options to support copying of permissions of the
+  source file and using specified permissions respectively.

-* The :command:`file(GENERATE)` command gained ``NEWLINE_STYLE`` option to
-  support newline style of the generated file.
+* The :command:`file(GENERATE)` command gained a ``NEWLINE_STYLE`` option to
+  specify how newlines are handled for the generated file.

 * The :command:`file(GENERATE)` command gained ``NO_SOURCE_PERMISSIONS``,
-  ``USE_SOURCE_PERMISSIONS``, and ``FILE_PERMISSIONS`` options to support
-  permissions of the generated file.
+  ``USE_SOURCE_PERMISSIONS``, and ``FILE_PERMISSIONS`` options for controlling
+  the permissions of the generated file.

 * The :command:`install(FILES)` command ``RENAME`` option learned to
  support :manual:`generator expressions <cmake-generator-expressions(7)>`.
@@ -171,14 +171,14 @@ Modules
 -------

 * The :module:`ExternalData` module :command:`ExternalData_Add_Target`
-  function gained a ``SHOW_PROGRESS <bool>`` option to suppress progress
-  output during the build.
+  function gained a ``SHOW_PROGRESS <bool>`` option for controlling whether
+  or not to show progress output during the build.

 * The :module:`ExternalProject` module :command:`ExternalProject_Add` function
-  gained a ``CONFIGURE_HANDLED_BY_BUILD`` option to have subsequent runs of
-  the configure step be triggered by the build step when an external project
-  dependency rebuilds instead of always rerunning the configure step when
-  an external project dependency rebuilds.
+  gained a ``CONFIGURE_HANDLED_BY_BUILD`` option.  This can be used to make
+  subsequent runs of the configure step be triggered by the build step when
+  an external project dependency rebuilds instead of always re-running the
+  configure step in such cases.

 * The :module:`FindBoost` module gained a ``Boost_NO_WARN_NEW_VERSIONS``
  option to silence the warning about unknown dependencies for new
@@ -234,7 +234,7 @@ CPack
  resolving private library dependencies when using
  ``dpkg-shlibdeps``.

-* The :cpack_gen:`CPack IFW Generator` gained new
+* The :cpack_gen:`CPack IFW Generator` gained a new
  :variable:`CPACK_IFW_PACKAGE_WIZARD_SHOW_PAGE_LIST` variable to
  control visibility of the widget listing installer pages on the left side
  of the wizard. This feature available only since QtIFW 4.0.
@@ -244,9 +244,9 @@ CPack
  :variable:`CPACK_NSIS_BRANDING_TEXT_TRIM_POSITION` variables to change
  the text at the bottom of the install window and change its trim position

-* The :cpack_gen:`CPack NSIS Generator` now handles correctly Unicode characters.
-  If you want to have a ``CPACK_RESOURCE_FILE_LICENSE`` with UTF-8 characters
-  it needs to be encoded in UTF-8 BOM.
+* The :cpack_gen:`CPack NSIS Generator` now correctly handles Unicode
+  characters.  If you want to have a :variable:`CPACK_RESOURCE_FILE_LICENSE`
+  with UTF-8 characters, it needs to be encoded in UTF-8 BOM.

 * The :cpack_gen:`CPack NuGet Generator` gained options:

@@ -327,10 +327,12 @@ Other Changes
  phase when the required content is already populated and
  up-to-date.

-* The precompiled Linux binaries provided on ``cmake.org`` have changed
-  their naming pattern to ``cmake-$ver-linux-$arch``, where ``$arch``
-  is either ``x86_64`` or ``aarch64``.
+* The precompiled Linux binaries provided on
+  `cmake.org <https://cmake.org/download/>`_ have changed their naming pattern
+  to ``cmake-$ver-linux-$arch``, where ``$arch`` is either ``x86_64`` or
+  ``aarch64``.

-* The precompiled Windows binaries provided on ``cmake.org`` have changed
-  their naming pattern to ``cmake-$ver-windows-$arch``, where ``$arch``
-  is either ``x86_64`` or ``i386``.
+* The precompiled Windows binaries provided on
+  `cmake.org <https://cmake.org/download/>`_ have changed their naming pattern
+  to ``cmake-$ver-windows-$arch``, where ``$arch`` is either ``x86_64`` or
+  ``i386``.
--- a/Source/CPack/IFW/cmCPackIFWInstaller.cxx
+++ b/Source/CPack/IFW/cmCPackIFWInstaller.cxx
@@ -188,9 +188,11 @@ void cmCPackIFWInstaller::ConfigureFromOptions()
    } else {
      cmCPackIFWLogger(
        WARNING,
-        "Option CPACK_IFW_PACKAGE_WIZARD_SHOW_PAGE_LIST is set to value \""
-          << option << "\". But has no any effect for QtIFW less than 4.0 "
-          << "and will be skipped." << std::endl);
+        "Option CPACK_IFW_PACKAGE_WIZARD_SHOW_PAGE_LIST is set to \""
+          << option
+          << "\", but it is only supported with QtIFW version 4.0 or later. "
+             "It is being ignored because you are using QtIFW version "
+          << this->Generator->FrameworkVersion.data() << std::endl);
    }
  }

@@ -275,9 +277,8 @@ void cmCPackIFWInstaller::ConfigureFromOptions()
 class cmCPackIFWResourcesParser : public cmXMLParser
 {
 public:
-  cmCPackIFWResourcesParser(cmCPackIFWInstaller* i)
+  explicit cmCPackIFWResourcesParser(cmCPackIFWInstaller* i)
    : installer(i)
-    , file(false)
  {
    this->path = i->Directory + "/resources";
  }
@@ -296,7 +297,9 @@ public:
  }

  cmCPackIFWInstaller* installer;
-  bool file, hasFiles, hasErrors;
+  bool file = false;
+  bool hasFiles = false;
+  bool hasErrors = false;
  std::string path, basePath;

 protected: