diff mbox

[API-NEXT,PATCHv3,2/2] api: config: add usage note about defines

Message ID 1446032376-4994-2-git-send-email-bill.fischofer@linaro.org
State New
Headers show

Commit Message

Bill Fischofer Oct. 28, 2015, 11:39 a.m. UTC
Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>
---
 include/odp/api/config.h | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

Comments

Bill Fischofer Oct. 28, 2015, 12:07 p.m. UTC | #1
The patch was rebased to the latest api-git as of an hour or so ago.  What
issue are you seeing?

On Wed, Oct 28, 2015 at 7:06 AM, Savolainen, Petri (Nokia - FI/Espoo) <
petri.savolainen@nokia.com> wrote:

>

>

> > -----Original Message-----

> > From: lng-odp [mailto:lng-odp-bounces@lists.linaro.org] On Behalf Of EXT

> > Bill Fischofer

> > Sent: Wednesday, October 28, 2015 1:40 PM

> > To: lng-odp@lists.linaro.org

> > Subject: [lng-odp] [API-NEXT PATCHv3 2/2] api: config: add usage note

> about

> > defines

> >

> > Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>

> > ---

> >  include/odp/api/config.h | 13 ++++++++-----

> >  1 file changed, 8 insertions(+), 5 deletions(-)

> >

> > diff --git a/include/odp/api/config.h b/include/odp/api/config.h

> > index ed27ed5..c9879d6 100644

> > --- a/include/odp/api/config.h

> > +++ b/include/odp/api/config.h

