I'd do this in api-next branch to avoid conflicts between api-next and master. 
Api-next is currently modifying config.h. See another comment under, otherwise 
OK.


> -----Original Message-----
> From: lng-odp [mailto:[email protected]] On Behalf Of
> EXT Mike Holmes
> Sent: Tuesday, September 15, 2015 7:48 PM
> To: [email protected]
> Subject: [lng-odp] [PATCH] api: split documentation from definitions
> 
> Defines in config.h should be defined by the platform appropriately and
> then possibly be exposed by APIs.
> Start the clean up process by moving the API Doxygen documentation away
> from the per platform definition.
> 
> Signed-off-by: Mike Holmes <[email protected]>
> ---
>  include/odp/api/config.h                    | 30 ++++++++++++++-------
> --------
>  platform/linux-generic/include/odp/config.h | 17 +++++++++++++++-
>  2 files changed, 31 insertions(+), 16 deletions(-)
> 
> diff --git a/include/odp/api/config.h b/include/odp/api/config.h
> index 302eaf5..40789a1 100644
> --- a/include/odp/api/config.h
> +++ b/include/odp/api/config.h
> @@ -24,52 +24,53 @@ extern "C" {
>   */
> 
>  /**
> + * @def ODP_CONFIG_MAX_THREADS
>   * Maximum number of threads
>   */
> -#define ODP_CONFIG_MAX_THREADS  128
> 
>  /**
> + * @def ODP_CONFIG_POOLS
>   * Maximum number of pools
>   */
> -#define ODP_CONFIG_POOLS        16
> 
>  /**
> + * @def ODP_CONFIG_QUEUES
>   * Maximum number of queues
>   */
> -#define ODP_CONFIG_QUEUES       1024
> 
>  /**
> + * @def ODP_CONFIG_SCHED_PRIOS
>   * Number of scheduling priorities
>   */
> -#define ODP_CONFIG_SCHED_PRIOS  8
> 
>  /**
> + * @def ODP_CONFIG_SCHED_GRPS
>   * Number of scheduling groups
>   */
> -#define ODP_CONFIG_SCHED_GRPS  16
> 
>  /**
> + * @def ODP_CONFIG_PKTIO_ENTRIES
>   * Maximum number of packet IO resources
>   */
> -#define ODP_CONFIG_PKTIO_ENTRIES 64
> 
>  /**
> + * @def ODP_CONFIG_BUFFER_ALIGN_MIN
>   * Minimum buffer alignment
>   *
>   * This defines the minimum supported buffer alignment. Requests for
> values
>   * below this will be rounded up to this value.
>   */
> -#define ODP_CONFIG_BUFFER_ALIGN_MIN 16
> 
>  /**
> + * @def ODP_CONFIG_BUFFER_ALIGN_MAX
>   * Maximum buffer alignment
>   *
>   * This defines the maximum supported buffer alignment. Requests for
> values
>   * above this will fail.
>   */
> -#define ODP_CONFIG_BUFFER_ALIGN_MAX (4*1024)
> 
>  /**
> + * @def ODP_CONFIG_PACKET_HEADROOM
>   * Default packet headroom
>   *
>   * This defines the minimum number of headroom bytes that newly
> created packets
> @@ -81,9 +82,9 @@ extern "C" {

----

>   * The default value (66) allows a 1500-byte packet to be received
> into a single
>   * segment with Ethernet offset alignment and room for some header
> expansion.

----

This chunk is linux-generic specific comment and should be now moved into 
linux-generic/config.h

-Petri

_______________________________________________
lng-odp mailing list
[email protected]
https://lists.linaro.org/mailman/listinfo/lng-odp

Reply via email to