kiper220/mimalloc
1
0
Fork 0
mirror of https://github.com/microsoft/mimalloc.git synced 2025-05-20 14:09:32 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update readme.md docs

Browse source
This commit is contained in:
Shivam7-1 2020-09-15 11:52:53 +05:30 • committed by GitHub
parent 5cd5423108
commit ac5803dde9
WARNING! Although there is a key with this ID in the database it does not verify this commit! This commit is SUSPICIOUS.
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
readme.md
View file

@ -118,7 +118,7 @@ This builds the library as a shared (dynamic)
library (`.so` or `.dylib`), a static library (`.a`), and library (`.so` or `.dylib`), a static library (`.a`), and
as a single object file (`.o`). as a single object file (`.o`).
`> sudo make install` (install the library and header files in `/usr/local/lib` and `/usr/local/include`) `> sudo make install` (install the library and header files in `/usr/local/lib` and `/usr/local/include`).
You can build the debug version which does many internal checks and You can build the debug version which does many internal checks and
maintains detailed statistics as: maintains detailed statistics as:
@ -132,7 +132,7 @@ maintains detailed statistics as:
This will name the shared library as `libmimalloc-debug.so`. This will name the shared library as `libmimalloc-debug.so`.
Finally, you can build a _secure_ version that uses guard pages, encrypted Finally, you can build a _secure_ version that uses guard pages, encrypted
free lists, etc., as: free lists, etc. as:
``` ```
> mkdir -p out/secure > mkdir -p out/secure
> cd out/secure > cd out/secure
@ -286,7 +286,7 @@ As always, evaluate with care as part of an overall security strategy as all of
## Debug Mode ## Debug Mode
When _mimalloc_ is built using debug mode, various checks are done at runtime to catch development errors. When _mimalloc_ is built using debug mode, various checks are done at runtime to catch development errors:
- Statistics are maintained in detail for each object size. They can be shown using `MIMALLOC_SHOW_STATS=1` at runtime. - Statistics are maintained in detail for each object size. They can be shown using `MIMALLOC_SHOW_STATS=1` at runtime.
- All objects have padding at the end to detect (byte precise) heap block overflows. - All objects have padding at the end to detect (byte precise) heap block overflows.