Add migration documentation - #37
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a dedicated migration guide for consumers moving from toolchain-owned GCC warning flags to policy-owned, opt-in warning cc_features in this repository, and links to it from the existing warnings documentation.
Changes:
- Adds a “Migrating from toolchain-owned warnings” section to
docs/warnings.mdlinking to the migration guide. - Introduces
docs/migration-warnings.mddescribing the old vs. new warnings model, prerequisites, and rollout examples.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/warnings.md | Adds a migration section and link to the new migration guide. |
| docs/migration-warnings.md | New end-to-end migration documentation for adopting policy-owned warning features. |
Suppressed comments (2)
docs/migration-warnings.md:23
- The link label suggests a directory (
warnings/gcc/features) but the URL points to theBUILDfile. Align the link text with the actual destination to avoid confusion.
[`warnings/gcc/features`](../warnings/gcc/features/BUILD):
docs/migration-warnings.md:43
- "currently the latest release" will become stale over time. Prefer stating the minimum version requirement without asserting which release is latest.
- `score_cpp_policies` **0.1.0 or newer** — the warnings features were
introduced in `0.1.0`, currently the latest release.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+8
to
+11
| Prior to this repo taking ownership, the `-W` flag sets consumers built | ||
| with were hardcoded directly inside `score_bazel_cpp_toolchains` itself | ||
| (baked into each registered `cc_toolchain`'s always-on argument list). This | ||
| meant: |
nradakovic
force-pushed
the
nira_add_migration_docs
branch
from
August 27, 2026 10:00
6b09e2d to
22fe28a
Compare
Add migration documentation.
nradakovic
force-pushed
the
nira_add_migration_docs
branch
from
August 27, 2026 10:34
22fe28a to
edbe9f9
Compare
nradakovic
marked this pull request as ready for review
August 27, 2026 10:34
antonkri
approved these changes
Aug 27, 2026
github-project-automation
Bot
moved this from In Progress
to Done
in INF - Infrastructure Community
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.
Add migration documentation.