mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-04 12:49:36 -06:00
Code Issues Packages Projects Releases Wiki Activity
51,917 Commits 2 Branches 385 Tags
fc762735196dbbc983dfac2145cd7afd7892bf54
Commit Graph

59 Commits

Author SHA1 Message Date
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' 
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
 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 (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.
 2020-10-14 16:41:50 -04:00
Brad King
2e53641d76 Merge topic 'user-interaction-presets' 
4bdc1c0a2c Help: Update user interaction guide with presets info

Acked-by: Kitware Robot <kwrobot@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' 
9b988d9e57 Help: Cleanup guides

Acked-by: Kitware Robot <kwrobot@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' 
63af35019a Tutorial: Add missing `language` option to literalinclude

Acked-by: Kitware Robot <kwrobot@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' 
0fdfd6bf37 Tutorial: Install correctly when built statically

Acked-by: Kitware Robot <kwrobot@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 (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
 2020-04-27 08:30:10 -04:00
Brad King
2844ef87c6 Merge topic 'tutorial-remove-maketable' 
c754a3d4b7 Tutorial: Remove MakeTable.cxx from Steps 5 and 6

Acked-by: Kitware Robot <kwrobot@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' 
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
 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
Arkadiusz Drabczyk
02aa03eb0a Tutorial: replace Unicode EN DASH with ASCII dash 
Unicode EN DASH is problematic:

- it cannot be easily found in web browsers, editors etc.
- it doesn't work when copied and run in the terminal
 2019-11-18 06:51:58 +11:00
Craig Scott
9682adb6ad Tutorial: clean up typos, grammar and formatting 2019-11-04 12:44:34 +11:00
Kitware Robot
ed98209ddc Revise include order using clang-format-6.0 
Run the `clang-format.bash` script to update our C and C++ code to a new
include order `.clang-format`.  Use `clang-format` version 6.0.
 2019-10-01 12:26:36 -04:00
Betsy McPhail
6f6a32a0f6 Tutorial: Improve Step 9 
* Move USE_MYMATH from configured header to target_compile_definitions
 2019-08-19 11:49:05 -04:00
Betsy McPhail
6a35d630dc Tutorial: Improve Step 8 
* Remove comments from CTestConfig.cmake
* Update directions
 2019-08-19 11:49:05 -04:00
Betsy McPhail
61d4d990d6 Tutorial: Improve Step 7 
* Update directions
 2019-08-19 11:49:05 -04:00
Betsy McPhail
a36731c634 Tutorial: Improve Step 6 
* Print message when using the table
* Remove duplicated comment
* Remove HAVE_LOG and HAVE_EXP checks, use generated table instead
 2019-08-19 11:49:05 -04:00
Betsy McPhail
df9cdf629c Tutorial: Improve Step 5 
* Updated output message
* Use 'target_compile_definitions' for HAVE_LOG and HAVE_EXP

Previously, the change from using TutorialConfig.h to
target_compile_definitions happened without explanation as part of Step 8.
 2019-08-19 11:49:05 -04:00
Betsy McPhail
442c0f0d46 Tutorial: Improve Step 4 
* Clarify directions
 2019-08-19 11:49:05 -04:00
Betsy McPhail
bc64401c3d Tutorial: Improve Step 3 
* Move `option(USE_MYMATH...` to the same location in all CMakeLists files
 2019-08-19 11:49:05 -04:00
Betsy McPhail
49ce4d6ff4 Tutorial: Improve Step 2 
* Fix typo in #include
* Remove CMakeLists file that users should create
* Clarify which files users are expected to create
* Highlight the importance of configuring TutorialConfig.h.in after
  the MY_MATH option has been set
 2019-08-19 11:49:05 -04:00
Betsy McPhail
82332f81bb Tutorial: Improve Step 1 
* Update minimum required version to 3.10
* Use VERSION argument to project command rather than separate variables
* Replace `endif(USE_MYMATH)` with  more modern `endif()`
* Simplify the call to 'configure_file()'
* Add comments to tutorial.cxx to use as anchors in documentation
* Remove CMakeLists and TutorialConfig.h.in files that users should
  create. Consequently, remove Step1 from CMake tests.
 2019-08-19 11:48:58 -04:00
Brad King
b15dbdfce8 Merge topic 'multipackage_tutorial_compiles' 
98164b707f Tutorial: MultiPackage now correctly compiles

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !3594
 2019-07-30 11:37:36 -04:00