summaryrefslogtreecommitdiff
path: root/lib/talloc/doc
diff options
context:
space:
mode:
authorAndreas Schneider <asn@redhat.com>2010-01-17 11:25:02 +0100
committerAndrew Tridgell <tridge@samba.org>2010-02-08 11:04:59 +1100
commitfbd646a78356002d48795de61d5655029c4afcc2 (patch)
treeab1d2b4031dc6feb33acb63093bed528f56ad354 /lib/talloc/doc
parent328a6264a7b64dce9378bf9c9c2ab3aeb7d755c7 (diff)
downloadsamba-fbd646a78356002d48795de61d5655029c4afcc2.tar.gz
samba-fbd646a78356002d48795de61d5655029c4afcc2.tar.bz2
samba-fbd646a78356002d48795de61d5655029c4afcc2.zip
talloc: Documented talloc with doxygen.
Signed-off-by: Andrew Tridgell <tridge@samba.org>
Diffstat (limited to 'lib/talloc/doc')
-rw-r--r--lib/talloc/doc/mainpage.dox36
1 files changed, 36 insertions, 0 deletions
diff --git a/lib/talloc/doc/mainpage.dox b/lib/talloc/doc/mainpage.dox
new file mode 100644
index 0000000000..9629949124
--- /dev/null
+++ b/lib/talloc/doc/mainpage.dox
@@ -0,0 +1,36 @@
+/**
+ * @mainpage
+ *
+ * talloc is a hierarchical, reference counted memory pool system with
+ * destructors. It is the core memory allocator used in Samba.
+ *
+ * @section talloc_download Download
+ *
+ * You can download the latest releases of talloc from the
+ * <a href="http://samba.org/ftp/talloc" target="_blank">talloc directory</a>
+ * on the samba public source archive.
+ *
+ * @section talloc_bugs Discussion and bug reports
+ *
+ * talloc does not currently have its own mailing list or bug tracking system.
+ * For now, please use the
+ * <a href="https://lists.samba.org/mailman/listinfo/samba-technical" target="_blank">samba-technical</a>
+ * mailing list, and the
+ * <a href="http://bugzilla.samba.org/" target="_blank">Samba bugzilla</a>
+ * bug tracking system.
+ *
+ * @section talloc_devel Development
+ * You can download the latest code either via git or rsync.
+ *
+ * To fetch via git see the following guide:
+ *
+ * <a href="http://wiki.samba.org/index.php/Using_Git_for_Samba_Development" target="_blank">Using Git for Samba Development</a>
+ *
+ * Once you have cloned the tree switch to the master branch and cd into the
+ * lib/tevent directory.
+ *
+ * To fetch via rsync use this command:
+ *
+ * rsync -Pavz samba.org::ftp/unpacked/standalone_projects/lib/talloc .
+ *
+ */