aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorseanbright <seanbright@f38db490-d61c-443f-a65b-d21fe96a405b>2008-08-03 16:14:14 +0000
committerseanbright <seanbright@f38db490-d61c-443f-a65b-d21fe96a405b>2008-08-03 16:14:14 +0000
commitd4ec4c4c3a9e788c04513298ae06efa0d9ebbfce (patch)
tree29c91d891c8a34d1f8d9c00a25db68301ed02e6f /doc
parent05e481bb17d9ebf457dbd049f6804d49a95e7d2a (diff)
Merge in changes that allow Asterisk to be built against the Hoard
memory allocator. See doc/hoard.txt for more details. git-svn-id: http://svn.digium.com/svn/asterisk/trunk@135405 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'doc')
-rw-r--r--doc/hoard.txt38
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/hoard.txt b/doc/hoard.txt
new file mode 100644
index 000000000..97be042b0
--- /dev/null
+++ b/doc/hoard.txt
@@ -0,0 +1,38 @@
+Using the Hoard Memory Allocator with Asterisk
+==============================================
+
+1) Install the Hoard Memory Allocator
+
+ Download Hoard from http://www.hoard.org/ either via a package or the source
+ tarball.
+
+ If downloading the source, unpack the tarball and follow the instructions in
+ the README file to build libhoard for your platform.
+
+2) Configure asterisk
+
+ Run ./configure in the root of the asterisk source directory, passing the
+ --with-hoard option specifying the location of the libhoard shared library.
+
+ For example:
+
+ ./configure --with-hoard=/usr/src/hoard-371/src/
+
+ Note that we don't specify the full path to libhoard.so, just the directory
+ where it resides.
+
+3) Enable Hoard in menuselect
+
+ Run 'make menuselect' in the root of the asterisk source distribution. Under
+ 'Compiler Flags' select the 'USE_HOARD_ALLOCATOR' option. If the option is
+ not available (shows up with XXX next to it) this means that configure was
+ not able to find libhoard.so. Check that the path you passed to the
+ --with-hoard option is correct. Re-run ./configure with the correct option
+ and then repeat step 3.
+
+4) Make and install asterisk
+
+ Run the standard build commands:
+
+ # make
+ # make install