Consider recommending building with the Clang plugin
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 55/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- cpp
- Domain
- documentation
Research direction
Open the linked Thunderbird build configuration section and review how local mozconfig options are documented. Add the recommendation to enable the Clang plugin with the provided ac_add_options --enable-clang-plugin snippet, then verify the developer documentation page renders correctly.
Written by the indexing model from the issue text.
Description
mozilla-central includes an internal Clang plugin that adds static-analysis checks at build-time, to ensure things like proper use of smart pointers in C++: https://firefox-source-docs.mozilla.org/code-quality/static-analysis/existing.html#build-time-static-analysis
A list of checks that are performed by this plugin can be found here: https://searchfox.org/mozilla-central/rev/5a7e5e2e1fe04028fc77787084caf9b26ab74ce6/mfbt/Attributes.h#511
Both comm-central and try-comm-central build with this plugin, so I think we should recommend developers and contributors also enable it for their local builds to prevent bustages, by adding the following to their mozconfig file:
ac_add_options --enable-clang-plugin
A good location for this recommendation could be in this section: https://developer.thunderbird.net/thunderbird-development/building-thunderbird#build-configuration
- Dominant language
- No language data
- Stars
- 114
- Forks
- 86
- Avg merge
- 2h 37m
- Merged PRs (30d)
- 1
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from thunderbird/developer-docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
thunderbird/developer-docs#244 · 2 comments ·
-
Difficulty 1/5 1-3 hours Newbie friendliness 62/100
thunderbird/developer-docs#125 ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
thunderbird/developer-docs#238 · 6 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
thunderbird/developer-docs#232 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
thunderbird/developer-docs#229 · 2 comments ·
All issues in thunderbird/developer-docs
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·
-
bug triage:deciding
Difficulty 1/5 Under an hour Newbie friendliness 88/100
open-telemetry/otel-arrow#4132 ·
-
Ecosystem: ClawMetry — the Qwen Code reader is now free and open source (follow-up to #9294 / #9338) Opencategory/integration priority/P3 scope/documentation status/ready-for-human type/feature-request
Difficulty 1/5 Under an hour Newbie friendliness 84/100