summaryrefslogtreecommitdiffstats
path: root/Help/guide
Commit message (Collapse)AuthorAgeFilesLines
* Help: Use direct refs to genexes instead of ``$<GENEX-NAME>``Alex Turbov2022-11-091-2/+1
|
* Help: Use role `:program:`Alex Turbov2022-11-061-1/+1
| | | | | When mention execitable names use Sphinx semantic role `:program` instead of ``executable`` or **executable**.
* Merge topic 'tutorial_step7_update'Brad King2022-10-283-25/+158
|\ | | | | | | | | | | | | | | f9ef15f3dc Tutorial: Update step 7 style Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !7787
| * Tutorial: Update step 7 styleMarkus Ferrell2022-10-273-25/+158
| |
* | Tutorial: Fix Step 5 solution after update to Step 6Markus Ferrell2022-10-271-1/+1
|/ | | | | | Since commit 6e58a01f4e (Tutorial: Update step 6 style, 2022-10-06) the `literalinclude` included an extra comment from step 6 instructions. Fix the include bounds to remove the extra text.
* Merge topic 'tutorial_step6_update'Brad King2022-10-272-30/+66
|\ | | | | | | | | | | | | | | 6e58a01f4e Tutorial: Update step 6 style Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !7756
| * Tutorial: Update step 6 styleMarkus Ferrell2022-10-252-30/+66
| |
* | Tutorial: Restore USE_MYMATH in place of MY_MATHMarkus Ferrell2022-10-254-10/+11
| | | | | | | | | | | | In commit 80f5d28813 (Tutorial: Update step 2 style, 2022-07-25, v3.25.0-rc1~226^2) we replaced some uses of `USE_MYMATH` with `MY_MATH`. Restore the former name for consistency with the rest of the tutorial.
* | Help: Add more CLI `:option:` references to various pagesAlex Turbov2022-10-202-13/+14
| |
* | Tutorial: Fix variable name typo in step 1Steven2022-10-171-1/+1
|/ | | | `CMAKE_CXX_REQUIRED_STANDARD` => `CMAKE_CXX_STANDARD_REQUIRED`
* Merge topic 'tutorial_step5_update'Brad King2022-10-0716-61/+317
|\ | | | | | | | | | | | | | | 92edbce342 Tutorial: Update step 5 style Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !7728
| * Tutorial: Update step 5 styleMarkus Ferrell2022-10-0616-61/+317
| |
* | Help: Disambiguate cmake(1) program modes in Sphinx option referencesBrad King2022-10-051-4/+4
|/ | | | | | Define the entry point to each mode as an option for the `cmake` program, but reference the options for that mode as part of stand-in `cmake-<mode>` programs.
* Merge topic 'tutorial_step4_update'Brad King2022-09-2910-32/+288
|\ | | | | | | | | | | | | | | 37fceb6fd3 Tutorial: Update step 4 style Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !7646
| * Tutorial: Update step 4 styleMarkus Ferrell2022-09-2810-32/+288
| |
* | Help: Link from usage requirement commands to detailed explanationHinell2022-09-161-5/+9
| | | | | | | | | | | | | | Augment vague mentions of "Transitive Usage Requirements" with links to a detailed explanation. Fixes: #23799
* | Tutorial: Align step 12 prose with documentationMarkus Ferrell2022-09-051-2/+2
|/ | | | Fixes: #23918
* Help: Fix minor typos in guidestocic2022-09-042-2/+2
|
* Tutorial: Update step 3 styleMarkus Ferrell2022-08-314-29/+128
|
* Tutorial: Update step 2 styleMarkus Ferrell2022-08-296-76/+433
|
* Tutorial: Collapse step 1 solutionsMarkus Ferrell2022-08-151-0/+87
|
* Tutorial: Add Step 1 background info and update styleMarkus Ferrell2022-08-154-104/+313
|
* Merge topic 'tutorial_genExp_rearrange'Brad King2022-08-1041-312/+223
|\ | | | | | | | | | | | | | | ccba87b05b Tutorial: Move step 10 to step 4 Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !7506
| * Tutorial: Move step 10 to step 4Markus Ferrell2022-08-0841-312/+223
| | | | | | | | Shifts steps 4-9 to 5-10.
* | Help: Replace a bunch of more ``--option`` to `:option:` roleAlex Turbov2022-08-043-45/+51
| |
* | Help: Replace mentions of ``-T`` and ``-A`` options with roleAlex Turbov2022-08-041-6/+7
| |
* | Help: Replace mentions of ``-G`` option with :option:`-G` roleAlex Turbov2022-08-041-3/+3
| |
* | Help: Replace mentions of ``-C`` option with :option:`-C` roleAlex Turbov2022-08-043-7/+6
|/
* Merge topic 'doc-find_package-BYPASS_PROVIDER'Brad King2022-07-251-1/+1
|\ | | | | | | | | | | | | | | 4f7a0c25d2 Help: Document BYPASS_PROVIDER keyword for find_package() 76370e06b8 Help: Minor grammar fix for the Using Dependencies manual Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !7501
| * Help: Minor grammar fix for the Using Dependencies manualCraig Scott2022-07-231-1/+1
| |
* | Merge topic 'tutorial_cdash_rearrange'Brad King2022-07-2218-121/+81
|\ \ | | | | | | | | | | | | | | | | | | 6c77ccec51 Tutorial: Move step 8 to step 5. Shift steps 5-7 to 6-8. Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !7480
| * | Tutorial: Move step 8 to step 5. Shift steps 5-7 to 6-8.Markus Ferrell2022-07-1918-121/+81
| |/
* | Tutorial: Add reference links for step 1 commandsMarkus Ferrell2022-07-191-7/+19
|/
* 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
generated by cgit v0.12 at 2025-01-05 22:50:33 (GMT)