summaryrefslogtreecommitdiffstats
path: root/jemalloc/doc
diff options
context:
space:
mode:
authorJason Evans <jasone@canonware.com>2010-09-05 17:35:13 (GMT)
committerJason Evans <jasone@canonware.com>2010-09-12 01:20:16 (GMT)
commit2dbecf1f6267fae7a161b9c39cfd4d04ce168a29 (patch)
tree246a2c4d549d4b007184c518e69deacbad4a0aaa /jemalloc/doc
parentb267d0f86aff15a0edb2929f09060c118ed98ec4 (diff)
downloadjemalloc-2dbecf1f6267fae7a161b9c39cfd4d04ce168a29.zip
jemalloc-2dbecf1f6267fae7a161b9c39cfd4d04ce168a29.tar.gz
jemalloc-2dbecf1f6267fae7a161b9c39cfd4d04ce168a29.tar.bz2
Port to Mac OS X.
Add Mac OS X support, based in large part on the OS X support in Mozilla's version of jemalloc.
Diffstat (limited to 'jemalloc/doc')
-rw-r--r--jemalloc/doc/jemalloc.3.in31
1 files changed, 15 insertions, 16 deletions
diff --git a/jemalloc/doc/jemalloc.3.in b/jemalloc/doc/jemalloc.3.in
index d2d5b77..dfc4d76 100644
--- a/jemalloc/doc/jemalloc.3.in
+++ b/jemalloc/doc/jemalloc.3.in
@@ -464,7 +464,7 @@ is a single CPU.
@roff_swap@This option is enabled by default.
.It P
The
-.Fn malloc_stats_print
+.Fn @jemalloc_prefix@malloc_stats_print
function is called at program exit via an
.Xr atexit 3
function.
@@ -626,7 +626,7 @@ round your allocation requests up to the nearest multiple of the cacheline
size.
.Sh MALLCTL NAMESPACE
The following names are defined in the namespace accessible via the
-.Fn mallctl*
+.Fn @jemalloc_prefix@mallctl*
functions.
Value types are specified in parentheses, and their readable/writable statuses
are encoded as rw, r-, -w, or --.
@@ -648,7 +648,7 @@ Return the jemalloc version string.
.It Sy "epoch (uint64_t) rw"
.Bd -ragged -offset indent -compact
If a value is passed in, refresh the data from which the
-.Fn mallctl*
+.Fn @jemalloc_prefix@mallctl*
functions report values, and increment the epoch.
Return the current epoch.
This is useful for detecting whether another thread caused a refresh.
@@ -669,18 +669,17 @@ This is useful for detecting whether another thread caused a refresh.
@roff_tcache@find manual flushing useful.
.Ed
.\"-----------------------------------------------------------------------------
-@roff_tls@.It Sy "thread.arena (unsigned) rw"
-@roff_tls@.Bd -ragged -offset indent -compact
-@roff_tls@Get or set the arena associated with the calling thread.
-@roff_tls@The arena index must be less than the maximum number of arenas (see
-@roff_tls@the
-@roff_tls@.Dq arenas.narenas
-@roff_tls@mallctl).
-@roff_tls@If the specified arena was not initialized beforehand (see the
-@roff_tls@.Dq arenas.initialized
-@roff_tls@mallctl), it will be automatically initialized as a side effect of
-@roff_tls@calling this interface.
-@roff_tls@.Ed
+.It Sy "thread.arena (unsigned) rw"
+.Bd -ragged -offset indent -compact
+Get or set the arena associated with the calling thread.
+The arena index must be less than the maximum number of arenas (see the
+.Dq arenas.narenas
+mallctl).
+If the specified arena was not initialized beforehand (see the
+.Dq arenas.initialized
+mallctl), it will be automatically initialized as a side effect of calling this
+interface.
+.Ed
.\"-----------------------------------------------------------------------------
.It Sy "config.debug (bool) r-"
.Bd -ragged -offset indent -compact
@@ -1442,7 +1441,7 @@ Attempt to read or write void value, or attempt to write read-only value.
A memory allocation failure occurred.
.It Bq Er EFAULT
An interface with side effects failed in some way not directly related to
-.Fn mallctl*
+.Fn @jemalloc_prefix@mallctl*
read/write processing.
.El
.Sh ENVIRONMENT