| Message ID | 1436376229-26127-1-git-send-email-mike.holmes@linaro.org |
|---|---|
| State | Accepted |
| Commit | c0be213fbb1beb147b288beacdb40272e1d5cf31 |
| Headers | show |
On Wed, Jul 8, 2015 at 12:23 PM, Mike Holmes <mike.holmes@linaro.org> wrote: > Signed-off-by: Mike Holmes <mike.holmes@linaro.org> > Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> > --- > doc/api_guide_lines.dox | 10 ++++++++++ > 1 file changed, 10 insertions(+) > > diff --git a/doc/api_guide_lines.dox b/doc/api_guide_lines.dox > index f3f7799..c544afd 100644 > --- a/doc/api_guide_lines.dox > +++ b/doc/api_guide_lines.dox > @@ -100,6 +100,16 @@ Another case might be if a packet has a vlan flag set > Where possible returned information should be an enum if it reflects a > finite list of information. > In general get apis drop the actual tag "get" in the function name. > > +@subsection converter Converter Functions > +To maintain efficiency in fastpath code converter functions should expect > correct inputs with undefined results otherwise. > + > +@code > +static inline odp_foo_t _odp_foo_from_bar(odp_bar_t bar) > +{ > + return (odp_foo_t)bar; > +} > +@endcode > + > @subsection function_calls Function Calls > ODP APIs typically have prototypes of the form: > > -- > 2.1.4 > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > https://lists.linaro.org/mailman/listinfo/lng-odp >
Merged, Maxim. On 07/08/15 21:30, Bill Fischofer wrote: > > > On Wed, Jul 8, 2015 at 12:23 PM, Mike Holmes <mike.holmes@linaro.org > <mailto:mike.holmes@linaro.org>> wrote: > > Signed-off-by: Mike Holmes <mike.holmes@linaro.org > <mailto:mike.holmes@linaro.org>> > > > Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org > <mailto:bill.fischofer@linaro.org>> > > --- > doc/api_guide_lines.dox | 10 ++++++++++ > 1 file changed, 10 insertions(+) > > diff --git a/doc/api_guide_lines.dox b/doc/api_guide_lines.dox > index f3f7799..c544afd 100644 > --- a/doc/api_guide_lines.dox > +++ b/doc/api_guide_lines.dox > @@ -100,6 +100,16 @@ Another case might be if a packet has a vlan > flag set > Where possible returned information should be an enum if it > reflects a finite list of information. > In general get apis drop the actual tag "get" in the function name. > > +@subsection converter Converter Functions > +To maintain efficiency in fastpath code converter functions > should expect correct inputs with undefined results otherwise. > + > +@code > +static inline odp_foo_t _odp_foo_from_bar(odp_bar_t bar) > +{ > + return (odp_foo_t)bar; > +} > +@endcode > + > @subsection function_calls Function Calls > ODP APIs typically have prototypes of the form: > > -- > 2.1.4 > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org <mailto:lng-odp@lists.linaro.org> > https://lists.linaro.org/mailman/listinfo/lng-odp > > > > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > https://lists.linaro.org/mailman/listinfo/lng-odp
diff --git a/doc/api_guide_lines.dox b/doc/api_guide_lines.dox index f3f7799..c544afd 100644 --- a/doc/api_guide_lines.dox +++ b/doc/api_guide_lines.dox @@ -100,6 +100,16 @@ Another case might be if a packet has a vlan flag set Where possible returned information should be an enum if it reflects a finite list of information. In general get apis drop the actual tag "get" in the function name. +@subsection converter Converter Functions +To maintain efficiency in fastpath code converter functions should expect correct inputs with undefined results otherwise. + +@code +static inline odp_foo_t _odp_foo_from_bar(odp_bar_t bar) +{ + return (odp_foo_t)bar; +} +@endcode + @subsection function_calls Function Calls ODP APIs typically have prototypes of the form:
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> --- doc/api_guide_lines.dox | 10 ++++++++++ 1 file changed, 10 insertions(+)