This is an archive of the discontinued LLVM Phabricator instance.

[SanitizeCoverage] Rename -fsanitize-coverage-{white,black}list to -fsanitize-coverage-{allow,block}list
ClosedPublic

Authored by MaskRay on Jun 19 2020, 2:59 PM.

Details

Summary

Keep -fsanitize-coverage-{white,black}list as aliases for compatibility for now.

Diff Detail

Event Timeline

MaskRay created this revision.Jun 19 2020, 2:59 PM
Herald added projects: Restricted Project, Restricted Project. · View Herald TranscriptJun 19 2020, 2:59 PM
Herald added subscribers: Restricted Project, cfe-commits, aaron.ballman. · View Herald Transcript
MaskRay updated this revision to Diff 272193.Jun 19 2020, 3:07 PM

Update more files

You'll want to grab blacklist/whitelist in the comments around as well.

We've been talking about having a need for deprecated aliases file for these options - it's probably worth bringing this patch up on cfe-dev and cc'ing richardsmith explicitly. I think we can avoid compatibility aliases, but would like Richard to sign off.

MaskRay updated this revision to Diff 272200.Jun 19 2020, 3:22 PM
MaskRay edited the summary of this revision. (Show Details)
MaskRay edited reviewers, added: pcc; removed: HAPPY.

Add aliases

Herald added a project: Restricted Project. · View Herald TranscriptJun 19 2020, 3:22 PM
MaskRay updated this revision to Diff 272201.Jun 19 2020, 3:31 PM

Fix documentation

echristo added inline comments.Jun 19 2020, 3:52 PM
clang/docs/ClangCommandLineReference.rst
313–316

Miss merge?

887

I'd remove the uses of blacklist and whitelist here and below. Just have the language and the documentation be for the new option.

clang/docs/SanitizerCoverage.rst
435

blacklist here.

clang/include/clang/Driver/Options.td
1002–1005

Deprecate the option and comment it as such.

compiler-rt/test/sanitizer_common/TestCases/sanitizer_coverage_allowlist_blocklist.cpp
2

blacklist filename. probably want to change wl_* and bl_* below as well.

MaskRay marked 6 inline comments as done.Jun 19 2020, 4:09 PM
MaskRay added inline comments.
clang/docs/ClangCommandLineReference.rst
887

clang-tblgen -gen-opt-docs does not seem to provide a feature to hide an option. HelpHidden does not hide the option.

clang/docs/SanitizerCoverage.rst
435

sancov is another tool that is not touched by this patch. It should be updated separately.

clang/include/clang/Driver/Options.td
1002–1005

HelpHidden will hide the options from help.

compiler-rt/test/sanitizer_common/TestCases/sanitizer_coverage_allowlist_blocklist.cpp
2

wl_ -> al_

bl_ can still mean blocklist.

MaskRay updated this revision to Diff 272209.Jun 19 2020, 4:09 PM
MaskRay marked an inline comment as done.

Fix more words

Harbormaster completed remote builds in B61113: Diff 272200.
echristo accepted this revision.Jun 19 2020, 9:08 PM

Couple of inline comments then looks good to go. Thank you so much for your effort here.

-eric

clang/docs/ClangCommandLineReference.rst
887

Please remove blacklist and whitelist from the option description.

compiler-rt/test/sanitizer_common/TestCases/sanitizer_coverage_allowlist_blocklist.cpp
89

Make a note that the options below ware deprecated and will be removed.

This revision is now accepted and ready to land.Jun 19 2020, 9:08 PM
MaskRay marked an inline comment as done.Jun 19 2020, 9:40 PM
MaskRay added inline comments.
clang/docs/ClangCommandLineReference.rst
887

I can do that but the next person updating the documentation will add them back.

I believe clang-tblgen -gen-opt-docs just doesn't have the feature. Maybe we can delete the old options earlier so that we don't need to worry about the documentation.

echristo added inline comments.Jun 19 2020, 9:42 PM
clang/docs/ClangCommandLineReference.rst
887

Ugh. Yes, I hope so too. Can you raise it on cfe-dev?

MaskRay updated this revision to Diff 272237.Jun 19 2020, 10:19 PM
MaskRay marked 4 inline comments as done.

Address comments

MaskRay added inline comments.Jun 19 2020, 10:23 PM
clang/docs/ClangCommandLineReference.rst
887

I can but I need to understand more about clang-tblgen -gen-opt-docs first...

Very few people know how to regenerate the doc I think...

This revision was automatically updated to reflect the committed changes.