summaryrefslogtreecommitdiffstats
path: root/Help/guide/tutorial
Commit message (Collapse)AuthorAgeFilesLines
* 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.
* | 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`
* Tutorial: Update step 5 styleMarkus Ferrell2022-10-0616-61/+317
|
* 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-041-1/+1
|
* 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-041-1/+1
| |
* | Help: Replace mentions of ``-C`` option with :option:`-C` roleAlex Turbov2022-08-041-2/+2
|/
* 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
|/
* 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`.
* 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.
generated by cgit v0.12 at 2025-03-05 20:04:00 (GMT)