Tutorial Improvements
Track minor issues with Tutorial. Replaces #19371 (closed)
-
General -
Suggestion: Change tutorial version for each step -
Suggestion: Replace set(CMAKE_CXX_STANDARD 11)
withtarget_compile_features
?
-
-
Step 1 -
Explicitly mention why we're setting cmake_minimum_required VERSION to 3.10. Some folks think this means the tutorial is out of date (discussion) -
Add a note early in Step1: "you can build and run this now!" Demonstrates how simple a CMake project can be. Also a good confidence booster to keep people interested in completing the tutorial. !6576 (merged)
-
-
Step 2 -
We've noticed multiple users struggle with Step2 by calling add_subdirectory(MathFunctions)
twice. Try to improve the instructions to make this part less error-prone. !6559 (merged)
-
-
Step 4 !6564 (merged) -
Update install
command in this step and subsequent ones to use the default locations provided by GNUInstallDirs. -
Change endfunction(do_test)
toendfunction()
-
Mention release mode is required for Visual Studio -
Some users get confused where they're supposed to run the tests from: binary tree vs. install tree. Update the language here to consistently use the term "binary directory" rather than "build directory"?
-
-
Step 5 -
Clarify instructions on where the first code block should be added in your CMakeLists.txt file. !6577 (merged)
-
-
Step 8 -
Having to write your own CTestConfig.cmake
file by hand isn't something we do "in real life". Provide a prewritten copy of this file and update the text to explain what it is and where it comes from (CDash). !6565 (merged)
-
-
Step 9 -
The expected linker error does not occur on Mac. Either change the example so it does, or add a note to the directions mentioning that this is the expected behavior. -
Describe where the namespace is introduced in the source -
Describe MathFunctions.cxx (it just appears?)
-
-
Step 10 -
Bump minimum required version to v3.15 when the COMPILE_LANG_AND_ID genex was introduced. Make sure this is mentioned in the instructions. -
installable_libs
should not includetutorial_compile_flags
? -
Add a warning or error that would indicate it’s working as expected (e.g. add unused variable to MathFunctions.cxx). Also, the "Exercise" is needed to finish the Step. It should be moved to part of the instructions. See #22702 (closed)
-
-
Step 11 !6575 (merged) -
Add text to describe configure_package_config_file
andwrite_basic_package_version_file
. -
Update text : The EXPORT keyword generates and installs
-
Edited by Betsy McPhail