| Message ID | 1470319711-17957-1-git-send-email-mike.holmes@linaro.org |
|---|---|
| State | New |
| Headers | show |
On 4 August 2016 at 16:08, Mike Holmes <mike.holmes@linaro.org> wrote: > Promote coding style that reduces the chance of collisions with > applications. > > Signed-off-by: Mike Holmes <mike.holmes@linaro.org> > --- > doc/implementers-guide/implementers-guide.adoc | 7 +++++++ > 1 file changed, 7 insertions(+) > > diff --git a/doc/implementers-guide/implementers-guide.adoc b/doc/implementers-guide/implementers-guide.adoc > index 5c0e864..829f316 100644 > --- a/doc/implementers-guide/implementers-guide.adoc > +++ b/doc/implementers-guide/implementers-guide.adoc > @@ -182,6 +182,13 @@ recommended that other implementations follow the same schema > (*odp-<implementation name>*) to make the representation of the ODP > implementations uniform in a distribution. > > +== ODP internal function naming recommendations > +When symbols are required that may leak into the external API definition they > +should be prefixed _odp to reduce the chance of a name collision. > + > +Whenever possible internal functions should be static to reduce link time issues Should it be this line break between the last word ("issues") and the dot (".") ? Christophe. > +. > + > [[validation]] > == The Validation Suite > ODP provides a comprehensive set of API validation tests that are intended to be > -- > 2.7.4 >
On 4 August 2016 at 10:11, Christophe Milard <christophe.milard@linaro.org> wrote: > On 4 August 2016 at 16:08, Mike Holmes <mike.holmes@linaro.org> wrote: > > Promote coding style that reduces the chance of collisions with > > applications. > > > > Signed-off-by: Mike Holmes <mike.holmes@linaro.org> > > --- > > doc/implementers-guide/implementers-guide.adoc | 7 +++++++ > > 1 file changed, 7 insertions(+) > > > > diff --git a/doc/implementers-guide/implementers-guide.adoc > b/doc/implementers-guide/implementers-guide.adoc > > index 5c0e864..829f316 100644 > > --- a/doc/implementers-guide/implementers-guide.adoc > > +++ b/doc/implementers-guide/implementers-guide.adoc > > @@ -182,6 +182,13 @@ recommended that other implementations follow the > same schema > > (*odp-<implementation name>*) to make the representation of the ODP > > implementations uniform in a distribution. > > > > +== ODP internal function naming recommendations > > +When symbols are required that may leak into the external API > definition they > > +should be prefixed _odp to reduce the chance of a name collision. > > + > > +Whenever possible internal functions should be static to reduce link > time issues > > Should it be this line break between the last word ("issues") and the > dot (".") ? > yes or it is > 80 chars :) > > Christophe. > > +. > > + > > [[validation]] > > == The Validation Suite > > ODP provides a comprehensive set of API validation tests that are > intended to be > > -- > > 2.7.4 > > > -- Mike Holmes Technical Manager - Linaro Networking Group Linaro.org <http://www.linaro.org/> *│ *Open source software for ARM SoCs "Work should be fun and collaborative, the rest follows"
diff --git a/doc/implementers-guide/implementers-guide.adoc b/doc/implementers-guide/implementers-guide.adoc index 5c0e864..829f316 100644 --- a/doc/implementers-guide/implementers-guide.adoc +++ b/doc/implementers-guide/implementers-guide.adoc @@ -182,6 +182,13 @@ recommended that other implementations follow the same schema (*odp-<implementation name>*) to make the representation of the ODP implementations uniform in a distribution. +== ODP internal function naming recommendations +When symbols are required that may leak into the external API definition they +should be prefixed _odp to reduce the chance of a name collision. + +Whenever possible internal functions should be static to reduce link time issues +. + [[validation]] == The Validation Suite ODP provides a comprehensive set of API validation tests that are intended to be
Promote coding style that reduces the chance of collisions with applications. Signed-off-by: Mike Holmes <mike.holmes@linaro.org> --- doc/implementers-guide/implementers-guide.adoc | 7 +++++++ 1 file changed, 7 insertions(+) -- 2.7.4