microsoft / microsoft/mimalloc
readme's environmental option defaults?
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 13.4k
- Forks
- 1.2k
- Avg merge
- 4d 45m
- Merged PRs (30d)
- 13
Description
Under the "Environment Options" section, it looks like the values of the configuration variables are intended to match the defaults in the code. The MIMALLOC_PAGE_RESET variable in the readme is set to "zero", but is coded as "one" in options.c. The MIMALLOC_LARGE_OS_PAGES variable is also reversed. It looks like a few others may be like this as well.
v1.6.7
Thanks.
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Compare the Environment Options section in the README with the defaults defined in options.c, starting with MIMALLOC_PAGE_RESET and MIMALLOC_LARGE_OS_PAGES. Check the other listed variables for the same mismatch, then update the README so every documented default matches the code.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100