summaryrefslogtreecommitdiffstats
path: root/Modules/ExternalProject.cmake
Commit message (Collapse)AuthorAgeFilesLines
* Merge topic 'doc-improvements'Brad King2022-11-101-6/+6
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | d4d1f85297 Help: Move a note about arguments and genexes into include file 968224484f Help: Drop unused `PROPERTY_GENEX` replace from `prop_tgt/INTERFACE_*` files 65457e4fae Help: Add _See Also_ sections to related CMake commands c86ec79d07 Help: Use direct refs to genexes instead of ``$<GENEX-NAME>`` 8c6274326d Help: Use CMake highlighting for command synopsis c356a94512 Help: Use monospaced font for a genex name in a section title f98c8707f4 Help: Use `code-block:: cmake` instead of `::` for sub-commands descriptions 2ba351ca4f Help: ``CMake`` → CMake ... Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !7873
| * Help: Use role `:program:`Alex Turbov2022-11-061-6/+6
| | | | | | | | | | When mention execitable names use Sphinx semantic role `:program` instead of ``executable`` or **executable**.
* | ExternalProject: Add `INSTALL_BYPRODUCTS` optionAlois Klink2022-11-051-0/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add an `INSTALL_BYPRODUCTS` option to `ExternalProject_Add` that can be used to declare that files are `BYPRODUCTS` of the ExternalProject install step. This is often required by the Ninja generator to explicitly declare dependencies. Previously, many users used `BUILD_BYPRODUCTS`, even if their files were created by the install step, not the build step. This commit essentially just copies the code for `BUILD_BYPRODUCTS`. Fixes: #24120 Fixes: #23056
* | ExternalProject: Clarify `BYPRODUCTS` docsAlois Klink2022-11-031-4/+10
|/ | | | | | | | | | Clarify that the `BUILD_BYPRODUCTS` and `BYPRODUCTS` options in ExternalProject may also be required when using the Ninja generator (as that's one of the primary reasons why you'd want to use those options). I've also mentioned that `add_custom_command` has additional documentation on what `BYPRODUCTS` does.
* ExternalProject: Use -S and -B args to robustly set configure dirsCraig Scott2022-10-271-1/+1
| | | | | | | | | | | | | | | | Previously, the build directory was not explicitly specified. Instead, the current working directory was assumed to be the build directory and the source directory was passed as a positional argument. However, if the source directory contained a CMakeCache.txt, it was treated as a binary directory instead. For the scenario where a project is built in-source and it calls ExternalProject_Add() with its own source directory but a different build directory (e.g. to build itself with a different set of configure arguments), this results in a build error. Explicitly list both the source and build directories using the -S and -B options respectively. This unambiguously sets both, avoiding the above problem. Fixes: #24081
* ExternalProject: Install CMake projects using 'cmake --install'Harry Mallon2022-09-121-4/+5
| | | | | | | | | In some cases, `cmake --install .` implements additional semantics over just `cmake --build . --target install`. For example, using the Xcode "new build system" with `IOS_INSTALL_COMBINED` requires special support from `cmake --install` beyond building the `install` target. Fixes: #23946
* Merge topic 'ExternalProject-default-git-tag'Craig Scott2022-09-041-0/+3
|\ | | | | | | | | | | | | 2a21555ea7 ExternalProject: note the default of `GIT_TAG` being `master` Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !7631
| * ExternalProject: note the default of `GIT_TAG` being `master`Ben Boeckel2022-09-021-0/+3
| | | | | | | | | | | | Reported on Discourse: https://discourse.cmake.org/t/fetchcontent-makeavailable-invalid-reference-master/6386
* | ExternalProject: Fix install on BUILD_ALWAYS+BUILD_BYPRODUCTS with NinjaMaik Nijhuis2022-08-091-0/+14
|/ | | | | | | | | The `BUILD_BYPRODUCTS` option causes the ExternalProject's `build` step in `build.ninja` to have `restat = 1`, so its "always out-of-date" status caused by `BUILD_ALWAYS` does not propagate to the `install` step. Mark the latter step as explicitly always out-of-date too. Fixes: #23820
* ExternalProject: Fix regression in stamp creation for Xcode+iOSBrad King2022-06-211-1/+3
| | | | | | | | | | | | The change to `_ep_add_mkdir_command` in commit 5fbac2bb24 (ExternalProject: Move inline scripts to separate files, 2022-01-22, v3.23.0-rc1~101^2) did not account for the possibility that `CMAKE_CFG_INTDIR` is `$(CONFIGURATION)$(EFFECTIVE_PLATFORM_NAME)` instead of just the configuration name. Pass the value into the helper script on the command line so that the native buildsystem placeholders are evaluated. Fixes: #23645
* ExternalProject: Express per-config step stamp file paths using CONFIG genexBrad King2022-06-081-15/+22
| | | | | | | | | | | | | The ExternalProject module has long used the generator-specific placeholder in the `${CMAKE_CFG_INTDIR}` variable to express per-config stamp file paths in multi-config generators. Now that most generators support generator expressions in custom command outputs, we can use the `$<CONFIG>` genex instead. In particular, this fixes cross-config `BUILD_BYPRODUCTS` with the Ninja Multi-Config generator. Fixes: #23595
* ExternalProject: Reformatting onlyCraig Scott2022-05-221-291/+769
| | | | | | | | - Rewrap docs and commands to 80 character width, as per code guidelines. - Reformat argument lists across multiple lines to improve readability. - Use consistent closing parentheses on multi-line calls. - Clean up indenting.
* ExternalProject: Minor cleanup to use more convenient commandsCraig Scott2022-05-221-12/+14
| | | | There is no effective functional change with this commit. It is mostly just to simplify readability.
* ExternalProject: Remove unused property docsCraig Scott2022-05-221-38/+5
| | | | | | | | BRIEF_DOCS and FULL_DOCS became optional as of edb5059216 (define_property(): Make BRIEF_DOCS and FULL_DOCS optional, 2022-01-18). Remove these options from the define_property() calls, since they served no useful purpose. The canonical documentation of those properties is in the RST docs at the top of the file.
* ExternalProject: Replace SEND_ERROR with FATAL_ERRORCraig Scott2022-05-221-3/+5
| | | | The one remaining SEND_ERROR is still needed because further messages must be written before a final FATAL_ERROR on that code path.
* ExternalProject: Make SVN interactive with USES_TERMINAL_{DOWNLOAD,UPDATE}Michael Durso Jr2022-05-121-2/+15
| | | | | | | | ExternalProject_Add() supports USES_TERMINAL_* flags to enable user input for different steps. The Subversion download options ignored these flags when checking out or updated a Subversion repo. Fixes: #23348
* ExternalProject: Add DOWNLOAD_EXTRACT_TIMESTAMP option and policyKasper Laudrup2022-05-041-4/+56
| | | | | | | | | | Add the option to keep the current filestamps when extracting an archive in ExternalProject_Add. Enabling this option makes the behavior consistent with how ExternalProject_Add is used when checking out code from revision control instead of an archive. Fixes: #22746
* Merge topic 'doc-list-semicolons'Brad King2022-03-161-5/+5
|\ | | | | | | | | | | | | | | | | | | 8abd714176 Help: Clarify that ENVIRONMENT test properties take ;-separated lists 02cf404ace Help: Add advice for dealing with semicolons in lists c4117d9116 ExternalProject: Document that LIST_SEPARATOR works for CMAKE_ARGS too Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Ben Boeckel <ben.boeckel@kitware.com> Merge-request: !7066
| * ExternalProject: Document that LIST_SEPARATOR works for CMAKE_ARGS tooBrad King2022-03-111-5/+5
| | | | | | | | | | | | Since `CMAKE_ARGS` is used to construct the default `CONFIGURE_COMMAND` for CMake-based external projects, the `LIST_SEPARATOR` option works for it too.
* | Help: Clarify behavior of REBASE_CHECKOUT when switching branchesCraig Scott2022-02-211-0/+4
|/ | | Issue: #23216
* ExternalProject: Add support for USES_TERMINAL_PATCH keywordCraig Scott2022-02-031-1/+16
| | | | | | | This brings the patch step into line with all the others which already had their own `USES_TERMINAL_<step>` keyword. All steps (including patch) already have their own `LOG_<step>` keyword too, so the lack of `USES_TERMINAL_PATCH` was inconsistent.
* ExternalProject: Rerun download on SOURCE_DIR changeCraig Scott2022-02-011-60/+54
| | | Fixes: #21748
* ExternalProject: Move inline scripts to separate filesCraig Scott2022-01-221-222/+130
| | | | | | This makes the scripts easier to work on, since the separate files don't require the extra level of escaping that the inlined code did. This also means the scripts can be rendered with appropriate syntax highlighting in IDEs, etc.
* ExternalProject: Ensure _ep_set_directories records cmake pathsCraig Scott2022-01-221-0/+5
|
* ExternalProject: Move existing step scripts to separate subdirectoryCraig Scott2022-01-221-8/+8
| | | | | This is in preparation for moving more inline content to separate scripts as well. Having them in a separate subdirectory is consistent with other modules and will make them easier to find and work with.
* ExternalProject: Fix misuse of IS_NEWER_THAN in timestamp checksCraig Scott2022-01-081-2/+4
| | | | | | | | | | | | This change was originally made in 404cddb7bb (ExternalProject: Fix misuse of IS_NEWER_THAN in timestamp checks, 2021-02-21), but was reverted by 57d442e182 (Revert ExternalProject and FetchContent refactoring, 2021-03-10) due to regressions from other changes. Reapply this fix on its own, since it is still valid. When using a file system which only has second resolution timestamps, there is a reasonably high likelihood of timestamps being the same. The IS_NEWER_THAN test returns true when timestamps are the same, so don't redo downloads when they match exactly.
* Help: Clarify CMAKE_INSTALL_MODE documentationFelix Lelchuk2021-11-231-0/+16
| | | | Fixes: #22869 Co-Authored-By: Craig Scott <craig.scott@crascit.com>
* Help: Add documentation for CMAKE_TLS_CAINFOCraig Scott2021-10-041-4/+4
|
* Merge topic 'git-config-version-check'Brad King2021-05-211-3/+5
|\ | | | | | | | | | | | | 8a9753e427 ExternalProject: Only add git config setting with git 1.7.7 or later Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6145
| * ExternalProject: Only add git config setting with git 1.7.7 or laterCraig Scott2021-05-201-3/+5
| | | | | | | | | | | | | | | | 1cb65e680d (ExternalProject: Prevent the noisy detached head messages on checkout, 2021-01-17) unconditionally added the advice.detachedHead git config setting, but it requires git 1.7.7 or later. Since it isn't fatal to not have it, just noisier, only add it when it is supported. Fixes: #22206
* | Help: Clarify details passed to ExternalProject configure and buildCraig Scott2021-05-161-3/+20
| | | | | | Fixes: #22116
* | Help: Document CMAKE_TLS_VERIFY variable explicitlyMichael Hirsch2021-05-041-1/+1
|/ | | | | Previously it was mentioned only in the `file` and `ExternalProject` documentation.
* Revert ExternalProject and FetchContent refactoringCraig Scott2021-03-091-1086/+706
| | | | | | | | | | | | | | | | | | | | | | | | | | Refactoring of the ExternalProject and FetchContent modules moved the commands into CMake scripts. This broke custom commands that used shell redirection or special build tool variables of the form $(MakeVar). Undo the sequence of commits that performed this refactoring and follow-up fixes associated with it. The following commits are reverted by this change: 4f3d1abbb4 (ExternalProject: Refactor pre-configure steps to support no-target uses, 2021-02-05) 17e5516e60 (FetchContent: Invoke steps directly and avoid a separate sub-build, 2021-01-29) bd876f3849 (FetchContent: Restore patch command support, 2021-02-18) 404cddb7bb (ExternalProject: Fix misuse of IS_NEWER_THAN in timestamp checks, 2021-02-21) b0da671243 (FetchContent: Don't update timestamps if files don't change, 2021-02-18) Fixes: #21892
* FetchContent: Don't update timestamps if files don't changeCraig Scott2021-02-221-4/+22
| | | | | | | | | | | | | | | | | | | | The refactoring in 17e5516e60 (FetchContent: Invoke steps directly and avoid a separate sub-build, 2021-01-29) uses a different way of writing out the step scripts and updating time stamps when steps are executed. That inadvertently always wrote out the scripts for custom commands, even when the contents didn't change. This caused their timestamp to always be updated, resulting in those steps always being seen as out-of-date and needing to be re-executed. The way timestamps were checked to determine whether to re-execute a step also did not adequately account for file systems which only have second-resolution timestamps. The IS_NEWER_THAN if condition also returns true when timestamps are the same, so one needs to use the negative form to get a true "is newer than" test. ExternalProject is not susceptible to this problem because it uses file(GENERATE) to write out the script files and that only updates the file's timestamp if the contents change. It also mostly leaves timestamp checking to the build tool.
* FetchContent: Restore patch command supportCraig Scott2021-02-171-1/+1
| | | | | | The refactoring in 17e5516e60 (FetchContent: Invoke steps directly and avoid a separate sub-build, 2021-01-29) contained a typo which resulted in any PATCH_COMMAND being ignored. Fix the typo and add a test case that would have caught the regression.
* FetchContent: Invoke steps directly and avoid a separate sub-buildCraig Scott2021-02-041-64/+162
| | | | | | | | | | | | The cost of setting up and executing a separate sub-build to do the download, update and patch steps required for FetchContent population can be significant with some platforms and CMake generators. Avoid the sub-build altogether by invoking the step scripts directly. Previously, if no generator was set (e.g. population was being done in script mode), a generator needed to be available on the default PATH. Since we no longer use a sub-build, this restriction is also now gone. Fixes: #21703
* ExternalProject: Refactor pre-configure steps to support no-target usesCraig Scott2021-02-041-670/+934
| | | | | | | | | | | | | | | | | | | | | | The mkdir, download, update and patch steps are used by FetchContent during the configure phase of the main build. Because these steps need a target, this has so far required a sub-build to be set up. The changes here factor out the preparation of the scripts from the creation of the targets, allowing future work to leverage these steps without a sub-build (see #21703). As part of the refactoring, some rationalisation of the stamp files, repository info files and script names was done to make things more consistent between download methods and step implementations. Every download method now records its own specific repository info in a file and that file is a dependency of the download step. The source directory is also written to that file, so if the SOURCE_DIR changes, the download will be retriggered (the existing implementation fails in this scenario). Each download method now also has just one driver script that implements the whole step (it may pull in other scripts to do its task though). The patch step gained support for USES_TERMINAL as a result of generalising the implementation for custom commands. Fixes: #21748
* ExternalProject: Avoid scanning docs for keywords, use include_guard()Craig Scott2021-01-291-54/+178
| | | | | | | | | | | | | | | | | | | | | | The previous implementation was scanning the documentation in the file at runtime to determine the set of supported keywords for each public function. This was fragile, made it difficult to restructure the documentation and was sometimes observable in runtime performance measurements. Change to a more conventional approach where supported keywords are explicitly listed in the code. The internal _ExternalProject_SELF variable is no longer needed. CMake now provides CMAKE_CURRENT_FUNCTION_LIST_DIR which can be used for the same purpose and avoids having to set a variable when the module is read. This also removes the requirement that the module must be included by the current or a parent scope. It is now enough that the module has been included once somewhere before calling any of its functions. The above changes combined mean that the module can now use include_guard() and avoid having to re-parse the very long file every time.
* ExternalProject: Prevent the noisy detached head messages on checkoutCraig Scott2021-01-281-0/+4
| | | | | | When checking out a specific commit by its git hash, git will output a very noisy message about checking out a detached HEAD. This is not particularly helpful for us here and makes the output overall quite verbose. Add a git config setting to prevent it.
* Merge topic 'FindGit-cache-version'Brad King2021-01-211-8/+14
|\ | | | | | | | | | | | | | | 76fdeb6d13 Tests: FindGit already provides the git version, re-use it 315a200f0c FindGit: Cache the GIT_EXECUTABLE version for the current run Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5712
| * FindGit: Cache the GIT_EXECUTABLE version for the current runCraig Scott2021-01-191-8/+14
| | | | | | | | | | | | | | | | | | | | | | The git version should not change while CMake is running. When using FetchContent with many dependencies, the repeated calls to get the git version every time ExternalProject is used can be measurable on some platforms. This commit queries that version only once and then caches it in a global property for the rest of that run. The git version can still safely change between runs because it is not cached, only the GIT_EXECUTABLE location is cached. Relates: #21703
* | ExternalProject: Don't git stash ignored filesCraig Scott2021-01-161-4/+7
|/ | | | | | The change to the binary gitrepo.tgz file adds a commit which adds a .gitignore file. Fixes: #21278
* Merge topic 'ExternalProject-configure-handled-by-build'Brad King2021-01-131-12/+44
|\ | | | | | | | | | | | | 7155e358c9 ExternalProject: Add CONFIGURE_HANDLED_BY_BUILD option Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5626
| * ExternalProject: Add CONFIGURE_HANDLED_BY_BUILD optionDaan De Meyer2021-01-121-12/+44
| | | | | | | | Fixes #21592.
* | ExternalProject: Silence step succeeded message when using NinjaDaan De Meyer2020-12-171-2/+4
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | When doing an ExternalProject superbuild with all output logged to files, the output currently looks as follows: ``` [652/904] Performing install step for 'plasma-framework' -- plasma-framework install command succeeded. See also /root/build/kde/frameworks/plasma-framework/log/plasma-framework-install-*.log [658/904] Performing build step for 'khtml' -- khtml build command succeeded. See also /root/build/kde/frameworks/khtml/log/khtml-build-*.log [659/904] Performing install step for 'khtml' -- khtml install command succeeded. See also /root/build/kde/frameworks/khtml/log/khtml-install-*.log [661/904] Performing configure step for 'krunner' -- krunner configure command succeeded. See also /root/build/kde/frameworks/krunner/log/krunner-configure-*.log [661/904] Performing build step for 'krunner' ``` More specifically, because a success line is printed for every succeeded step, we lose the advantage of Ninja's progress bar which will now also print a new line instead of updating the same link as happens when using Ninja in a normal CMake project. By silencing the success message when using the Ninja generator, Ninja's progress bar works as expected and updates inline instead of printing a new line for each progress update. With this change, the above output is reduced to a single line progress bar: ``` [661/904] Performing build step for 'krunner' ```
* Help: Add `.. versionadded` directives to module docsNikita Nemkin2020-12-021-24/+104
| | | | Issue: #19715
* ExternalProject: Use CMP0114 NEW behavior with Xcode "new build system"Brad King2020-09-181-0/+12
| | | | | | | The ExternalProject module cannot be implemented in the Xcode "new build system" without using CMP0114's NEW behavior. When configuring for that build system, warn if the policy is not set to NEW and use NEW behavior anyway.
* ExternalProject: Add policy CMP0114 to refine step target dependenciesBrad King2020-09-141-43/+235
| | | | | | | | | | | | | | | | | | | | | | | | `ExternalProject_Add_StepTargets` and `INDEPENDENT_STEP_TARGETS` have some limitations and lack some sanity checks. They can cause confusing build systems to be generated. The basic problems are: * The notion of step independence is attached to the step target rather than the step itself. * The custom commands implementing the steps are duplicated in the step targets and the primary targets. This can cause races. It is also incompatible with the Xcode "new build system". Fix this by introducing policy CMP0114 to change the way step target dependencies are handled. Define independence from external dependencies as a property of each individual step regardless of whether there is a target for it. Add dependencies among the primary target and the step targets such that each custom command only appears in one target. When some steps are disconnected from the primary target, add step targets for the steps commonly depended upon so that there is a place to hold their custom commands uniquely. Fixes: #18663
* ExternalProject: Factor out an internal helper to add a step targetBrad King2020-09-101-19/+27
|
* Merge topic 'ExternalProject-retry-only-recoverable'Brad King2020-08-191-2/+14
|\ | | | | | | | | | | | | | | 116b06870d ExternalProject: add INACTIVITY_TIMEOUT argument f24e34975a ExternalProject: retry download on recoverable errors Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5034
generated by cgit v0.12 at 2025-01-08 03:13:57 (GMT)