summaryrefslogtreecommitdiffstats
path: root/Help/guide
Commit message (Collapse)AuthorAgeFilesLines
* 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
| * Tutorial: Add the PRIVATE keyword to target_link_libraries commandBetsy McPhail2020-01-103-3/+3
| |
| * Tutorial: Remove 'Consumer' exampleBetsy McPhail2020-01-103-76/+0
| | | | | | | | This example was incomplete and did not follow the format of the tutorial.
| * Tutorial: Improve "MultiPackage" exampleBetsy McPhail2020-01-1016-48/+92
| | | | | | | | Rename to Step 12 and ensure that it follows Step 11
| * Tutorial: Add links to relevant CMake documentationBetsy McPhail2020-01-091-126/+145
| | | | | | | | Add links for commands, properties and variables.
* | Help: Add guides for user interactionStephen Kelly2020-01-136-0/+886
|/ | | | | | | | | | | | | | | | 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.
* Tutorial: replace Unicode EN DASH with ASCII dashArkadiusz Drabczyk2019-11-171-2/+2
| | | | | | | 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
* Tutorial: clean up typos, grammar and formattingCraig Scott2019-11-041-63/+66
|
* Revise include order using clang-format-6.0Kitware Robot2019-10-0116-12/+27
| | | | | 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.
* Tutorial: Improve Step 9Betsy McPhail2019-08-1911-20/+22
| | | | * Move USE_MYMATH from configured header to target_compile_definitions
* Tutorial: Improve Step 8Betsy McPhail2019-08-197-20/+36
| | | | | * Remove comments from CTestConfig.cmake * Update directions
* Tutorial: Improve Step 7Betsy McPhail2019-08-192-8/+17
| | | | * Update directions
* Tutorial: Improve Step 6Betsy McPhail2019-08-1915-145/+35
| | | | | | * Print message when using the table * Remove duplicated comment * Remove HAVE_LOG and HAVE_EXP checks, use generated table instead
* Tutorial: Improve Step 5Betsy McPhail2019-08-1923-98/+126
| | | | | | | | * 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.
* Tutorial: Improve Step 4Betsy McPhail2019-08-191-14/+22
| | | | * Clarify directions
* Tutorial: Improve Step 3Betsy McPhail2019-08-195-18/+31
| | | | * Move `option(USE_MYMATH...` to the same location in all CMakeLists files
* Tutorial: Improve Step 2Betsy McPhail2019-08-1918-50/+48
| | | | | | | | * 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
* Tutorial: Improve Step 1Betsy McPhail2019-08-1929-204/+194
| | | | | | | | | | * 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.
* Merge topic 'multipackage_tutorial_compiles'Brad King2019-07-302-6/+13
|\ | | | | | | | | | | | | 98164b707f Tutorial: MultiPackage now correctly compiles Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !3594
| * Tutorial: MultiPackage now correctly compilesRobert Maynard2019-07-252-6/+13
| |
* | Tutorial: Improve Step 10 generator expression example.Robert Maynard2019-07-255-32/+79
|/ | | | | Use compiler flags and standard levels as the compelling argument for using generator expressions and interface libraries
* Help/guide/tutorial: Revert "require C++14 for the Tutorial"Brad King2019-07-2412-12/+24
| | | | | | | | | | Revert the changes from commit a2a90f41e3 (Tests: require C++14 for the Tutorial, 2019-03-21, v3.15.0-rc1~41^2~2) for the content in its new home. In commit d50b31be35 (Clang: For MSVC ABI do not use modes older than C++14, 2019-07-23) we fixed the C++ standard selection for GNU-like Clang with the MSVC ABI so the test code itself no longer needs to do it. In particular, changing the tests in this way broke the tutorial's narrative.
* Tutorial: Updated to reference using cmake --installRobert Maynard2019-07-191-6/+8
| | | | | This is preferred over using `make install` as it allows for control over the install location, configuration, and component.
* Help: Add tutorial guide table of contentsBrad King2019-06-191-0/+4
|
* Help: Update tutorial to include text from CMake bookBetsy McPhail2019-06-191-0/+35
|
* Help: Populate tutorial guide textBetsy McPhail2019-06-1944-939/+777
| | | | | | Migrate tutorial text from individual `directions.txt` files to the main tutorial document. Add some comments to source code to provide anchors for inclusion.
* Help/guide/tutorial: Adopt tutorial codeKitware Robot2019-06-18122-0/+3521
|
* Help: Add infrastructure for guide-level documentationBrad King2019-06-181-0/+2
Create a `Help/guide/` directory to hold guide-level documents. Build them in most documentation formats, but not as man pages. Initialize the guide directory with a placeholder for the tutorial.
generated by cgit v0.12 at 2025-01-08 18:38:17 (GMT)