docs(clp-core): Update CLP core dependency names and versions. - #1262
Conversation
WalkthroughThe documentation file docs/src/dev-guide/components-core/index.md was updated to replace Git-based dependency references with versioned/non-Git entries, add microsoft.gsl and nlohmann_json, map prior git-submodule entries to versions/commits, and reorder/reformat the Source Dependencies table. No code changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
docs/src/dev-guide/components-core/index.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: lint-check (ubuntu-24.04)
- GitHub Check: lint-check (macos-15)
🔇 Additional comments (3)
docs/src/dev-guide/components-core/index.md (3)
41-42: Good switch to versioned, tagged releases for Catch2 and datePinning Catch2 to v3.8.0 and Howard Hinnant’s date to v3.0.1 improves reproducibility and aligns with the move away from git-submodule pins.
54-55: Please manually verify utfcpp and yaml-cpp integrationOur automated scan didn’t detect any direct references in the codebase to either utfcpp headers or yaml-cpp linkage, so you’ll need to confirm these yourself:
• No utfcpp includes found
– Neither classic#include <utf8…>nor the v4 pattern#include <utfcpp/...>was detected.
– If you’re using utfcpp v4.0.6, ensure your code includes the correct headers (e.g.<utfcpp/utf8.h>or whichever path matches your install).• No yaml-cpp linkage in CMake
– We didn’t see anytarget_link_libraries(... yaml-cpp)calls.
– Verify you’re linking against the proper target name (for v0.7.0 this may beyaml-cpporyaml-cpp::yaml-cpp, depending on how you configuredfind_package) and that any required CMake policies (e.g., CMP0074 forfind_packagenamespacing) are set.Please review your project’s include paths and CMakeLists files (including any subdirectories or external modules) to make sure the documentation versions match your actual build setup.
45-45: Action required: replace short 7–8 char SHAs with durable pins
I attempted to verify the three prefixes viagit ls-remote, but no matches were returned (likely due to network or access restrictions). Please manually confirm each SHA and update the table to use either a released tag or a ≥12-character commit ID (optionally appending the commit date for auditability).Locations:
- File: docs/src/dev-guide/components-core/index.md
– Lines 45 & 56Entries to update:
- y-scope/log-surgeon @ a82ad13
- y-scope/yscope-log-viewer @ 3abe4cc
- y-scope/ystdlib-cpp @ d80cf86
Preferred pin formats:
- A released, immutable tag (ideal), or
- The full ≥12-char SHA (e.g.,
abcdef123456…) plus the commit date in brackets (e.g., [2024-09-12]).
Description
Due to frequent updates, our documentation has gone slightly out of sync with what's being done in
task deps:core. This PR fixes library names and updates versions.Checklist
breaking change.
Validation performed
Summary by CodeRabbit