On 29 August 2014 04:05, Savolainen, Petri (NSN - FI/Espoo) < petri.savolai...@nsn.com> wrote:
> > > > -----Original Message----- > > From: lng-odp-boun...@lists.linaro.org [mailto:lng-odp- > > boun...@lists.linaro.org] On Behalf Of ext Mike Holmes > > Sent: Thursday, August 28, 2014 11:54 PM > > To: lng-odp@lists.linaro.org > > Subject: [lng-odp] [PATCH] odp_shared_memory.h: Document odp_shm_reserve > > > > Signed-off-by: Mike Holmes <mike.hol...@linaro.org> > > --- > > platform/linux-generic/include/api/odp_shared_memory.h | 5 ++++- > > 1 file changed, 4 insertions(+), 1 deletion(-) > > > > diff --git a/platform/linux-generic/include/api/odp_shared_memory.h > > b/platform/linux-generic/include/api/odp_shared_memory.h > > index 8ac8847..d75b179 100644 > > --- a/platform/linux-generic/include/api/odp_shared_memory.h > > +++ b/platform/linux-generic/include/api/odp_shared_memory.h > > @@ -21,7 +21,7 @@ extern "C" { > > > > #include <odp_std_types.h> > > > > -/** Maximum shared memory block name lenght in chars */ > > +/** Maximum shared memory block name length in chars */ > > #define ODP_SHM_NAME_LEN 32 > > > > > > @@ -33,6 +33,9 @@ extern "C" { > > * @param align Block alignment in bytes > > * > > * @return Pointer to the reserved block, or NULL > > + * > > + * @note The same block name cannot be reused. > > + * @note There is no way to unreserve a named block > > I think there will be a odp_shm_release call. So I'd not put that last > note there...otherwise half of the current API should be noted about > missing features. > The problem I face is that this is the API as it stands, and we don't have any roadmap that says the symmetry will be added by 1.0, we need one. It comes into focus right now that the unit tests are running into it.The test cases either have to prove an API that does not exist or up date the docs to match reality and test against that. I feel the best approach rather than add todo allover is to actually document reality, prove it with the unit tests, and then update the code/docs/unit tests as we make progress. > > -Petri > > > */ > > void *odp_shm_reserve(const char *name, uint64_t size, uint64_t align); > > > > -- > > 1.9.1 > > > > > > _______________________________________________ > > lng-odp mailing list > > lng-odp@lists.linaro.org > > http://lists.linaro.org/mailman/listinfo/lng-odp > -- *Mike Holmes* Linaro Technical Manager / Lead LNG - ODP
_______________________________________________ lng-odp mailing list lng-odp@lists.linaro.org http://lists.linaro.org/mailman/listinfo/lng-odp
