diff options
Diffstat (limited to 'jemalloc/INSTALL')
| -rw-r--r-- | jemalloc/INSTALL | 55 |
1 files changed, 41 insertions, 14 deletions
diff --git a/jemalloc/INSTALL b/jemalloc/INSTALL index eec3b37..fafd788 100644 --- a/jemalloc/INSTALL +++ b/jemalloc/INSTALL @@ -27,26 +27,42 @@ any of the following arguments (not a definitive list) to 'configure': it is linked to. This works only on ELF-based systems. --with-jemalloc-prefix=<prefix> - Prefix all public APIs with <prefix>, so that, for example, malloc() - becomes <prefix>malloc(). This makes it possible to use jemalloc at the - same time as the system allocator. + Prefix all public APIs with <prefix>. For example, if <prefix> is + "prefix_", the API changes like the following occur: + + malloc() --> prefix_malloc() + malloc_conf --> prefix_malloc_conf + /etc/malloc.conf --> /etc/prefix_malloc.conf + MALLOC_CONF --> PREFIX_MALLOC_CONF + + This makes it possible to use jemalloc at the same time as the system + allocator, or even to use multiple copies of jemalloc simultaneously. + + By default, the prefix is "", except on OS X, where it is "je_". On OS X, + jemalloc overlays the default malloc zone, but makes no attempt to actually + replace the "malloc", "calloc", etc. symbols. --with-install-suffix=<suffix> Append <suffix> to the base name of all installed files, such that multiple versions of jemalloc can coexist in the same installation directory. For example, libjemalloc.so.0 becomes libjemalloc<suffix>.so.0. +--enable-cc-silence + Enable code that silences unuseful compiler warnings. This is helpful when + trying to tell serious warnings from those due to compiler limitations, but + it potentially incurs a performance penalty. + --enable-debug Enable assertions and validation code. This incurs a substantial performance hit, but is very useful during application development. --enable-stats - Enable statistics gathering functionality. Use the 'P' option to print - detailed allocation statistics at exit. + Enable statistics gathering functionality. See the "opt.stats_print" + option documentation for usage details. --enable-prof - Enable heap profiling and leak detection functionality. Use the 'B', 'E', - 'F', 'I', 'L', and 'U' options to control these features. + Enable heap profiling and leak detection functionality. See the "opt.prof" + option documention for usage details. --disable-prof-libgcc Disable the use of libgcc's backtracing functionality. Ordinarily, libgcc's @@ -72,8 +88,8 @@ any of the following arguments (not a definitive list) to 'configure': --disable-tcache Disable thread-specific caches for small objects. Objects are cached and - released in bulk, thus reducing the total number of mutex operations. Use - the 'H', 'G', and 'M' options to control thread-specific caching. + released in bulk, thus reducing the total number of mutex operations. See + the "opt.tcache" option for suage details. --enable-swap Enable mmap()ed swap file support. When this feature is built in, it is @@ -85,18 +101,18 @@ any of the following arguments (not a definitive list) to 'configure': mmap(2). --enable-fill - Enable support for junk/zero filling of memory. Use the 'J' option to - control junk filling, or the 'Z' option to control zero filling. + Enable support for junk/zero filling of memory. See the "opt.junk"/ + "opt.zero" option documentation for usage details. --enable-xmalloc Enable support for optional immediate termination due to out-of-memory errors, as is commonly implemented by "xmalloc" wrapper function for malloc. - Use the 'X' option to control termination behavior. + See the "opt.xmalloc" option documentation for usage details. --enable-sysv Enable support for System V semantics, wherein malloc(0) returns NULL - rather than a minimal allocation. Use the 'V' option to control System V - compatibility. + rather than a minimal allocation. See the "opt.sysv" option documentation + for usage details. --enable-dynamic-page-shift Under most conditions, the system page size never changes (usually 4KiB or @@ -213,3 +229,14 @@ directory, issue configuration and build commands: cd obj ../configure --enable-autogen make + +=== Documentation ============================================================== + +The manual page that the configure script generates can be manually formatted +prior to installation via any of the following commands: + + nroff -man -man-ext -t doc/jemalloc.3 + + groff -man -man-ext -t -Tps doc/jemalloc.3 | ps2pdf - doc/jemalloc.3.pdf + + (cd doc; groff -man -man-ext -t -Thtml jemalloc.3 > jemalloc.3.html) |