First THREADED backport attempt, focusing on adding locks and making sure the API...

[platform/upstream/gstreamer.git] / docs / design / part-conventions.txt

diff --git a/docs/design/part-conventions.txt b/docs/design/part-conventions.txt
index da634b8..f2610a7 100644 (file)
--- a/docs/design/part-conventions.txt
+++ b/docs/design/part-conventions.txt
@@ -16,7 +16,7 @@ Function names
 --------------
 
 Within the context of a given object, functions defined in that object's header and/or source file will have their 
-object-specific prefix stripped.  For instance, gst_element_add_pad() would be referred to as simply _get_pad().  Note 
+object-specific prefix stripped.  For instance, gst_element_add_pad() would be referred to as simply _add_pad().  Note 
 that the trailing parentheses should always be present, but sometimes may not be.  A prefixing underscore (_) will 
 always tell you it's a function, however, regardless of the presence or absence of the trailing parentheses.
 
@@ -25,7 +25,59 @@ always tell you it's a function, however, regardless of the presence or absence
 
 Values and macros defined as enums and preprocessor macros will be referred to in all capitals, as per their 
 definition.  This includes object flags and element states, as well as general enums.  Examples are the states NULL, 
-READY, PLAYING, and PAUSED; the element flags DECOUPLED and USE_COTHREAD, and state return values SUCCESS, FAILURE, and 
+READY, PLAYING, and PAUSED; the element flags LOCKED_STATE , and state return values SUCCESS, FAILURE, and 
 ASYNC.  Where there is a prefix, as in the element flags, this is usually dropped, and implied.  Not however that 
 element flags should be cross-checked with the header, as there are currently two conventions in use: with and without 
 _FLAGS_ in the middle.
+
+FIXME: check flags for consistency.
+
+Drawing conventions
+===================
+
+When drawing pictures the folowing conventions apply:
+
+objects
+-------
+
+Objects are drawn with a box like
+  +------+
+  |      |
+  +------+
+  
+
+pointers
+--------
+
+a pointer to an object.
+      +-----+
+ *--->|     |
+      +-----+
+
+an invalid pointer, this is a pointer that should not be used.
+
+ *-//->
+
+
+elements
+--------
+
+  +----------+
+  | name     |
+ sink       src
+  +----------+
+
+pad links
+---------
+
+  -----+    +---
+       |    |
+      src--sink
+  -----+    +---
+
+
+
+
+
+
+