Improvements to our Tutorial
This issue is meant to capture related minor issues that we've noticed with our Tutorial.
-
Step 1 -
Use VERSION
argument toproject
command rather than separate variables. (!3528 (merged))
-
-
Step 2 -
Bug: put the option
before theconfigure_file
, or make it clear that this is an intentional error meant to be fixed by the student. (This may have been fixed as part of !3429 (merged), clarified in !3528 (merged)) -
Bug: the c++ prints out MAJOR MAJOR (should be MAJOR MINOR). Also check if this bug was copied into subsequent steps (!3448 (merged)) -
The directions don't mention that you to include MathFunctions.h
. (!3528 (merged))
-
-
Step 4 -
Update install
command in this step and subsequent ones to use the default locations provided by GNUInstallDirs.
-
-
Step 6 -
MakeTable.cxx
is already written. The directions make it sound like the user will need to add this file. (!3528 (merged)) -
The directions recommend PUBLIC but the code says PRIVATE for Tutorial_BINARY_DIR
. (Fixed as part of !3439 (merged)) -
It is unclear how to use the precomputed sqrtTable
sinceHAVE_LOG
andHAVE_EXP
are available. (!3528 (merged)) -
Add a print statement to mysqrt to make it more clear that the precomputed value is being used. (!3528 (merged))
-
-
Step 7 -
Bug: cpack -C CPackSourceConfig.cmake
doesn't generate a source tarball. It should becpack --config CPackSourceConfig.cmake
instead. (!3528 (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.
-
-
Step 10 -
Come up with a more compelling example of generator expressions. Perhaps different flags for developer vs. user builds, or an example of BUILD_INTERFACE
vsINSTALL_INTERFACE
. (13571)
-
-
Step 11 -
Add text to describe configure_package_config_file
andwrite_basic_package_version_file
.
-
-
MultiPackage -
Add to CMake test suiteRemove
-
Edited by Betsy McPhail