Commit Graph

36 Commits

Author SHA1 Message Date
Ben Boeckel e3096a242d Help: add alt text to embedded images 2020-05-07 13:25:57 -04:00
Brad King a3ba2c90d7 Tutorial: Restore MakeTable.cxx in step 6
In commit 9da3c9b59b (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 b6042407ca Merge topic 'tutorial-remove-maketable'
9da3c9b59b 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 9da3c9b59b 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 afd63d3b3d Tutorial: Clarify Step 5
Fixes: #20619
2020-04-23 11:47:20 -04:00
Betsy McPhail 758533f5fc 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 38ede4af80 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 cc5aedbb73 Tutorial: Clarify Step 5 2020-01-16 15:54:01 -05:00
Brad King 4d9dbb40b6 Merge topic 'tutorial'
f0b536229f Tutorial: Add the PRIVATE keyword to target_link_libraries command
ab4c256f29 Tutorial: Remove 'Consumer' example
1d79f71489 Tutorial: Improve "MultiPackage" example
1919f791b8 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 d60def17b9 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 f0b536229f Tutorial: Add the PRIVATE keyword to target_link_libraries command 2020-01-10 11:38:00 -05:00
Betsy McPhail ab4c256f29 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 1d79f71489 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 1919f791b8 Tutorial: Add links to relevant CMake documentation
Add links for commands, properties and variables.
2020-01-09 14:49:28 -05:00
Arkadiusz Drabczyk cc6c310d5c 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 207c5eb6a9 Tutorial: clean up typos, grammar and formatting 2019-11-04 12:44:34 +11:00
Kitware Robot 1344e43bcf 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 e97c5aa7d3 Tutorial: Improve Step 9
* Move USE_MYMATH from configured header to target_compile_definitions
2019-08-19 11:49:05 -04:00
Betsy McPhail f64f77839e Tutorial: Improve Step 8
* Remove comments from CTestConfig.cmake
* Update directions
2019-08-19 11:49:05 -04:00
Betsy McPhail ee23609cac Tutorial: Improve Step 7
* Update directions
2019-08-19 11:49:05 -04:00
Betsy McPhail 5436f3f373 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 c8bff119d6 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 5d699306ac Tutorial: Improve Step 4
* Clarify directions
2019-08-19 11:49:05 -04:00
Betsy McPhail 8041bdd2d0 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 483a3b0606 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 38de612a81 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 25551cf68f Merge topic 'multipackage_tutorial_compiles'
b0e078a702 Tutorial: MultiPackage now correctly compiles

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !3594
2019-07-30 11:37:36 -04:00
Robert Maynard b0e078a702 Tutorial: MultiPackage now correctly compiles 2019-07-25 07:34:41 -04:00
Robert Maynard b68f531b03 Tutorial: Improve Step 10 generator expression example.
Use compiler flags and standard levels as the compelling argument
for using generator expressions and interface libraries
2019-07-25 07:30:13 -04:00
Brad King 0f4bfd028c Help/guide/tutorial: Revert "require C++14 for the Tutorial"
Revert the changes from commit f31343d69e (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 13ee44d267 (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.
2019-07-24 08:04:20 -04:00
Robert Maynard 79f291bd32 Tutorial: Updated to reference using cmake --install
This is preferred over using `make install` as it allows for control
over the install location, configuration, and component.
2019-07-19 14:38:05 -04:00
Brad King 692698b868 Help: Add tutorial guide table of contents 2019-06-19 09:00:19 -04:00
Betsy McPhail ea8ec8a6e3 Help: Update tutorial to include text from CMake book 2019-06-19 08:59:31 -04:00
Betsy McPhail dbdfb7a969 Help: Populate tutorial guide text
Migrate tutorial text from individual `directions.txt` files to the main
tutorial document.  Add some comments to source code to provide anchors
for inclusion.
2019-06-19 08:57:12 -04:00
Kitware Robot 3fee3a27fb Help/guide/tutorial: Adopt tutorial code 2019-06-18 10:36:16 -04:00
Brad King 066df2f811 Help: Add infrastructure for guide-level documentation
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.
2019-06-18 10:36:16 -04:00