[SCM] Samba Shared Repository - branch master updated - release-4-0-0alpha7-642-g3f81649

[Volker Lendecke]

The branch, master has been updated
       via  3f81649b8dcadb3bd424f41d803dbd59f770b9ba (commit)
       via  2ce70d4f5a30973b4cc083dbbb38b519007a31bd (commit)
       via  02662d56c64f367bffa2febba9a396c15454cfdb (commit)
      from  27944ed7452207ef3c686ff6bcd9c4e1cb7f36d8 (commit)

http://gitweb.samba.org/?p=samba.git;a=shortlog;h=master


- Log -----------------------------------------------------------------
commit 3f81649b8dcadb3bd424f41d803dbd59f770b9ba
Author: Volker Lendecke <vl at samba.org>
Date:   Sat Mar 21 20:02:50 2009 +0100

    Document TALLOC_FREE()

commit 2ce70d4f5a30973b4cc083dbbb38b519007a31bd
Author: Volker Lendecke <vl at samba.org>
Date:   Sat Mar 21 20:02:42 2009 +0100

    Document _talloc

commit 02662d56c64f367bffa2febba9a396c15454cfdb
Author: Volker Lendecke <vl at samba.org>
Date:   Sat Mar 21 20:02:19 2009 +0100

    Add a talloc_internal "module"

-----------------------------------------------------------------------

Summary of changes:
 lib/talloc/talloc.h |   30 +++++++++++++++++++++++++++++-
 1 files changed, 29 insertions(+), 1 deletions(-)


Changeset truncated at 500 lines:

diff --git a/lib/talloc/talloc.h b/lib/talloc/talloc.h
index e44d924..d103d6f 100644
--- a/lib/talloc/talloc.h
+++ b/lib/talloc/talloc.h
@@ -125,6 +125,15 @@
  */
 
 /**
+ * \defgroup talloc_internal Internal routines
+ *
+ * To achieve type-safety, talloc.h defines a lot of macros with type
+ * casts. These macros define the user interface to the internal routines you
+ * find here. You should not really use these routines directly but go through
+ * the external API.
+ */
+
+/**
  * \defgroup talloc_undoc Default group of undocumented stuff
  *
  * This should be empty...
@@ -624,9 +633,28 @@ typedef void TALLOC_CTX;
 #define talloc_append_string(c, s, a) (s?talloc_strdup_append(s,a):talloc_strdup(c, a))
 #endif
 
+/**
+ * \def TALLOC_FREE(ctx)
+ * \brief talloc_free a chunk and NULL out the pointer
+ * \param ctx The chunk to be freed
+ * \ingroup talloc_basic
+ *
+ * TALLOC_FREE() frees a pointer and sets it to NULL. Use this if you want
+ * immediate feedback (i.e. crash) if you use a pointer after having free'ed
+ * it.
+ */
 #define TALLOC_FREE(ctx) do { talloc_free(ctx); ctx=NULL; } while(0)
 
-/* The following definitions come from talloc.c  */
+/**
+ * \brief Allocate untyped, unnamed memory
+ * \param context The talloc context to hang the result off
+ * \param size Number of char's that you want to allocate
+ * \return The allocated memory chunk
+ * \ingroup talloc_internal
+ *
+ * Essentially the same as talloc_size() without setting the chunk name to the
+ * current file/line number.
+ */
 void *_talloc(const void *context, size_t size);
 
 /**


-- 
Samba Shared Repository