Joseph Snyder
5a86ce5428
Tutorial: Step 4 improvements
...
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
2021-10-07 11:53:51 -04:00
Joseph Snyder
5632933304
Tutorial: Add version update instructions to Step 10
...
Add instructions to update the cmake_minimum_required version to 3.15
just before the usage of COMPILE_LANG_AND_ID
Issue: #22663
2021-10-05 09:22:33 -04:00
Brad King
6fbd94cf5b
Merge topic 'tutorial_update_step_11'
...
6dade88d1c1bf25b5b5fkwrobot@kitware.com >
Merge-request: !6575
2021-10-05 09:04:37 -04:00
Brad King
f3a6d295e8
Merge topic 'tutorial-regex'
...
0f17b37b96kwrobot@kitware.com >
Merge-request: !6572
2021-10-04 10:31:57 -04:00
Brad King
162413664f
Merge topic 'tutorial-step1'
...
14600a42c8kwrobot@kitware.com >
Merge-request: !6576
2021-10-04 10:29:00 -04:00
Joseph Snyder
6dade88d1c
Tutorial: Add documentation on Package helper functions
...
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
2021-09-30 14:43:28 -04:00
Joseph Snyder
1bf25b5b5f
Tutorial: Remove information about EXPORT keyword
...
Remove the text that implies that the EXPORT keyword will also install
the generated CMake file.
2021-09-30 13:06:20 -04:00
Betsy McPhail
01c332c9c7
Tutorial: Clarify instructions in Step 5
2021-09-30 12:18:41 -04:00
Betsy McPhail
14600a42c8
Tutorial: Update Step 1 instructions
...
To demonstrate how simple a CMake project can be, move the `Build and Run`
section earlier in the step.
2021-09-30 12:04:52 -04:00
Christophe Bernard
0f17b37b96
Tutorial: Fix regexps in sample CMakeLists.txt files
...
Replace original regexp `[-nan|nan|0]` with `(-nan|nan|0)`
which is what the author most likely intended to write in the
first place.
2021-09-30 08:55:41 -04:00
Brad King
09dd52c9d2
Merge topic 'tutorial_update_step_8'
...
f55a02a26ekwrobot@kitware.com >
Merge-request: !6565
2021-09-28 09:56:14 -04:00
Joseph Snyder
f55a02a26e
Tutorial: Enhance CTestConfig info in Step 8
...
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
2021-09-27 10:11:17 -04:00
Joseph Snyder
68e0f72744
Tutorial: Describe placement of add_subdirectory
...
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
2021-09-24 08:59:23 -04:00
Brad King
73898c4922
Tutorial: Make code snippets linkable
...
Extend the change from commit 9e5bbb69ea
2021-06-18 12:31:45 -04:00
Brad King
9c703ff741
Tutorial: Add infrastructure to preserve old links when renaming steps
2021-06-17 12:10:14 -04:00
Josef Angstenberger
9e5bbb69ea
Tutorial: Add captions for code blocks
2021-06-17 11:57:56 -04:00
Josef Angstenberger
fe60154fe8
Tutorial: Small formatting improvements
...
- Use inline literals for all code fragments and names.
- Add missing console code-blocks.
- Always use c++, not c as code language.
2021-06-17 11:57:56 -04:00
Josef Angstenberger
25dde20cc5
Tutorial: Fix links after splitting steps
2021-06-17 11:55:18 -04:00
Josef Angstenberger
d1c3e7e78a
Tutorial: Split steps into separate files
...
Fixes : #21737
2021-06-17 11:53:55 -04:00
Brad King
13fdb26323
Tutorial: Break up intro paragraph
2021-06-17 10:33:07 -04:00
Josef Angstenberger
7072d83772
Help: Fix typos and spelling in documentation
2021-05-07 17:00:17 +02:00
Brad King
d31b6657a6
Merge topic 'doc-preset-schema-relative'
...
75dadc4558kwrobot@kitware.com >
Acked-by: Kyle Edwards <kyle.edwards@kitware.com >
Merge-request: !6083
2021-05-04 11:15:21 -04:00
Brad King
75dadc4558
Help: Use relative path for IDE Integration guide link to preset schema
...
This allows the integration guide to build as part of a larger set of
documentation.
2021-05-03 15:36:45 -04:00
Alexander Pivovarov
dfb47335da
Tutorial: Step12 install MathFunctionsConfigVersion.cmake
2021-04-20 13:43:13 -07:00
Ben Boeckel
26cf661b64
Help/guide: use GNUInstallDirs in importing-exporting example
...
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.
2021-03-19 14:23:26 -04:00
Ben Boeckel
74c2ade187
Help/guide: fix the remaining CMake install destinations
...
Followup from !5674 .
2021-03-01 11:05:14 -05:00
Tim Hutton
c16509907c
Help: Update to VS ClangCL toolset in user-interaction example
...
As of VS 2019 the toolset is now called `ClangCL`. The toolset `LLVM`
is no longer supported.
Issue: #20415
2021-02-01 10:21:03 -05:00
Betsy McPhail
174b1e5da5
Tutorial: Remove incorrect instructions from Step 5
...
The first section of Step 5 is not tested, incorrect, and not the
recommended solution.
Fixes : #21539
2021-01-14 13:05:09 -05:00
Ben Boeckel
e58a76de51
Help/guide: fix importing-exporting CMake install destinations
2021-01-07 12:19:57 -05:00
fazl
b42a63605c
Tutorial: Fix minor typo in index.rst
...
s/mqsqrt.h/mysqrt.h/
2021-01-04 12:02:09 -05:00
Kyle Edwards
cf6ac2d365
Merge branch 'master' into cmakepresets-schema
2020-10-20 14:51:42 -04:00
Ben McMorran
0307f7c980
Help: Add JSON schema for CMakePresets.json
2020-10-20 12:07:09 -04:00
Kyle Edwards
54a5c026d0
Merge topic 'cmake-presets-doc-move'
...
4a123fc28c6c74bcfc2045766789a088c9d6f6ebefab8560082208db114cd30f85193fb9c8c57860kwrobot@kitware.com >
Merge-request: !5373
2020-10-20 11:59:54 -04:00
Kyle Edwards
c436aaaad1
Help: Move CMakePresets.json documentation into a separate file
2020-10-19 10:25:57 -04:00
Brad King
9952ee063a
server: remove deprecated 'cmake -E server' mode
...
The server mode has been deprecated since commit 996e1885c4
2020-10-14 16:41:50 -04:00
Brad King
2e53641d76
Merge topic 'user-interaction-presets'
...
4bdc1c0a2ckwrobot@kitware.com >
Merge-request: !5340
2020-10-07 07:48:24 -04:00
Kyle Edwards
4bdc1c0a2c
Help: Update user interaction guide with presets info
2020-10-06 16:11:50 -04:00
Kyle Edwards
6e10518cbc
Help: Add IDE integration guide
2020-10-06 11:54:12 -04:00
Brad King
59d84ab9f3
Merge topic 'update-guides'
...
9b988d9e57kwrobot@kitware.com >
Merge-request: !5280
2020-09-29 05:38:55 -04:00
Betsy McPhail
9b988d9e57
Help: Cleanup guides
...
* 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
2020-09-25 15:29:05 -04:00
Betsy McPhail
0aea38d25e
Help: Change User Interaction image paths to be relative to source file
2020-09-25 14:45:01 -04:00
Betsy McPhail
3310801aab
Help: Add Importing and Exporting Guide
2020-09-11 08:50:52 -04:00
Brad King
9d9a6a8532
Merge topic 'tutorial-update'
...
63af35019akwrobot@kitware.com >
Merge-request: !5046
2020-07-23 11:08:38 -04:00
Betsy McPhail
63af35019a
Tutorial: Add missing language option to literalinclude
2020-07-22 16:17:41 -04:00
Jean-Christophe Fillion-Robin
207373802e
Fix typos identified using codespell
...
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,\
"
```
2020-07-22 12:44:47 -04:00
Betsy McPhail
8a80b8fbe4
Tutorial: Clarify Steps 1, 2 and 3
2020-07-17 12:17:26 -04:00
Brad King
3252bc4476
Merge topic 'tutorial_install_when_built_static'
...
0fdfd6bf37kwrobot@kitware.com >
Merge-request: !4906
2020-06-18 09:41:31 -04:00
Robert Maynard
7c3204fc7d
Tutorial: Correct Step9 wording
...
on some platforms -fPIC is implicit so you won't get an error
2020-06-16 15:43:32 -04:00
Robert Maynard
0fdfd6bf37
Tutorial: Install correctly when built statically
...
When built statically we failed to install the SqrtLibrary
2020-06-16 15:38:57 -04:00
Ben Boeckel
e4f398e0af
Help: add alt text to embedded images
2020-05-07 13:25:57 -04:00
