summaryrefslogtreecommitdiffstats
path: root/Help/guide/tutorial
Commit message (Collapse)AuthorAgeFilesLines
* Tutorial: Provide MSVC example to build Vendor libraryTyler Yankee2025-12-111-3/+15
| | | | | | Allow Windows users who aren't familiar with MSVC-equivalent commands to GCC and/or don't have the GNU toolchain installed (via MinGW, etc.) to practice this example.
* Tutorial: Fix path to file in exercise solutionTyler Yankee2025-12-091-1/+1
|
* Tutorial: Add Step 0 to prepare the working environmentVito Gamberini2025-10-294-0/+266
| | | | | | Adds a "Step 0" to the tutorial which discusses minutia about where to get CMake, how to run it, and most importantly deals at length with various generator issues which aren't covered elsewhere.
* Merge topic 'doc-cmake.org-tutorial-archive' into release-4.2Brad King2025-10-292-2/+6
|\ | | | | | | | | | | | | 5473a45fd8 Tutorial: Restore source archive when published on cmake.org Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !11370
| * Tutorial: Restore source archive when published on cmake.orgBrad King2025-10-292-2/+6
| | | | | | | | | | | | | | | | | | Restore commit 4cb616fed6 (Tutorial: Provide a source archive when published on cmake.org, 2022-04-27, v3.23.2~22^2). Its effects were accidentally reverted by commit 9784834b4c (Help: Use `*.rst` extension for included files, 2025-04-07, v4.1.0-rc1~354^2). Reported-by: Vito Gamberini <vito.gamberini@kitware.com>
* | Tutorial: Update IPO example in Step 6Vito Gamberini2025-10-167-7/+15
| |
* | Tutorial: Fix typos and mislabeled code blocksVito Gamberini2025-10-034-4/+4
| |
* | Tutorial: Fix example FILE_SET namesVito Gamberini2025-10-022-9/+9
| | | | | | | | | | | | FILE_SET names begin with lowercase letters, the examples use uppercase Fixes #27282
* | Tutorial: text not correctly renderedAdrien Ollier2025-09-261-1/+1
| | | | | | | | | | | | There are some restrictions on backquotes markup. One of them is it must be separated from surrounding text by non-word characters.
* | Tutorial: Add redirect pages for removed stepsVito Gamberini2025-09-1713-0/+133
| |
* | Tutorial: Rewrite using conventions enabled by CMake 3.23Vito Gamberini2025-09-17353-4839/+10082
|/ | | | | | | | This is a full re-write of the CMake Tutorial for CMake 3.23, both the functionality it provides, as well as the modern workflows that developers use when interfacing with CMake. Issue: #22663, #23086, #23799, #26053, #26105, #26153, #26914
* Check{,C,CXX,OBJC,OBJCXX,Fortran}SourceCompiles: Update documentationPeter Kokot2025-05-261-1/+1
| | | | | | | | | | | | | | | | | Changes: - Added intro code blocks showing how to include these modules. - Added examples sections. - Used "command" instead of "macro". - Commands sections added to have a clearer overview of the modules at first encounter. - Reworded commands arguments a bit. - Added a rubric title for variables that affect the checks. - CheckFortranSourceCompiles: Added CMake version when SRC_EXT option was introduced. - Listed CMAKE_TRY_COMPILE_TARGET_TYPE variable in the rubric together with CMAKE_REQUIRED_* variables and added an include RST file for it. - Used lowercase style for check_fortran_source_compiles().
* Merge topic 'doc-tutorial-typo'Brad King2025-04-281-1/+1
|\ | | | | | | | | | | | | e07effe49c Help: Fix wording in tutorial workflow description Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !10716
| * Help: Fix wording in tutorial workflow descriptionBrad King2025-04-251-1/+1
| |
* | Help: Use `*.rst` extension for included filesAlex Turbov2025-04-132-6/+2
| | | | | | | | So, editor(s) can correctly highlight the RST syntax in the included files.
* | Tutorial: Cleanup CTestConfig.cmakeDaniel Pfeifer2025-04-079-42/+8
|/ | | | | | * Remove `CTEST_PROJECT_NAME`, as it is no longer used. * Set `CTEST_SUBMIT_URL` instead of `CTEST_DROP_*`. * Remove `CTEST_SUBMIT_URL`, as it is not used.
* Help: Remove stray spaces and one colonNikita Nemkin2025-01-311-1/+1
|
* Help: Fix typos found by the `rst-backticks` hookAlex Turbov2025-01-262-2/+2
| | | | | | | The corresponding `pre-commit` configuration is coming in the separate MR. Signed-off-by: Alex Turbov <i.zaufi@gmail.com>
* Revise C++ coding style using clang-format with "east const"Kitware Robot2025-01-2320-33/+33
| | | | | | | | | | | | | | | Run the `clang-format.bash` script to update all our C and C++ code to a new style defined by `.clang-format`, now with "east const" enforcement. Use `clang-format` version 18. * If you reached this commit for a line in `git blame`, re-run the blame operation starting at the parent of this commit to see older history for the content. * See the parent commit for instructions to rebase a change across this style transition commit. Issue: #26123
* Tutorial: Add missing entry in Step 1 list of files to editNirav Nirmal2025-01-081-0/+1
| | | | Exercise 3 requires editing `TutorialConfig.h.in`.
* Tutorial: Restore TODO 4 comment in step 7Brice Decaestecker2024-11-271-0/+1
| | | | | | | Restore a comment added by commit f9ef15f3dc (Tutorial: Update step 7 style, 2022-10-07, v3.26.0-rc1~482^2) that was accidentally removed by commit 8ddf32196c (Tutorial: Refactor MathFunctions code, 2023-02-10, v3.27.0-rc1~441^2).
* Tutorial: Fix grammar typo in Step 11FrankYin2024-05-171-1/+1
| | | | Fix and improve wording in the "Adding Export Configuration" step.
* Tutorial: Set CPACK_GENERATOR in Step 9betsy.mcphail2024-05-095-4/+11
| | | | In addition to CPACK_SOURCE_GENERATOR also set CPACK_GENERATOR.
* Merge topic 'fix-tutorial'Brad King2024-01-083-6/+6
|\ | | | | | | | | | | | | | | | | | | 6d48bd21ac Tutorial: Clarify the expected change to target_include_directories 4d56db038d Tutorial: Make `INSTALL_DESTINATION` consistent with installed destination da22b269b2 Tutorial: Add missing `$` in generator expression Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !9120
| * Tutorial: Clarify the expected change to target_include_directoriesKevin Albertson2024-01-051-4/+4
| | | | | | | | | | The expectation is to modify the existing `target_include_directories`, not add add a new `target_include_directories` command.
| * Tutorial: Make `INSTALL_DESTINATION` consistent with installed destinationKevin Albertson2024-01-051-1/+1
| |
| * Tutorial: Add missing `$` in generator expressionKevin Albertson2024-01-051-1/+1
| |
* | Help: Fix Step3 Mathfunction exampleBhavith C2023-12-231-2/+2
|/ | | | | | | - TODO 6 has to be Link SqrtLibrary - TODO 7 has to be Link MathFunctions Signed-off-by: Bhavith C <bhavithc.acharya@gmail.com>
* Tutorial: Fix-up typos and inconsistenciesbetsy.mcphail2023-09-0713-17/+36
| | | | | | | * Fix typo in Step 2 * Fix incorrect code referenced in Step 3, TODO 7. Update comments in MathFunctions/CMakeLists.txt to unique strings. * Resolve inconsistencies between steps in MathFunctions/CMakeLists.txt
* Tutorial: Clarify instructions for multi-config generators in Step 1betsy.mcphail2023-08-171-1/+13
|
* Tutorial: Refactor Step 10Chris Mahoney2023-07-171-1/+12
|
* Tutorial: Clarify Step 4 TODO 4Chris Mahoney2023-07-171-2/+2
|
* Tutorial: Clarify Step 3Chris Mahoney2023-07-171-20/+3
|
* Tutorial: Fix Step 1 TODO 1 to be expandableChris Mahoney2023-06-221-1/+1
|
* Tutorial: Extend literal include to contain full code changes in solutionMarkus Ferrell2023-06-151-1/+1
| | | | | The solution for step 7 todo 5 did not include all of the code changes. Modify it to include the needed `#endif` code change.
* Tutorial: Move Step4-Ex1 to Step3-Ex2Paul Choisel2023-04-287-200/+225
| | | | | During the training, we talk about INTERFACE libraries just before Step3 so it makes more sense to do the exercise related to them in Step3
* Tutorial: Refactor MakeTable commands into MakeTable.cmakeMarkus Ferrell2023-03-0721-114/+272
|
* 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.
* 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 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.
generated by cgit v0.12 at 2026-01-23 02:07:38 (GMT)