summaryrefslogtreecommitdiffstats
path: root/Help/guide
Commit message (Collapse)AuthorAgeFilesLines
* Help: Minor grammar fix for the Using Dependencies manualCraig Scott2022-07-231-1/+1
|
* Help: Mark features new to 3.24 in Using Dependencies GuideFeRD (Frank Dana)2022-06-271-0/+4
| | | | | | The sections on FetchContent's FIND_PACKAGE_ARGS and on Dependency Providers only apply to CMake 3.24+, so add versionadded markers at the start of both sections.
* Help: Overhaul and expand the Using Dependencies GuideCraig Scott2022-06-091-172/+387
| | | | | | | | The guide previously only focused on the find_package() command, with a bias towards libraries. FetchContent was not mentioned at all. Reorganise and update the existing content. Add new sections to cover providing dependencies with FetchContent and dependency providers. Improve discoverability of the guide by mentioning it at the beginning of the find_package(), FetchContent and dependency provider docs.
* Tutorial: Simplify logic checking for cmath functionsBrad King2022-06-013-19/+19
| | | | | | | | | | | | | | Since commit 07223c5c27 (Tutorial: Update Step 5 to work on Windows, 2020-02-18, v3.18.0-rc1~655^2) the logic does not work on non-Windows platforms when cmake is re-run on an existing build tree. It is also more complicated than we'd like for a tutorial example. Avoid the need to consider the `m` library case by performing the check as C++. Since `check_cxx_symbol_exists` cannot handle overloaded functions like `exp` and `log`, check with `check_cxx_source_compiles` instead. This also presents a more general-purpose example in the tutorial. Fixes: #23524
* Tutorial: Provide a source archive when published on cmake.orgBrad King2022-04-282-2/+6
| | | | | | | | | Provide readers following the tutorial on `cmake.org` a direct link to download the tutorial's source examples. Previously readers had to fetch the CMake source tree separately and look for the tutorial source examples inside it. Fixes: #22475
* Help/guide: Fix wrong header file referenceMartin Duffy2022-04-211-2/+3
| | | | | Step 2 references mysqrt.h instead of MathFunctions.h. MathFunctions/mysqrt.h doesn't exist until Step 9.
* Tutorial: Fix casing of reference to License.txtØystein Sørensen2022-03-211-1/+1
| | | | | Correct a tiny typo in the Step 7 tutorial. Change so `License.txt` correctly starts with a capital `L`.
* Help: use package-specific var for supported component listConnor Imes2022-02-141-2/+2
| | | | | | | | | | | | Always using `_supported_components` causes conflicts when transitive dependencies also set this variable, e.g., because the developers followed these code samples. An even more general approach could be to set `_${CMAKE_FIND_PACKAGE_NAME}_supported_components` instead, but such a change should then be applied to other variables for consistency. Fixes: #23112
* Merge topic 'ide_guide'Brad King2022-01-131-0/+28
|\ | | | | | | | | | | | | 6a5936c596 Help: Add IDE Integration Guide section on IDEs supporting CMake Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6851
| * Help: Add IDE Integration Guide section on IDEs supporting CMakeSemyon Kolton2022-01-121-0/+28
| |
* | Guide: Recommend -C for IDE presets instead of -DKyle Edwards2022-01-071-0/+6
| | | | | | | | Issue: #23083
* | Merge topic 'tutorial-cpack-source-archive'Brad King2021-12-016-2/+12
|\ \ | | | | | | | | | | | | | | | | | | | | | | | | 39c410624a Tutorial: in step 7, disambiguate installed/source archive 44c527bc63 Tutorial: Package only one source archive Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !6765
| * | Tutorial: in step 7, disambiguate installed/source archiveJoachim Wuttke (h)2021-11-301-1/+5
| | |
| * | Tutorial: Package only one source archiveJoachim Wuttke (h)2021-11-306-1/+7
| |/
* | Tutorial: Order install(TARGETS) EXPORT option consistently with docsJoachim Wuttke (h)2021-11-302-4/+4
|/
* LCC: Add dedicated support for MCST LCC compilermakise-homura2021-10-153-3/+3
| | | | | | | | | | | | | | | | | | | | | Divert LCC compiler as a new one, instead of treating it as GNU. Since old times, Elbrus C/C++/Fortran Compiler (LCC) by MCST has been passing checks for GNU compilers, so it has been identified as GNU. Now, with intent of seriously upstreaming its support, it has been added as a separate LCC compiler, and its version displays not a supported GCC version, but LCC version itself (e.g. LCC 1.25.19 instead of GNU 7.3.0). This commit adds its support for detection, and also converts basically every check like 'is this compiler GNU?' to 'is this compiler GNU or LCC?'. The only places where this check is untouched, is where it regards other platforms where LCC is unavailable (primarily non-Linux), and where it REALLY differs from GNU compiler. Note: this transition may break software that are already ported to Elbrus, but hardly relies that LCC will be detected as GNU; still such software is not known.
* Tutorial: Step 4 improvementsJoseph Snyder2021-10-0710-12/+14
| | | | | | | | | | | Small changes to the text and CMake code for the fourth step of the tutorial: * Remove parameter from endfunction call * Standardize on "binary directory" for test location * Add additional information about a Release build. Issue: #22663
* Tutorial: Add version update instructions to Step 10Joseph Snyder2021-10-051-0/+10
| | | | | | | Add instructions to update the cmake_minimum_required version to 3.15 just before the usage of COMPILE_LANG_AND_ID Issue: #22663
* Merge topic 'tutorial_update_step_11'Brad King2021-10-052-5/+45
|\ | | | | | | | | | | | | | | 6dade88d1c Tutorial: Add documentation on Package helper functions 1bf25b5b5f Tutorial: Remove information about EXPORT keyword Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6575
| * Tutorial: Add documentation on Package helper functionsJoseph Snyder2021-09-302-1/+41
| | | | | | | | | | | | | | | | | | | | Add documentation for the configure_package_config_file() and write_basic_package_version_file() commands. Update the comment for the installation of those files to allow a stopping point for the code display. Issue: #22663
| * Tutorial: Remove information about EXPORT keywordJoseph Snyder2021-09-301-4/+4
| | | | | | | | | | Remove the text that implies that the EXPORT keyword will also install the generated CMake file.
* | Merge topic 'tutorial-regex'Brad King2021-10-049-9/+9
|\ \ | | | | | | | | | | | | | | | | | | 0f17b37b96 Tutorial: Fix regexps in sample CMakeLists.txt files Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6572
| * | Tutorial: Fix regexps in sample CMakeLists.txt filesChristophe Bernard2021-09-309-9/+9
| |/ | | | | | | | | | | Replace original regexp `[-nan|nan|0]` with `(-nan|nan|0)` which is what the author most likely intended to write in the first place.
* | Merge topic 'tutorial-step1'Brad King2021-10-041-23/+47
|\ \ | | | | | | | | | | | | | | | | | | 14600a42c8 Tutorial: Update Step 1 instructions Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6576
| * | Tutorial: Update Step 1 instructionsBetsy McPhail2021-09-301-23/+47
| |/ | | | | | | | | To demonstrate how simple a CMake project can be, move the `Build and Run` section earlier in the step.
* | Tutorial: Clarify instructions in Step 5Betsy McPhail2021-09-301-1/+4
|/
* Merge topic 'tutorial_update_step_8'Brad King2021-09-282-3/+24
|\ | | | | | | | | | | | | f55a02a26e Tutorial: Enhance CTestConfig info in Step 8 Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6565
| * Tutorial: Enhance CTestConfig info in Step 8Joseph Snyder2021-09-272-3/+24
| | | | | | | | | | | | | | | | | | | | | | Add a copy of the CTestConfig.cmake from Step 9 into the directory for Step 8. Expand the information about the contents of the CTestConfig file and write a brief explanation of where on CDash to acquire the CTestConfig file for a specific project. CMake Issue: #22663
* | Tutorial: Describe placement of add_subdirectoryJoseph Snyder2021-09-241-2/+7
|/ | | | | | | | | | | | Clarify that the process of making a target optional in the second step of the tutorial is further steps to the work done before, not a separate addition to the file. Do this by ensuring that the paragraph which describes the work done mentions the placement and use of the previous command. This is done to avoid duplication of the add_subdirectory call. CMake Issue: #22663
* Tutorial: Make code snippets linkableBrad King2021-06-1812-0/+52
| | | | | | Extend the change from commit 9e5bbb69ea (Tutorial: Add captions for code blocks, 2021-06-11) to also add a Sphinx named target to code blocks. Name each target after the change the code block makes.
* Tutorial: Add infrastructure to preserve old links when renaming stepsBrad King2021-06-171-0/+9
|
* Tutorial: Add captions for code blocksJosef Angstenberger2021-06-1712-0/+52
|
* Tutorial: Small formatting improvementsJosef Angstenberger2021-06-1711-39/+43
| | | | | | - Use inline literals for all code fragments and names. - Add missing console code-blocks. - Always use c++, not c as code language.
* Tutorial: Fix links after splitting stepsJosef Angstenberger2021-06-175-14/+16
|
* Tutorial: Split steps into separate filesJosef Angstenberger2021-06-1713-931/+932
| | | | Fixes: #21737
* Tutorial: Break up intro paragraphBrad King2021-06-171-6/+7
|
* Help: Fix typos and spelling in documentationJosef Angstenberger2021-05-071-1/+1
|
* Merge topic 'doc-preset-schema-relative'Brad King2021-05-041-3/+3
|\ | | | | | | | | | | | | | | 75dadc4558 Help: Use relative path for IDE Integration guide link to preset schema Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Kyle Edwards <kyle.edwards@kitware.com> Merge-request: !6083
| * Help: Use relative path for IDE Integration guide link to preset schemaBrad King2021-05-031-3/+3
| | | | | | | | | | This allows the integration guide to build as part of a larger set of documentation.
* | Tutorial: Step12 install MathFunctionsConfigVersion.cmakeAlexander Pivovarov2021-04-201-0/+1
| |
* | Help/guide: use GNUInstallDirs in importing-exporting exampleBen Boeckel2021-03-195-25/+35
|/ | | | | | This allows the example to also show how to work on systems with different libdir settings (e.g., Debian multiarch or Red Hat multilib) rather than a regular `lib` directory.
* Help/guide: fix the remaining CMake install destinationsBen Boeckel2021-03-013-4/+4
| | | | Followup from !5674.
* Help: Update to VS ClangCL toolset in user-interaction exampleTim Hutton2021-02-011-1/+1
| | | | | | | As of VS 2019 the toolset is now called `ClangCL`. The toolset `LLVM` is no longer supported. Issue: #20415
* Tutorial: Remove incorrect instructions from Step 5Betsy McPhail2021-01-141-57/+10
| | | | | | | The first section of Step 5 is not tested, incorrect, and not the recommended solution. Fixes: #21539
* Help/guide: fix importing-exporting CMake install destinationsBen Boeckel2021-01-071-3/+3
|
* Tutorial: Fix minor typo in index.rstfazl2021-01-041-1/+1
| | | | s/mqsqrt.h/mysqrt.h/
* Merge branch 'master' into cmakepresets-schemaKyle Edwards2020-10-201-2/+2
|\
| * Merge topic 'cmake-presets-doc-move'Kyle Edwards2020-10-201-1/+1
| |\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 4a123fc28c Help: Clarify purpose of warnings and errors 6c74bcfc20 Help: Make architecture and toolset descriptions generic 45766789a0 Help: Add inheritance to CMakePresets.json example 88c9d6f6eb Help: Add documentation for debug field efab856008 Help: Show environment field 2208db114c Help: Show multiple ways of doing cacheVariables d30f85193f Help: Move vendor field into example b9c8c57860 Help: s/unusedVars/unusedCli/ ... Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5373
| * | server: remove deprecated 'cmake -E server' modeBrad King2020-10-141-2/+2
| | | | | | | | | | | | | | | | | | The server mode has been deprecated since commit 996e1885c4 (server: deprecate in favor of the file-api, 2019-04-19, v3.15.0-rc1~198^2). Clients should now be using the file-api. Remove the server mode.
* | | Help: Add JSON schema for CMakePresets.jsonBen McMorran2020-10-201-0/+3
| |/ |/|
generated by cgit v0.12 at 2024-12-28 12:22:29 (GMT)