| Message ID | 1422045030-15887-3-git-send-email-anders.roxell@linaro.org |
|---|---|
| State | Accepted |
| Commit | b4fd80a4c7845e61839d95091b53f535fae625fb |
| Headers | show |
On 23 January 2015 at 15:30, Anders Roxell <anders.roxell@linaro.org> wrote: > Cleanup a doxygen warning > > Signed-off-by: Anders Roxell <anders.roxell@linaro.org> > Reviewed-by: Robbie King <robking@cisco.com> --- > platform/linux-generic/include/api/odp_cpumask.h | 1 + > 1 file changed, 1 insertion(+) > > diff --git a/platform/linux-generic/include/api/odp_cpumask.h > b/platform/linux-generic/include/api/odp_cpumask.h > index 7c1bb6d..998a8ff 100644 > --- a/platform/linux-generic/include/api/odp_cpumask.h > +++ b/platform/linux-generic/include/api/odp_cpumask.h > @@ -134,6 +134,7 @@ void odp_cpumask_copy(odp_cpumask_t *dest, const > odp_cpumask_t *src); > /** > * Find first CPU that is set in the mask > * > + * @param mask is the mask to be searched > * @return cpu else -1 if no bits set in cpumask > I know this is not in the intent of this patch but should it be retval -1 whilst you are here ? This is a specific testable return value. > */ > int odp_cpumask_first(const odp_cpumask_t *mask); > -- > 2.1.4 > > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > http://lists.linaro.org/mailman/listinfo/lng-odp >
I am fixing this in my @return/@retval overview. On 27 January 2015 at 00:28, Mike Holmes <mike.holmes@linaro.org> wrote: > > > On 23 January 2015 at 15:30, Anders Roxell <anders.roxell@linaro.org> wrote: >> >> Cleanup a doxygen warning >> >> Signed-off-by: Anders Roxell <anders.roxell@linaro.org> >> Reviewed-by: Robbie King <robking@cisco.com> >> >> --- >> platform/linux-generic/include/api/odp_cpumask.h | 1 + >> 1 file changed, 1 insertion(+) >> >> diff --git a/platform/linux-generic/include/api/odp_cpumask.h >> b/platform/linux-generic/include/api/odp_cpumask.h >> index 7c1bb6d..998a8ff 100644 >> --- a/platform/linux-generic/include/api/odp_cpumask.h >> +++ b/platform/linux-generic/include/api/odp_cpumask.h >> @@ -134,6 +134,7 @@ void odp_cpumask_copy(odp_cpumask_t *dest, const >> odp_cpumask_t *src); >> /** >> * Find first CPU that is set in the mask >> * >> + * @param mask is the mask to be searched >> * @return cpu else -1 if no bits set in cpumask > > > I know this is not in the intent of this patch but should it be retval -1 > whilst you are here ? > This is a specific testable return value. > >> >> */ >> int odp_cpumask_first(const odp_cpumask_t *mask); >> -- >> 2.1.4 >> >> >> _______________________________________________ >> lng-odp mailing list >> lng-odp@lists.linaro.org >> http://lists.linaro.org/mailman/listinfo/lng-odp > > > > > -- > Mike Holmes > Linaro Sr Technical Manager > LNG - ODP > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > http://lists.linaro.org/mailman/listinfo/lng-odp >
On 23 January 2015 at 15:30, Anders Roxell <anders.roxell@linaro.org> wrote: > Cleanup a doxygen warning > > Signed-off-by: Anders Roxell <anders.roxell@linaro.org> > Reviewed-by: Robbie King <robking@cisco.com> > Reviewed-by: Mike Holmes <mike.holmes@linaro.org> > --- > platform/linux-generic/include/api/odp_cpumask.h | 1 + > 1 file changed, 1 insertion(+) > > diff --git a/platform/linux-generic/include/api/odp_cpumask.h > b/platform/linux-generic/include/api/odp_cpumask.h > index 7c1bb6d..998a8ff 100644 > --- a/platform/linux-generic/include/api/odp_cpumask.h > +++ b/platform/linux-generic/include/api/odp_cpumask.h > @@ -134,6 +134,7 @@ void odp_cpumask_copy(odp_cpumask_t *dest, const > odp_cpumask_t *src); > /** > * Find first CPU that is set in the mask > * > + * @param mask is the mask to be searched > * @return cpu else -1 if no bits set in cpumask > */ > int odp_cpumask_first(const odp_cpumask_t *mask); > -- > 2.1.4 > > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > http://lists.linaro.org/mailman/listinfo/lng-odp >
diff --git a/platform/linux-generic/include/api/odp_cpumask.h b/platform/linux-generic/include/api/odp_cpumask.h index 7c1bb6d..998a8ff 100644 --- a/platform/linux-generic/include/api/odp_cpumask.h +++ b/platform/linux-generic/include/api/odp_cpumask.h @@ -134,6 +134,7 @@ void odp_cpumask_copy(odp_cpumask_t *dest, const odp_cpumask_t *src); /** * Find first CPU that is set in the mask * + * @param mask is the mask to be searched * @return cpu else -1 if no bits set in cpumask */ int odp_cpumask_first(const odp_cpumask_t *mask);