Changeset 1286893

Timestamp:

Mar 7, 2010, 11:50:32 PM (15 years ago)

Author:

Anders Kaseorg <andersk@mit.edu>

Branches:

master, release-1.10, release-1.6, release-1.7, release-1.8, release-1.9

Children:

2ee9e8d

Parents:

f8074e9

git-author:

Anders Kaseorg <andersk@mit.edu> (03/07/10 23:29:10)

git-committer:

Anders Kaseorg <andersk@mit.edu> (03/07/10 23:50:32)

Message:

Document the init/cleanup vs. new/delete naming conventions.

Signed-off-by: Anders Kaseorg <andersk@mit.edu>
Reviewed-by: Nelson Elhage <nelhage@mit.edu>

File:

• doc/code.txt (modified) (1 diff)

doc/code.txt

@@ -183 +183 @@
 -------------------------------
 
-        There are no hard rules for memory allocation.  In general I
-        have the caller allocate memory for objects themselves and any
-        memory the object creates gets freed with object_free().
+        Functions for creating and destroying objects should be named
+        according to the following conventions:
+
+        owl_*_init: Takes a pointer to a caller-allocated struct, and
+                creates an object there.
+        owl_*_cleanup: Takes a pointer, and destroys the object there,
+                expecting the caller to free the struct.
+
+        owl_*_new: Allocates a struct, creates an object there, and
+                returns a pointer.
+        owl_*_delete: Takes a pointer, destroys the object, and frees
+                the struct.
+
         Functions should document if the caller needs to free
         something, and this should be the exception to the rule.