> > @@ -20,6 +20,14 @@ extern "C" {

> >

> >  /** @defgroup odp_config ODP CONFIG

> >   *  Platform-specific configuration limits.

> > + *

> > + * @note The API calls defined for ODP configuration limits are the

> > + * normative means of accessing platform-specific configuration limits.

> > + * Platforms MAY in addition include \#defines for these limits for

> > + * internal use in dimensioning arrays, however there is no guarantee

> > + * that applications using such \#defines will be portable across all

> > + * ODP implementations. Applications SHOULD expect that over time such

> > + * \#defines will be deprecated and removed.

> >   *  @{

> >   */

> >

> > @@ -43,11 +51,6 @@ int odp_config_queues(void);

> >  int odp_config_max_ordered_locks_per_queue(void);

> >

> >  /**

> > - * Maximum number of ordered locks per queue

> > - */

> > -#define ODP_CONFIG_MAX_ORDERED_LOCKS_PER_QUEUE  2

> > -

> > -/**

>

>

> Rebase error ?

>

>

> Again, there's no harm to merge these two patches into single one. Both

> modify the same API file anyway.

>

> -Petri

>

>

> >   * Number of scheduling priorities

> >   * @return The number of scheduling priorities supported by this

> platform

> >   */

> > --

> > 2.1.4

> >

> > _______________________________________________

> > lng-odp mailing list

> > lng-odp@lists.linaro.org

> > https://lists.linaro.org/mailman/listinfo/lng-odp

>
Bill Fischofer Oct. 28, 2015, 12:07 p.m. UTC | #2
Sorry, make that api-next.

On Wed, Oct 28, 2015 at 7:07 AM, Bill Fischofer <bill.fischofer@linaro.org>
wrote:

> The patch was rebased to the latest api-git as of an hour or so ago.  What

> issue are you seeing?

>

> On Wed, Oct 28, 2015 at 7:06 AM, Savolainen, Petri (Nokia - FI/Espoo) <

> petri.savolainen@nokia.com> wrote:

>

>>

>>

>> > -----Original Message-----

>> > From: lng-odp [mailto:lng-odp-bounces@lists.linaro.org] On Behalf Of

>> EXT

>> > Bill Fischofer

>> > Sent: Wednesday, October 28, 2015 1:40 PM

>> > To: lng-odp@lists.linaro.org

>> > Subject: [lng-odp] [API-NEXT PATCHv3 2/2] api: config: add usage note

>> about

>> > defines

>> >

>> > Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>

>> > ---

>> >  include/odp/api/config.h | 13 ++++++++-----

>> >  1 file changed, 8 insertions(+), 5 deletions(-)

>> >

>> > diff --git a/include/odp/api/config.h b/include/odp/api/config.h

>> > index ed27ed5..c9879d6 100644

>> > --- a/include/odp/api/config.h

>> > +++ b/include/odp/api/config.h

>> > @@ -20,6 +20,14 @@ extern "C" {

>> >

>> >  /** @defgroup odp_config ODP CONFIG

>> >   *  Platform-specific configuration limits.

>> > + *

>> > + * @note The API calls defined for ODP configuration limits are the

>> > + * normative means of accessing platform-specific configuration limits.

>> > + * Platforms MAY in addition include \#defines for these limits for

>> > + * internal use in dimensioning arrays, however there is no guarantee

>> > + * that applications using such \#defines will be portable across all

>> > + * ODP implementations. Applications SHOULD expect that over time such

>> > + * \#defines will be deprecated and removed.

>> >   *  @{

>> >   */

>> >

>> > @@ -43,11 +51,6 @@ int odp_config_queues(void);

>> >  int odp_config_max_ordered_locks_per_queue(void);

>> >

>> >  /**

>> > - * Maximum number of ordered locks per queue

>> > - */

>> > -#define ODP_CONFIG_MAX_ORDERED_LOCKS_PER_QUEUE  2

>> > -

>> > -/**

>>

>>

>> Rebase error ?

>>

>>

>> Again, there's no harm to merge these two patches into single one. Both

>> modify the same API file anyway.

>>

>> -Petri

>>

>>

>> >   * Number of scheduling priorities

>> >   * @return The number of scheduling priorities supported by this

>> platform

>> >   */

>> > --

>> > 2.1.4

>> >

>> > _______________________________________________

>> > lng-odp mailing list

>> > lng-odp@lists.linaro.org

>> > https://lists.linaro.org/mailman/listinfo/lng-odp

>>

>

>
Bill Fischofer Oct. 28, 2015, 12:25 p.m. UTC | #3
That was an oversight in the original patch which resulted in that symbol
showing up in the doc even after I took your suggestion to switch to
@ingroup.  It's defined in the linux-generic file, not the api file.  So
that change just deletes the duplicate definition.

On Wed, Oct 28, 2015 at 7:23 AM, Savolainen, Petri (Nokia - FI/Espoo) <
petri.savolainen@nokia.com> wrote:

> Deletes ODP_CONFIG_MAX_ORDERED_LOCKS_PER_QUEUE ??

>

>

>

>

>

> *From:* EXT Bill Fischofer [mailto:bill.fischofer@linaro.org]

> *Sent:* Wednesday, October 28, 2015 2:08 PM

> *To:* Savolainen, Petri (Nokia - FI/Espoo)

> *Cc:* lng-odp@lists.linaro.org

> *Subject:* Re: [lng-odp] [API-NEXT PATCHv3 2/2] api: config: add usage

> note about defines

>

>

>

> Sorry, make that api-next.

>

>

>

> On Wed, Oct 28, 2015 at 7:07 AM, Bill Fischofer <bill.fischofer@linaro.org>

> wrote:

>

> The patch was rebased to the latest api-git as of an hour or so ago.  What

> issue are you seeing?

>

>

>

> On Wed, Oct 28, 2015 at 7:06 AM, Savolainen, Petri (Nokia - FI/Espoo) <

> petri.savolainen@nokia.com> wrote:

>

>

>

> > -----Original Message-----

> > From: lng-odp [mailto:lng-odp-bounces@lists.linaro.org] On Behalf Of EXT

> > Bill Fischofer

> > Sent: Wednesday, October 28, 2015 1:40 PM

> > To: lng-odp@lists.linaro.org

> > Subject: [lng-odp] [API-NEXT PATCHv3 2/2] api: config: add usage note

> about

> > defines

> >

> > Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>

> > ---

> >  include/odp/api/config.h | 13 ++++++++-----

> >  1 file changed, 8 insertions(+), 5 deletions(-)

> >

> > diff --git a/include/odp/api/config.h b/include/odp/api/config.h

> > index ed27ed5..c9879d6 100644

> > --- a/include/odp/api/config.h

> > +++ b/include/odp/api/config.h

> > @@ -20,6 +20,14 @@ extern "C" {

> >

> >  /** @defgroup odp_config ODP CONFIG

> >   *  Platform-specific configuration limits.

> > + *

> > + * @note The API calls defined for ODP configuration limits are the

> > + * normative means of accessing platform-specific configuration limits.

> > + * Platforms MAY in addition include \#defines for these limits for

> > + * internal use in dimensioning arrays, however there is no guarantee

> > + * that applications using such \#defines will be portable across all

> > + * ODP implementations. Applications SHOULD expect that over time such

> > + * \#defines will be deprecated and removed.

> >   *  @{

> >   */

> >

> > @@ -43,11 +51,6 @@ int odp_config_queues(void);

> >  int odp_config_max_ordered_locks_per_queue(void);

> >

> >  /**

> > - * Maximum number of ordered locks per queue

> > - */

> > -#define ODP_CONFIG_MAX_ORDERED_LOCKS_PER_QUEUE  2

> > -

> > -/**

>

> Rebase error ?

>

>

> Again, there's no harm to merge these two patches into single one. Both

> modify the same API file anyway.

>

> -Petri

>

>

> >   * Number of scheduling priorities

> >   * @return The number of scheduling priorities supported by this

> platform

> >   */

> > --

> > 2.1.4

> >

> > _______________________________________________

> > lng-odp mailing list

> > lng-odp@lists.linaro.org

> > https://lists.linaro.org/mailman/listinfo/lng-odp

>

>

>

>

>
diff mbox

Patch

diff --git a/include/odp/api/config.h b/include/odp/api/config.h
index ed27ed5..c9879d6 100644
--- a/include/odp/api/config.h
+++ b/include/odp/api/config.h
@@ -20,6 +20,14 @@  extern "C" {
 
 /** @defgroup odp_config ODP CONFIG
  *  Platform-specific configuration limits.
+ *
+ * @note The API calls defined for ODP configuration limits are the
+ * normative means of accessing platform-specific configuration limits.
+ * Platforms MAY in addition include \#defines for these limits for
+ * internal use in dimensioning arrays, however there is no guarantee
+ * that applications using such \#defines will be portable across all
+ * ODP implementations. Applications SHOULD expect that over time such
+ * \#defines will be deprecated and removed.
  *  @{
  */
 
@@ -43,11 +51,6 @@  int odp_config_queues(void);
 int odp_config_max_ordered_locks_per_queue(void);
 
 /**
- * Maximum number of ordered locks per queue
- */
-#define ODP_CONFIG_MAX_ORDERED_LOCKS_PER_QUEUE  2
-
-/**
  * Number of scheduling priorities
  * @return The number of scheduling priorities supported by this platform
  */