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
Brad King
dd62ee376e
Tutorial: Restore MakeTable.cxx in step 6
...
In commit c754a3d4b7#20618
2020-04-27 08:30:10 -04:00
Brad King
2844ef87c6
Merge topic 'tutorial-remove-maketable'
...
c754a3d4b7kwrobot@kitware.com >
Merge-request: !4658
2020-04-24 08:33:05 -04:00
Betsy McPhail
c754a3d4b7
Tutorial: Remove MakeTable.cxx from Steps 5 and 6
...
This file is not referenced until Step 6 and, therefore, should be added to
the source code at Step 7.
Fixes : #20618
2020-04-23 11:57:34 -04:00
Betsy McPhail
d0797f62d9
Tutorial: Clarify Step 5
...
Fixes : #20619
2020-04-23 11:47:20 -04:00
Betsy McPhail
07223c5c27
Tutorial: Update Step 5 to work on Windows
...
`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.
2020-02-27 14:58:24 -05:00
Brad King
c5d7c29137
Help: Replace UTF-8 apostrophe with ascii apostrophe
...
Also replace UTF-8 graphical characters with simple dashes.
Fixes : #20349
2020-02-12 14:37:41 -05:00
Betsy McPhail
fc2d1b1347
Tutorial: Clarify Step 5
2020-01-16 15:54:01 -05:00
Brad King
710371ca2f
Merge topic 'tutorial'
...
a7d25358a0cf2afb106577b515f3eb3a510a47b0kwrobot@kitware.com >
Merge-request: !4113
2020-01-14 09:06:40 -05:00
Stephen Kelly
bd681fee7a
Help: Add guides for user interaction
...
Add some prose to the documentation index page to guide readers to the
major manuals and guides.
Add a new "User Interaction Guide" to help the class of new user
who wishes to build a project with CMake for the first time, such as
after cloning a repo from a git repository.
Add a new "Using Dependencies Guide" to help the class of new
user who wishes to consume a SDK provided by a third party and needs a
starting point. This is a different type of user to the user who wishes
to create their own project from scratch (addressed by the
`cmake-buildsystem(7)` manual) as each will encounter needs for
information discovery in a different order.
2020-01-13 11:04:55 -05:00
Betsy McPhail
a7d25358a0
Tutorial: Add the PRIVATE keyword to target_link_libraries command
2020-01-10 11:38:00 -05:00
Betsy McPhail
cf2afb1065
Tutorial: Remove 'Consumer' example
...
This example was incomplete and did not follow the format of the tutorial.
2020-01-10 11:38:00 -05:00
Betsy McPhail
77b515f3eb
Tutorial: Improve "MultiPackage" example
...
Rename to Step 12 and ensure that it follows Step 11
2020-01-10 11:37:54 -05:00
Betsy McPhail
3a510a47b0
Tutorial: Add links to relevant CMake documentation
...
Add links for commands, properties and variables.
2020-01-09 14:49:28 -05:00
