Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
This PR changes the
cmake
name of the package in the build system from the defaultyaml-cpp
toYAML_CPP
, and sets it as an alias for the originalyaml-cpp
.This ensures that an external installation of the library outside of the standard location can be found by
cmake
, through the defaultcmake
env variableYAML_CPP_ROOT
.Upgrade instructions
Code review checklist
make doc
to generate the documentation locally intoBUILD_DIR/docs/html
.Then open
index.html
.code review guide.
bugfix
ornew feature
if appropriate.Further comments
Currently, the package yaml-cpp is declared as itself in cmake setup files, with the hyphen. While this doesn't cause any issues when the library is installed in standard locations, the hyphen in the cmake package name causes a failure for yaml-cpp to be found when installed in non-standard locations, translating to a failure at the configure stage:
This is due to the fact that
cmake
looks in the path<PackageName>_ROOT
, which for this package isyaml-cpp_ROOT
. As per IEEE Standards 1003.1-2001, this is not a valid environment variable, at least in UNIX and thus cannot be set.