summaryrefslogtreecommitdiff
path: root/CONVENTIONS
diff options
context:
space:
mode:
authorShawn O. Pearce <spearce@spearce.org>2008-10-31 18:23:01 -0700
committerShawn O. Pearce <spearce@spearce.org>2008-10-31 18:30:43 -0700
commit6533aadc21270052d8d05835b1e30d8b13a2f164 (patch)
treee9c9018f4b898a2be9aa0d053153cb7d8c8af22c /CONVENTIONS
parentde2220a48fcf7901432f8093d3223e65f4072ff7 (diff)
downloadlibgit2-6533aadc21270052d8d05835b1e30d8b13a2f164.tar.gz
Drop the _t suffix as it is a POSIX reserved namespace
Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
Diffstat (limited to 'CONVENTIONS')
-rw-r--r--CONVENTIONS10
1 files changed, 9 insertions, 1 deletions
diff --git a/CONVENTIONS b/CONVENTIONS
index 4b09c08ae..e3c672819 100644
--- a/CONVENTIONS
+++ b/CONVENTIONS
@@ -12,7 +12,15 @@ All #define macros start with 'GIT_'.
Type Definitions
----------------
-All types end in '_t'; for example git_oid_t or git_odb_t.
+Most types should be opaque, e.g.:
+
+----
+ typedef struct git_odb git_odb;
+----
+
+with allocation functions returning an "instance" created within
+the library, and not within the application. This allows the type
+to grow (or shrink) in size without rebuilding client code.
Public Exported Function Definitions