summaryrefslogtreecommitdiffstats
path: root/Help/guide
Commit message (Collapse)AuthorAgeFilesLines
* 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_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
| |/ |/|
* | Help: Move CMakePresets.json documentation into a separate fileKyle Edwards2020-10-191-1/+1
|/
* Merge topic 'user-interaction-presets'Brad King2020-10-071-0/+76
|\ | | | | | | | | | | | | 4bdc1c0a2c Help: Update user interaction guide with presets info Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5340
| * Help: Update user interaction guide with presets infoKyle Edwards2020-10-061-0/+76
| |
* | Help: Add IDE integration guideKyle Edwards2020-10-061-0/+123
|/
* Merge topic 'update-guides'Brad King2020-09-293-4/+10
|\ | | | | | | | | | | | | 9b988d9e57 Help: Cleanup guides Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5280
| * Help: Cleanup guidesBetsy McPhail2020-09-253-4/+10
| | | | | | | | | | | | * Move sections to be same level as Introduction in "Using Dependecies" * Rename "Importing Exporting Targets" to "Importing Exporting Guide" * Add an Introduction header to the Tutorial and Importing Exporting Guide
* | Help: Change User Interaction image paths to be relative to source fileBetsy McPhail2020-09-252-5/+5
|/
* Help: Add Importing and Exporting GuideBetsy McPhail2020-09-1122-0/+1141
|
* Merge topic 'tutorial-update'Brad King2020-07-231-0/+1
|\ | | | | | | | | | | | | 63af35019a Tutorial: Add missing `language` option to literalinclude Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5046
| * Tutorial: Add missing `language` option to literalincludeBetsy McPhail2020-07-221-0/+1
| |
* | Fix typos identified using codespellJean-Christophe Fillion-Robin2020-07-221-1/+1
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | See https://github.com/codespell-project/codespell#readme The following command was used: ``` codespell -q6 --skip="\ .git,\ *.json,\ ./Copyright.txt,\ ./Help/command/foreach.rst,\ ./Help/prop_test/REQUIRED_FILES.rst,\ ./Help/variable/CTEST_COVERAGE_COMMAND.rst,\ ./Modules/CMakeCheckCompilerFlagCommonPatterns.cmake,\ ./Modules/CMakeRCInformation.cmake,\ ./Modules/Internal/CPack/NSIS.template.in,\ ./Modules/FindMatlab.cmake,\ ./Modules/MatlabTestsRedirect.cmake,\ ./Modules/Platform/Windows-Clang.cmake,\ ./Modules/Platform/Windows-Intel-Fortran.cmake,\ ./Modules/Platform/Windows-MSVC.cmake,\ ./Source/CMakeVersion.cmake,\ ./Source/cmConvertMSBuildXMLToJSON.py,\ ./Source/cmCreateTestSourceList.cxx,\ ./Source/cmGlobalVisualStudio10Generator.cxx,\ ./Source/cmExportBuildFileGenerator.cxx,\ ./Source/cmExportInstallAndroidMKGenerator.cxx,\ ./Source/cmExportInstallFileGenerator.cxx,\ ./Source/cmExportSet.cxx,\ ./Source/cmExportTryCompileFileGenerator.cxx,\ ./Source/cmFindPackageCommand.cxx,\ ./Source/cmInstallCommand.cxx,\ ./Source/cmGeneratorExpressionLexer.cxx,\ ./Source/cmLocalVisualStudio7Generator.cxx,\ ./Source/cmOrderDirectories.cxx,\ ./Source/cmTarget.cxx,\ ./Source/kwsys/*,\ ./Source/QtDialog/CMakeSetupDialog.ui,\ ./Source/CPack/WiX/cmWIXRichTextFormatWriter.cxx,\ ./Source/CTest/cmParseCoberturaCoverage.h,\ ./Tests/CMakeTests/ImplicitLinkInfoTest.cmake.in,\ ./Tests/RunCMake/CPack/tests/DMG_SLA/English.license.rtf,\ ./Tests/RunCMake/CPack/tests/DMG_SLA/German.license.txt,\ ./Tests/RunCMake/CPack/tests/DMG_SLA/German.menu.txt,\ ./Tests/RunCMake/GoogleTest/xml_output.cpp,\ ./Tests/RunCMake/Make/TargetMessages*,\ ./Utilities/*,\ " \ -L "\ dependees,\ endwhile,\ fo,\ filetest,\ helpfull,\ nd,\ objext,\ stoll,\ supercedes,\ superceded,\ vas,\ varn,\ " ```
* Tutorial: Clarify Steps 1, 2 and 3Betsy McPhail2020-07-171-23/+55
|
* Merge topic 'tutorial_install_when_built_static'Brad King2020-06-185-7/+23
|\ | | | | | | | | | | | | 0fdfd6bf37 Tutorial: Install correctly when built statically Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !4906
| * Tutorial: Install correctly when built staticallyRobert Maynard2020-06-165-7/+23
| | | | | | | | When built statically we failed to install the SqrtLibrary
* | Tutorial: Correct Step9 wordingRobert Maynard2020-06-161-1/+1
|/ | | | on some platforms -fPIC is implicit so you won't get an error
* Help: add alt text to embedded imagesBen Boeckel2020-05-071-0/+5
|
* Tutorial: Restore MakeTable.cxx in step 6Brad King2020-04-271-0/+25
| | | | | | | | | | | In commit c754a3d4b7 (Tutorial: Remove MakeTable.cxx from Steps 5 and 6, 2020-04-23) it was incorrect to remove the file from step 6. The instructions for that step show the addition of a reference to it from the `CMakeLists.txt` file. Each step shows the addition of content to lead to the next step, so removing the file from step 6 was an off-by-one error. Issue: #20618
* Merge topic 'tutorial-remove-maketable'Brad King2020-04-242-50/+0
|\ | | | | | | | | | | | | c754a3d4b7 Tutorial: Remove MakeTable.cxx from Steps 5 and 6 Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !4658
| * Tutorial: Remove MakeTable.cxx from Steps 5 and 6Betsy McPhail2020-04-232-50/+0
| | | | | | | | | | | | | | This file is not referenced until Step 6 and, therefore, should be added to the source code at Step 7. Fixes: #20618
* | Tutorial: Clarify Step 5Betsy McPhail2020-04-231-2/+6
|/ | | | Fixes: #20619
* Tutorial: Update Step 5 to work on WindowsBetsy McPhail2020-02-272-2/+12
| | | | | | | `log` and `exp` should be found on Windows systems now, as expected. Update tests to be more specific in looking for the expected outcome of the tutorial.
* Help: Replace UTF-8 apostrophe with ascii apostropheBrad King2020-02-121-3/+3
| | | | | | Also replace UTF-8 graphical characters with simple dashes. Fixes: #20349
* Tutorial: Clarify Step 5Betsy McPhail2020-01-161-4/+10
|
* Merge topic 'tutorial'Brad King2020-01-1421-252/+239
|\ | | | | | | | | | | | | | | | | | | a7d25358a0 Tutorial: Add the PRIVATE keyword to target_link_libraries command cf2afb1065 Tutorial: Remove 'Consumer' example 77b515f3eb Tutorial: Improve "MultiPackage" example 3a510a47b0 Tutorial: Add links to relevant CMake documentation Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !4113
generated by cgit v0.12 at 2025-02-01 13:58:30 (GMT)