From ac5803dde96f6e21c4897be607c06f0aa9afc6b3 Mon Sep 17 00:00:00 2001 From: Shivam7-1 <55046031+Shivam7-1@users.noreply.github.com> Date: Tue, 15 Sep 2020 11:52:53 +0530 Subject: [PATCH] Update readme.md docs --- readme.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/readme.md b/readme.md index be6fddb8..d8710079 100644 --- a/readme.md +++ b/readme.md @@ -118,7 +118,7 @@ This builds the library as a shared (dynamic) library (`.so` or `.dylib`), a static library (`.a`), and 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 maintains detailed statistics as: @@ -132,7 +132,7 @@ maintains detailed statistics as: This will name the shared library as `libmimalloc-debug.so`. Finally, you can build a _secure_ version that uses guard pages, encrypted -free lists, etc., as: +free lists, etc. as: ``` > mkdir -p 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 -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. - All objects have padding at the end to detect (byte precise) heap block overflows.