about summary refs log tree commit diff
path: root/src/rt/jemalloc/doc
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2013-06-12 20:25:17 -0700
committerbors <bors@rust-lang.org>2013-06-12 20:25:17 -0700
commit996301331e2d8ac7611d15ca82cc3ebc1abb632d (patch)
tree032c91b56939850145b16ede2a5bfa35e4620f92 /src/rt/jemalloc/doc
parent6c45160f19cff60e8956491eabe9e4704735c0eb (diff)
parent0685c657f0b29f6372bd4b031753ff92fc3b53ba (diff)
downloadrust-996301331e2d8ac7611d15ca82cc3ebc1abb632d.tar.gz
rust-996301331e2d8ac7611d15ca82cc3ebc1abb632d.zip
auto merge of #7079 : thestinger/rust/jemalloc, r=graydon
Minor release, the ChangeLog is included in the update.
Diffstat (limited to 'src/rt/jemalloc/doc')
-rw-r--r--src/rt/jemalloc/doc/jemalloc.322
-rw-r--r--src/rt/jemalloc/doc/jemalloc.xml.in9
2 files changed, 25 insertions, 6 deletions
diff --git a/src/rt/jemalloc/doc/jemalloc.3 b/src/rt/jemalloc/doc/jemalloc.3
index 1462e2c2b34..d0e0a23bab3 100644
--- a/src/rt/jemalloc/doc/jemalloc.3
+++ b/src/rt/jemalloc/doc/jemalloc.3
@@ -2,12 +2,12 @@
 .\"     Title: JEMALLOC
 .\"    Author: Jason Evans
 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\"      Date: 03/06/2013
+.\"      Date: 06/02/2013
 .\"    Manual: User Manual
-.\"    Source: jemalloc 3.3.1-0-g9ef9d9e8c271cdf14f664b871a8f98c827714784
+.\"    Source: jemalloc 3.4.0-0-g0ed518e5dab789ad2171bb38977a8927e2a26775
 .\"  Language: English
 .\"
-.TH "JEMALLOC" "3" "03/06/2013" "jemalloc 3.3.1-0-g9ef9d9e8c271" "User Manual"
+.TH "JEMALLOC" "3" "06/02/2013" "jemalloc 3.4.0-0-g0ed518e5dab7" "User Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -31,7 +31,7 @@
 jemalloc \- general purpose memory allocation functions
 .SH "LIBRARY"
 .PP
-This manual describes jemalloc 3\&.3\&.1\-0\-g9ef9d9e8c271cdf14f664b871a8f98c827714784\&. More information can be found at the
+This manual describes jemalloc 3\&.4\&.0\-0\-g0ed518e5dab789ad2171bb38977a8927e2a26775\&. More information can be found at the
 \m[blue]\fBjemalloc website\fR\m[]\&\s-2\u[1]\d\s+2\&.
 .SH "SYNOPSIS"
 .sp
@@ -376,7 +376,19 @@ Once, when the first call is made to one of the memory allocation routines, the
 The string pointed to by the global variable
 \fImalloc_conf\fR, the \(lqname\(rq of the file referenced by the symbolic link named
 /etc/malloc\&.conf, and the value of the environment variable
-\fBMALLOC_CONF\fR, will be interpreted, in that order, from left to right as options\&.
+\fBMALLOC_CONF\fR, will be interpreted, in that order, from left to right as options\&. Note that
+\fImalloc_conf\fR
+may be read before
+\fBmain\fR\fB\fR
+is entered, so the declaration of
+\fImalloc_conf\fR
+should specify an initializer that contains the final value to be read by jemalloc\&.
+\fImalloc_conf\fR
+is a compile\-time setting, whereas
+/etc/malloc\&.conf
+and
+\fBMALLOC_CONF\fR
+can be safely set any time prior to program invocation\&.
 .PP
 An options string is a comma\-separated list of option:value pairs\&. There is one key corresponding to each
 "opt\&.*"
diff --git a/src/rt/jemalloc/doc/jemalloc.xml.in b/src/rt/jemalloc/doc/jemalloc.xml.in
index 09305801bab..abd5e6fcd0f 100644
--- a/src/rt/jemalloc/doc/jemalloc.xml.in
+++ b/src/rt/jemalloc/doc/jemalloc.xml.in
@@ -432,7 +432,14 @@ for (i = 0; i < nbins; i++) {
     referenced by the symbolic link named <filename
     class="symlink">/etc/malloc.conf</filename>, and the value of the
     environment variable <envar>MALLOC_CONF</envar>, will be interpreted, in
-    that order, from left to right as options.</para>
+    that order, from left to right as options.  Note that
+    <varname>malloc_conf</varname> may be read before
+    <function>main<parameter/></function> is entered, so the declaration of
+    <varname>malloc_conf</varname> should specify an initializer that contains
+    the final value to be read by jemalloc.  <varname>malloc_conf</varname> is
+    a compile-time setting, whereas <filename
+    class="symlink">/etc/malloc.conf</filename> and <envar>MALLOC_CONF</envar>
+    can be safely set any time prior to program invocation.</para>
 
     <para>An options string is a comma-separated list of option:value pairs.
     There is one key corresponding to each <link