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

Don't mention "fbc" SuppressWarnings string in manual #4060

Merged
merged 2 commits into from
Dec 22, 2020
Merged

Don't mention "fbc" SuppressWarnings string in manual #4060

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c8b4d92
Don't mention "fbc" SuppressWarnings string in manual
mernst Dec 22, 2020
bb9d4db
Merge ../checker-framework-branch-master into suppresswarnings-fbc
mernst Dec 22, 2020
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
7 changes: 4 additions & 3 deletions checker/src/main/java/org/checkerframework/checker/initialization/InitializationChecker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,10 @@ protected InitializationChecker() {}
@Override
public SortedSet<String> getSuppressWarningsPrefixes() {
SortedSet<String> result = super.getSuppressWarningsPrefixes();
// The SuppressesWarnings string "initialization" is not useful here: it suppresses *all*
// warnings, not just those related to initialization. Instead, if the user writes
// @SuppressWarnings("initialization"), let that match keys containing that string.
// "fbc" is for backward compatibility only. Note that the SuppressesWarnings strings
// "initialization" and "fbc" suppress *all* warnings, not just those related to
// initialization. See manual section
// https://checkerframework.org/manual/#initialization-checking-suppressing-warnings .
result.add("fbc");
return result;
}
Expand Down
10 changes: 5 additions & 5 deletions docs/manual/nullness-checker.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2018,11 +2018,11 @@
\subsectionAndLabel{Suppressing warnings}{initialization-checking-suppressing-warnings}

To suppress most warnings related to partially-initialized values, use the
warning suppression string ``initialization.''~(note the trailing period)
or ``fbc''. You can write \<@SuppressWarnings("initialization.")> or
\<@SuppressWarnings("fbc")> on a field, constructor, or
warning suppression string ``initialization.''~(note the trailing period).
You can write \<@SuppressWarnings("initialization.")>
on a field, constructor, or
class, or pass the command-line argument
\<-AsuppressWarnings=initialization.>~or \<-AsuppressWarnings=fbc> when
\<-AsuppressWarnings=initialization.> when
running the Nullness Checker.
(For more about suppressing warnings, see
\chapterpageref{suppressing-warnings}). You will no longer get a guarantee
Expand Down Expand Up @@ -2087,7 +2087,7 @@
% LocalWords: typeofthis nraB nrbB rO nroO nroB containsKey enum NullAway
% LocalWords: JUnit's field1 field2 superclasses Foo C1 C2 PolyRaw type''
% LocalWords: NullnessChecker redundantNullComparison instanceof runtime
% LocalWords: noInitForMonotonicNonNull UnknownInitialization isArray fbc
% LocalWords: noInitForMonotonicNonNull UnknownInitialization isArray
% LocalWords: UnderInitialization getComponentType AsuppressWarnings
% LocalWords: isEmpty AssumeAssertion cleanroom varargs OtherClass Astubs
% LocalWords: mymap mykey KeyType ValueType lineSeparator receiver''
Expand Down