Clarify [DEPENDENCY] marker and ci.yml.in dependency-source comment#26
Merged
Conversation
Copilot review on stlab-copy-on-write#14 flagged two docs issues that trace back to cpp-library: the [DEPENDENCY] search-marker convention wasn't specified as non-rendering, so a consumer copied it into their README as visible text; and the generated ci.yml header pointed to cmake/cpp-library-ci.cmake without noting the file lives in the cpp-library dependency, not the consumer's own repo. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
[DEPENDENCY]search-marker convention should be embedded as an HTML comment (not visible text), per feedback on stlab-copy-on-write#14 where a consumer's README rendered the marker as a stray-looking line.ci.ymlheader comment to state thatcmake/cpp-library-ci.cmakelives in the cpp-library dependency, not the consumer's own repo, avoiding confusion when someone looks for the file locally.Test plan
cmake -P tests/install/CMakeLists.txt(32/32 passing, 1 intentional skip) — unaffected, doc/comment-only changes