| Message ID | 1417448157-32769-1-git-send-email-mike.holmes@linaro.org |
|---|---|
| State | Accepted |
| Headers | show |
ping On 1 December 2014 at 10:35, Mike Holmes <mike.holmes@linaro.org> wrote: > Signed-off-by: Mike Holmes <mike.holmes@linaro.org> > --- > api_guide_lines.dox | 5 +++++ > 1 file changed, 5 insertions(+) > > diff --git a/api_guide_lines.dox b/api_guide_lines.dox > index be23e9a..4cfe088 100644 > --- a/api_guide_lines.dox > +++ b/api_guide_lines.dox > @@ -144,6 +144,11 @@ The values !0 = true, 0 = false are used for this > purpose. > Pass indications are integers (int) and SHOULD also be used for APIs that > return a simple success/failure indication to the caller. > In this case the return value 0 indicates success while non-zero > (typically -1) indicates failure and errno is set to a reason code that > indicates the nature of the failure. > > +@subsection odp_internal Internal APIs > +When an interface is defined in a header file and is intended to to be > reused internally it will follow these rules:- > +- Be prefixed with an underscore "_". > +- All the required definitions for the API are to use an underscore, this > includes MACROS, typedefs, enums and function names. > + > @section implementation Implementation Considerations > To support application portability and preserve implementation > flexibility, ODP APIs MUST be designed with several guiding principles in > mind. > > -- > 2.1.0 > >
On 12/01/2014 05:35 PM, Mike Holmes wrote: > Signed-off-by: Mike Holmes <mike.holmes@linaro.org> > --- > api_guide_lines.dox | 5 +++++ > 1 file changed, 5 insertions(+) > > diff --git a/api_guide_lines.dox b/api_guide_lines.dox > index be23e9a..4cfe088 100644 > --- a/api_guide_lines.dox > +++ b/api_guide_lines.dox > @@ -144,6 +144,11 @@ The values !0 = true, 0 = false are used for this purpose. > Pass indications are integers (int) and SHOULD also be used for APIs that return a simple success/failure indication to the caller. > In this case the return value 0 indicates success while non-zero (typically -1) indicates failure and errno is set to a reason code that indicates the nature of the failure. > > +@subsection odp_internal Internal APIs > +When an interface is defined in a header file and is intended to to be reused internally it will follow these rules:- > +- Be prefixed with an underscore "_". > +- All the required definitions for the API are to use an underscore, this includes MACROS, typedefs, enums and function names. > + > @section implementation Implementation Considerations > To support application portability and preserve implementation flexibility, ODP APIs MUST be designed with several guiding principles in mind. > Reviewed-by: Taras Kondratiuk <taras.kondratiuk@linaro.org>
On 2014-12-01 10:35, Mike Holmes wrote:
> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
Applied.
Cheers,
Anders
diff --git a/api_guide_lines.dox b/api_guide_lines.dox index be23e9a..4cfe088 100644 --- a/api_guide_lines.dox +++ b/api_guide_lines.dox @@ -144,6 +144,11 @@ The values !0 = true, 0 = false are used for this purpose. Pass indications are integers (int) and SHOULD also be used for APIs that return a simple success/failure indication to the caller. In this case the return value 0 indicates success while non-zero (typically -1) indicates failure and errno is set to a reason code that indicates the nature of the failure. +@subsection odp_internal Internal APIs +When an interface is defined in a header file and is intended to to be reused internally it will follow these rules:- +- Be prefixed with an underscore "_". +- All the required definitions for the API are to use an underscore, this includes MACROS, typedefs, enums and function names. + @section implementation Implementation Considerations To support application portability and preserve implementation flexibility, ODP APIs MUST be designed with several guiding principles in mind.
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> --- api_guide_lines.dox | 5 +++++ 1 file changed, 5 insertions(+)