docs(main): justify non_upper_case_globals allow in jemalloc malloc_conf symbols#123
Open
DeviosLang wants to merge 1 commit into
Open
Conversation
…onf symbols malloc_conf is an ABI-defined C symbol name required by jemalloc and must be exactly lower_snake_case. The #[allow(non_upper_case_globals)] attributes are load-bearing and cannot be removed; update comments to make this explicit. Mark corresponding CODE_QUALITY_TODO suppression backlog item as complete.
zombi3butt
pushed a commit
to zombi3butt/jcode
that referenced
this pull request
May 22, 2026
The two #[allow(non_upper_case_globals)] suppressions in src/main.rs guard a load-bearing ABI symbol: jemalloc looks up the exported C symbol `malloc_conf` at process startup, and the name must be exactly that (lower_snake_case). Renaming to satisfy the lint would silently disable jemalloc tuning. Replace the terse comment with a concrete explanation noting the ABI contract so future contributors don't try to remove the allow. Tick the matching item in docs/CODE_QUALITY_TODO.md. Ports upstream PR 1jehuang#123. Closes quangdang46#101
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.
Part of the suppression cleanup backlog in docs/CODE_QUALITY_TODO.md.
malloc_confis an ABI-defined C symbol name looked up by jemalloc at process startup. The name must be exactlymalloc_conf(lower_snake_case) per the jemalloc ABI, so#[allow(non_upper_case_globals)]is load-bearing and cannot be removed.Replace the terse one-line comments with an explanation that makes this clear to future readers, and mark the corresponding TODO item as complete.
Need help on this PR? Tag
@codesmithwith what you need.