Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Fix link to ycm_load_vcs_yaml_info CMake function #928

Merged
merged 1 commit into from
Nov 23, 2021
Merged

doc: Fix link to ycm_load_vcs_yaml_info CMake function #928

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/change-project-tags.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ It can take one of three possible values:
that are the "unstable" active development branches for the robotology projects. This is reccomended just for users that work at the IIT labs in Genoa,
as it can break compilation or runtime behaviour without any notice.
* `Custom` : by selecting this option, you need to manually specify the tags or branches that you want to use by specifying a custom project tags file in the
`ROBOTOLOGY_PROJECT_TAGS_CUSTOM_FILE` CMake option. It is necessary to specify the absolute location of the file. This is useful when you want to use a fixed version of the software built by the superbuild. The specified file is included in the project via the [`include` CMake command](https://cmake.org/cmake/help/v3.15/command/include.html), or if it ends with `.yaml` or `.repos` it is assumed to be a YAML file that is loaded by the [`ycm_load_vcs_yaml_info`](cmake/YCMLoadVcsYamlInfo.cmake) CMake function.
`ROBOTOLOGY_PROJECT_TAGS_CUSTOM_FILE` CMake option. It is necessary to specify the absolute location of the file. This is useful when you want to use a fixed version of the software built by the superbuild. The specified file is included in the project via the [`include` CMake command](https://cmake.org/cmake/help/v3.15/command/include.html), or if it ends with `.yaml` or `.repos` it is assumed to be a YAML file that is loaded by the [`ycm_load_vcs_yaml_info`](../cmake/YCMLoadVcsYamlInfo.cmake) CMake function.

**Due to limitations on how the CMake's [`ExternalProject`](https://cmake.org/cmake/help/latest/module/ExternalProject.html) modules handles the TAG option, the choice
of the `ROBOTOLOGY_PROJECT_TAGS` option needs to be done before the source code for the CMake packages is downloaded for the first time in the `src` directory.
Expand Down