From: Sharvil Nanavati <sharvil@google.com>
Date: Wed, 8 Apr 2015 06:10:59 +0000 (-0700)
Subject: Add a 'Bluedroid conventions' section to the style guide.
X-Git-Tag: android-x86-7.1-r1~1245^2~16
X-Git-Url: http://git.osdn.net/view?a=commitdiff_plain;h=de6ac863a8c747628536bc15ac58d08aa01745b5;p=android-x86%2Fsystem-bt.git

Add a 'Bluedroid conventions' section to the style guide.

Also introduce a memory management section underneath 'Bluedroid
conventions' that describes common ownership semantics.

Change-Id: I9f1f148437fe21788618bcdc884b2eea5cbff141
---

diff --git a/doc/style_guide.md b/doc/style_guide.md
index b0e6835b7..d62d2902e 100644
--- a/doc/style_guide.md
+++ b/doc/style_guide.md
@@ -152,6 +152,22 @@ compile-time checks.
 Use booleans to represent boolean state, instead of a set of masks into an
 integer. It's more transparent and readable, and less error prone.
 
+## Bluedroid conventions
+This section describes coding conventions that are specific to Bluedroid.
+Whereas the _Language_ section describes the use of language features, this
+section describes idioms, best practices, and conventions that are independent
+of language features.
+
+### Memory management
+Use `osi_malloc` or `osi_calloc` to allocate bytes instead of plain `malloc`.
+Likewise, use `osi_free` over `free`. These wrapped functions provide additional
+lightweight memory bounds checks that can help track down memory errors.
+
+By convention, functions that contain `*_new` in their name are allocation
+routines and objects returned from those functions must be freed with the
+corresponding `*_free` function. For example, list objects returned from
+`list_new` should be freed with `list_free` and no other freeing routine.
+
 ## Header files
 In general, every source file (`.c` or `.cpp`) in a `src/` directory should
 have a corresponding header (`.h`) in the `include/` directory.