summaryrefslogtreecommitdiffstats
path: root/Help/guide
Commit message (Collapse)AuthorAgeFilesLines
* Merge topic 'tutorial_refactor_cmake_scripts'Brad King2023-03-0921-114/+272
|\ | | | | | | | | | | | | | | e1f2b35723 Tutorial: Refactor MakeTable commands into MakeTable.cmake Acked-by: Kitware Robot <kwrobot@kitware.com> Tested-by: buildbot <buildbot@kitware.com> Merge-request: !8249
| * Tutorial: Refactor MakeTable commands into MakeTable.cmakeMarkus Ferrell2023-03-0721-114/+272
| |
* | Help: Replace link with its permanent redirectBrad King2023-02-271-1/+1
|/
* Tutorial: Refactor MathFunctions codeMarkus Ferrell2023-02-2381-516/+645
| | | | | | | Propagate the refactor in Step 10 MathFunctions through all of the steps. Use MathFunctions/MathFunctions.cxx instead of Tutorial.cxx to determine which sqrt library is called. Adds .h files which correspond to their .cxx files by name.
* FetchContent: Bump documented example Catch2 to v3.0.1Eisuke Kawashima2023-02-071-1/+1
| | | | | | The previous Catch2 v2.13.4 does not compile on some platforms [1]. [1] https://github.com/catchorg/Catch2/issues/2326
* Tutorial: Fix typos in Step 11 exercise and solutionJoshua Perrett2023-01-182-5/+5
|
* Tutorial: Fix exercise in Step 10 to match solution provided in Step 11Joshua Perrett2023-01-181-1/+1
| | | | | The solution in Step 11 sets POSITION_INDEPENDENT_CODE to `${BUILD_SHARED_LIBS}`, rather than simply to "True" in all cases.
* Tutorial: Fix destination of link from Step 6 to Step 5Joshua Perrett2023-01-181-2/+2
| | | | | The link in Step 6 (to "Testing Support") clearly refers to Exercise 2. Fix the location to which the link jumps.
* Tutorial: Fix exercise in Step 5 to match solution provided in Step 6Joshua Perrett2023-01-181-1/+1
| | | | | If you look at the solution for Step 6, you will see `0.0001` rather than `0.00001` used for the last test case. Fix the typo.
* Tutorial: Fix typo in step 5 todo statementMarkus Ferrell2023-01-111-1/+1
|
* 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
generated by cgit v0.12 at 2025-02-15 01:07:25 (GMT)