Doc consolidation - #1
Merged
Merged
Conversation
N1.9 is closed, but the file still carried its working state: a triage table of 59 -Xlint warnings that are all fixed, build timings from the day the decision was taken, and a narrative of the NullAway passes that docs/follow-up.md already tells better. Keep what a future reader cannot reconstruct -- the constraint that decided the selections, why Checkstyle and PMD were rejected, and the scoping on the tools that are accepted but unadopted (SpotBugs is protocol/codec, CI-only, minus EI_EXPOSE_REP; Error Prone is its ERROR tier only). Retitle so it no longer reads as a plan item's tracker.
The gates list was missing two of the six source-policy tests (NoSynchronizedSourcePolicyTest, ApiSurfaceManifestTest) and both compiler gates (-Xlint under -Werror, NullAway). The synchronized ban in particular was stated twice as advice with no mention that it is enforced. The section header also claimed the gates fail at verify and not at test, while its own AsciiSourcePolicyTest bullet said otherwise. Group them by the phase they actually fire at instead: compiler, test, then validate/verify. Point the docs table at docs/static-analysis.md, which nothing referenced.
forbidden-apis, Error Prone's own ERROR-tier checks, and scoped SpotBugs were each a clause in a follow-up paragraph, which is the wrong home: they are one atomic commit apiece. Break them out as N1.23-N1.25 with the scope that makes each one adoptable. revapi was tracked nowhere actionable -- ADR-0020 asks for it, N7.3 alluded to an unnamed binary-compatibility gate, and nothing tied it to the release that unblocks it. Name it on N7.1, since it needs a published artifact to diff against. follow-up N1.9 keeps the two residuals that genuinely are not single commits: NullAway over jdbc/compat, and the coverage floor.
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
1 participant
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.
Reigns in the docs a bit by deleting some out of date task lists and consolidating a bunch into the overall plan.
Also an opportunity to test the CI in the new repo.