Maybe write the commit message something like this:
types: factor platform definitions into a common file

Elaborate more why we want this in the commit message itself

On 2014-11-12 11:32, Bill Fischofer wrote:
> Signed-off-by: Bill Fischofer <[email protected]>
> ---
>  platform/linux-generic/Makefile.am                 |  1 +
>  platform/linux-generic/include/api/odp_buffer.h    |  9 +---
>  .../linux-generic/include/api/odp_buffer_pool.h    |  5 +-
>  platform/linux-generic/include/api/odp_packet.h    | 30 -----------
>  platform/linux-generic/include/api/odp_packet_io.h | 12 +----
>  platform/linux-generic/include/api/odp_typedefs.h  | 63 
> ++++++++++++++++++++++

should be odp_types.h

>  6 files changed, 67 insertions(+), 53 deletions(-)
>  create mode 100644 platform/linux-generic/include/api/odp_typedefs.h
> 

[...]

> diff --git a/platform/linux-generic/include/api/odp_typedefs.h 
> b/platform/linux-generic/include/api/odp_typedefs.h
> new file mode 100644
> index 0000000..af74980
> --- /dev/null
> +++ b/platform/linux-generic/include/api/odp_typedefs.h
> @@ -0,0 +1,63 @@
> +/* Copyright (c) 2014, Linaro Limited
> + * All rights reserved.
> + *
> + * SPDX-License-Identifier:     BSD-3-Clause
> + */
> +
> +
> +/**
> + * @file
> + *
> + * @par ODP implementation typedefs

Wrong format, should be like this:

/**
  * @file
  * Short description
  * Longer description
  */

Short description should say "ODP implementation types"
because there are more than only typedefs in there.

> + * This file contains all of the implementation-defined typedefs for

typedefs to types

> + * ODP abstract types.  Having this in one file means that other ODP

types to definitions

Remove one space after the full stop.

> + * API files are implementation-independent and avoids circular
> + * dependencies for files that refer to types managed by other
> + * components.

Why rap at 68 chars and not 80?

> + */
> +
> +#ifndef ODP_TYPEDEFS_H_
> +#define ODP_TYPEDEFS_H_

need to specify some module for this as well maybe ODP PLATFORM SPECIFIC
or should they go into ODP SYSTEM?


Cheers,
Anders

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

Reply via email to