This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "".
The branch, master has been updated via bf5116a224b8efa3bec8f36ab3035d83b83a72f9 (commit) via 20d4c58012d1bfed817eba53a09c4fa81e470dc7 (commit) from 3be1cd5a8ce1ff6b5b31cf41fbbf995bce5144d5 (commit)
Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below.
- Log ----------------------------------------------------------------- commit bf5116a224b8efa3bec8f36ab3035d83b83a72f9 Author: Petri Savolainen petri.savolainen@nokia.com Date: Fri Feb 1 15:34:04 2019 +0200
readme: update readme file information
Updated README file content and improved readability.
Main content changes are: * the new github link * github issues is the current bug tracking system * added licence information
Signed-off-by: Petri Savolainen petri.savolainen@nokia.com Reviewed-by: Bill Fischofer bill.fischofer@linaro.org
diff --git a/README b/README index b720de42..f20800aa 100644 --- a/README +++ b/README @@ -1,51 +1,54 @@ -Copyright (c) 2013-2018, Linaro Limited +Copyright (c) 2013-2019, Linaro Limited All rights reserved.
SPDX-License-Identifier: BSD-3-Clause
-OpenDataPlane (ODP) project source code. - http://www.opendataplane.org/ +OpenDataPlane (ODP) project web page: + http://www.opendataplane.org + +ODP project in GitHub: + https://github.com/OpenDataPlane
Main git repository: - https://github.com/Linaro/odp.git + https://github.com/OpenDataPlane/odp.git
- How to build: - Look in platform/linux-*/README for more detail how to build. - Directory test contains test applications for ODP API calls and features support. +How to build: + See DEPENDENCIES file about system requirements and dependencies to external + libraries/packages. It contains also some more detailed build instructions.
- For a list of build dependencies, read DEPENDENCIES. - In general you can build: - ./bootstrap - ./configure - Use 'make' to build ODP library and samples and 'make doxygen-doc' to build - ODP API documentation. 'make install' will copy all required headers and - binary files to the install directory. + Generally, ODP and test applications are built with these three steps: + ./bootstrap + ./configure + make
- Configure options: + See help on configure options: ./configure --help
- To execute all the testcases, assuming CUnit is installed for the validation tests: - ./bootstrap - ./configure + ODP header files and libraries can be installed with: + make install + + ODP API documentation can be built with (requires Doxygen): + make doxygen-doc + + Validation tests (requires CUnit) and other test applications can be + executed with: make check
- To generate the users guides: + Users guides can be generated with: ./bootstrap ./configure --enable-user-guides make
-Patches tracking system: - Patchwork: - http://patches.opendataplane.org/project/lng-odp/list/ - Github pull requests: - https://github.com/Linaro/odp/pulls +Licensing: + ODP project uses BSD-3-Clause license as the default license. See LICENSE + file for details.
Mailing list: lng-odp@lists.linaro.org
- Please read CONTRIBUTING file before submitting patches. - Email prefixes: - [PATCH] means patch is for odp.git +Contributing: + Please read CONTRIBUTING file before submitting patches. ODP project follows + Linux kernel coding style.
Bug tracking: - https://bugs.linaro.org/describecomponents.cgi?product=OpenDataPlane%20-%20l... + https://github.com/OpenDataPlane/odp/issues
commit 20d4c58012d1bfed817eba53a09c4fa81e470dc7 Author: Petri Savolainen petri.savolainen@nokia.com Date: Fri Feb 1 13:57:02 2019 +0200
api: spec: correct coding style issues
Clean checkpatch warnings that do not affect API signatures in all api/spec header files.
Signed-off-by: Petri Savolainen petri.savolainen@nokia.com Reviewed-by: Bill Fischofer bill.fischofer@linaro.org
diff --git a/include/odp/api/spec/align.h b/include/odp/api/spec/align.h index 7fe8b2b2..6e4ef0cd 100644 --- a/include/odp/api/spec/align.h +++ b/include/odp/api/spec/align.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */
- /** * @file * diff --git a/include/odp/api/spec/buffer.h b/include/odp/api/spec/buffer.h index 9e38854a..5ebf0ab2 100644 --- a/include/odp/api/spec/buffer.h +++ b/include/odp/api/spec/buffer.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */
- /** * @file * diff --git a/include/odp/api/spec/comp.h b/include/odp/api/spec/comp.h index e0271919..73c4bb9f 100644 --- a/include/odp/api/spec/comp.h +++ b/include/odp/api/spec/comp.h @@ -197,7 +197,6 @@ typedef struct odp_comp_hash_alg_capability_t { * Compression algorithm capabilities */ typedef struct odp_comp_alg_capability_t { - /** Maximum compression level supported by implementation of this * algorithm. Indicates number of compression levels supported by * implementation. Valid range from (1 ... max_level) @@ -248,10 +247,10 @@ typedef struct odp_comp_deflate_param { * level supported by the implementation. * * where, - * 0 - implemention default + * 0 - implementation default * - * 1 - fastest compression i.e. output produced at - * best possible speed at the expense of compression quality + * 1 - fastest compression i.e. output produced at + * best possible speed at the expense of compression quality * * max_level - High quality compression * @@ -456,12 +455,12 @@ int odp_comp_session_destroy(odp_comp_session_t session); /** * Synchronous packet compression operation * - * This operation does packet compression in synchronous mode. A successful operation - * returns the number of successfully processed input packets and updates the - * results in the corresponding output packets. Outputted packets contain - * compression results metadata (odp_comp_packet_result_t), which should be - * checked for operation status. Length of outputted data can be got from - * output_data_range.len. + * This operation does packet compression in synchronous mode. A successful + * operation returns the number of successfully processed input packets and + * updates the results in the corresponding output packets. Outputted packets + * contain compression results metadata (odp_comp_packet_result_t), which + * should be checked for operation status. Length of outputted data can be got + * from output_data_range.len. * * When hashing is configured along with compression operation the * result is appended at the end of the output data, output_data_range.len diff --git a/include/odp/api/spec/cpu.h b/include/odp/api/spec/cpu.h index f6a7e656..31e31fc5 100644 --- a/include/odp/api/spec/cpu.h +++ b/include/odp/api/spec/cpu.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */
- /** * @file * @@ -25,7 +24,6 @@ extern "C" { * @{ */
- /** * CPU identifier * diff --git a/include/odp/api/spec/cpumask.h b/include/odp/api/spec/cpumask.h index d2fe719c..a78fddbf 100644 --- a/include/odp/api/spec/cpumask.h +++ b/include/odp/api/spec/cpumask.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */
- /** * @file * diff --git a/include/odp/api/spec/crypto.h b/include/odp/api/spec/crypto.h index cfb2bc42..c57873ab 100644 --- a/include/odp/api/spec/crypto.h +++ b/include/odp/api/spec/crypto.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */
- /** * @file * diff --git a/include/odp/api/spec/event.h b/include/odp/api/spec/event.h index 162fd5a7..ec57193a 100644 --- a/include/odp/api/spec/event.h +++ b/include/odp/api/spec/event.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */
- /** * @file * diff --git a/include/odp/api/spec/hints.h b/include/odp/api/spec/hints.h index 816dcf3b..48a0f9a9 100644 --- a/include/odp/api/spec/hints.h +++ b/include/odp/api/spec/hints.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */
- /** * @file * @@ -66,12 +65,11 @@ extern "C" { */ #define odp_unlikely(x) __builtin_expect((x), 0)
- /* * __builtin_prefetch (const void *addr, rw, locality) * * rw 0..1 (0: read, 1: write) - * locality 0..3 (0: dont leave to cache, 3: leave on all cache levels) + * locality 0..3 (0: don't leave to cache, 3: leave on all cache levels) */
/** @@ -84,8 +82,6 @@ extern "C" { */ #define odp_prefetch_store(x) __builtin_prefetch((x), 1, 3)
- - #else
#define ODP_WEAK_SYMBOL @@ -99,7 +95,6 @@ extern "C" {
#endif
- /** * @} */ diff --git a/include/odp/api/spec/init.h b/include/odp/api/spec/init.h index c37af464..70249d13 100644 --- a/include/odp/api/spec/init.h +++ b/include/odp/api/spec/init.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */
- /** * @file * @@ -232,7 +231,6 @@ void odp_init_param_init(odp_init_t *param); * passing any required platform specific data. */
- /** * Global ODP initialization * @@ -288,7 +286,7 @@ int odp_init_global(odp_instance_t *instance, * @retval <0 on failure * * @warning The unwinding of HW resources to allow them to be reused without - * reseting the device is a complex task that the application is expected to + * resetting the device is a complex task that the application is expected to * coordinate. This api may have platform dependent implications. * * @see odp_init_global() @@ -328,7 +326,7 @@ int odp_init_local(odp_instance_t instance, odp_thread_type_t thr_type); * @retval <0 on failure * * @warning The unwinding of HW resources to allow them to be reused without - * reseting the device is a complex task that the application is expected + * resetting the device is a complex task that the application is expected * to coordinate. * * @see odp_init_local() diff --git a/include/odp/api/spec/packet.h b/include/odp/api/spec/packet.h index 3fd571a3..91eb6c65 100644 --- a/include/odp/api/spec/packet.h +++ b/include/odp/api/spec/packet.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */
- /** * @file * diff --git a/include/odp/api/spec/packet_flags.h b/include/odp/api/spec/packet_flags.h index 500ecc14..0e424396 100644 --- a/include/odp/api/spec/packet_flags.h +++ b/include/odp/api/spec/packet_flags.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */
- /** * @file * diff --git a/include/odp/api/spec/packet_io.h b/include/odp/api/spec/packet_io.h index d3e1d405..5d5ca2bc 100644 --- a/include/odp/api/spec/packet_io.h +++ b/include/odp/api/spec/packet_io.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */
- /** * @file * @@ -1224,10 +1223,18 @@ int odp_pktio_link_status(odp_pktio_t pktio); * Packet IO information */ typedef struct odp_pktio_info_t { - const char *name; /**< Packet IO device name */ - const char *drv_name; /**< Packet IO driver name (implementation specific) */ - odp_pool_t pool; /**< Packet pool */ - odp_pktio_param_t param; /**< Packet IO parameters */ + /** Packet IO device name */ + const char *name; + + /** Packet IO driver name (implementation specific) */ + const char *drv_name; + + /** Packet pool */ + odp_pool_t pool; + + /** Packet IO parameters */ + odp_pktio_param_t param; + } odp_pktio_info_t;
/** diff --git a/include/odp/api/spec/packet_io_stats.h b/include/odp/api/spec/packet_io_stats.h index a412c153..ea41e3a3 100644 --- a/include/odp/api/spec/packet_io_stats.h +++ b/include/odp/api/spec/packet_io_stats.h @@ -56,8 +56,8 @@ typedef struct odp_pktio_stats_t { uint64_t in_discards;
/** - * The sum for this interface of AlignmentErrors, FCSErrors, FrameTooLongs, - * InternalMacReceiveErrors. See ifInErrors in RFC 3635. + * The sum for this interface of AlignmentErrors, FCSErrors, + * FrameTooLongs, InternalMacReceiveErrors. See ifInErrors in RFC 3635. */ uint64_t in_errors;
diff --git a/include/odp/api/spec/pool.h b/include/odp/api/spec/pool.h index e6cd77c9..d4cf088f 100644 --- a/include/odp/api/spec/pool.h +++ b/include/odp/api/spec/pool.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */
- /** * @file * diff --git a/include/odp/api/spec/queue.h b/include/odp/api/spec/queue.h index 2f5e1230..605831c5 100644 --- a/include/odp/api/spec/queue.h +++ b/include/odp/api/spec/queue.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */
- /** * @file * diff --git a/include/odp/api/spec/random.h b/include/odp/api/spec/random.h index 11bf3302..516de536 100644 --- a/include/odp/api/spec/random.h +++ b/include/odp/api/spec/random.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */
- /** * @file * diff --git a/include/odp/api/spec/rwlock.h b/include/odp/api/spec/rwlock.h index 7924a50a..a5b1e48a 100644 --- a/include/odp/api/spec/rwlock.h +++ b/include/odp/api/spec/rwlock.h @@ -36,7 +36,6 @@ extern "C" { * ODP reader/writer lock */
- /** * Initialize a reader/writer lock. * diff --git a/include/odp/api/spec/schedule.h b/include/odp/api/spec/schedule.h index fa66f260..8591dda3 100644 --- a/include/odp/api/spec/schedule.h +++ b/include/odp/api/spec/schedule.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */
- /** * @file * diff --git a/include/odp/api/spec/shared_memory.h b/include/odp/api/spec/shared_memory.h index c18275cb..05c8de40 100644 --- a/include/odp/api/spec/shared_memory.h +++ b/include/odp/api/spec/shared_memory.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */
- /** * @file * diff --git a/include/odp/api/spec/std_types.h b/include/odp/api/spec/std_types.h index 083523a3..45753e81 100644 --- a/include/odp/api/spec/std_types.h +++ b/include/odp/api/spec/std_types.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */
- /** * @file * diff --git a/include/odp/api/spec/system_info.h b/include/odp/api/spec/system_info.h index e7fb570f..aebd3dfc 100644 --- a/include/odp/api/spec/system_info.h +++ b/include/odp/api/spec/system_info.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */
- /** * @file * diff --git a/include/odp/api/spec/thread.h b/include/odp/api/spec/thread.h index 54d4a00e..de6d78fb 100644 --- a/include/odp/api/spec/thread.h +++ b/include/odp/api/spec/thread.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */
- /** * @file * @@ -73,7 +72,6 @@ int odp_thread_count_max(void); */ odp_thread_type_t odp_thread_type(void);
- /** * @} */ diff --git a/include/odp/api/spec/ticketlock.h b/include/odp/api/spec/ticketlock.h index fd42355b..0d5d67a8 100644 --- a/include/odp/api/spec/ticketlock.h +++ b/include/odp/api/spec/ticketlock.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */
- /** * @file * @@ -44,7 +43,6 @@ extern "C" { */ void odp_ticketlock_init(odp_ticketlock_t *tklock);
- /** * Acquire ticket lock. * @@ -69,7 +67,6 @@ int odp_ticketlock_trylock(odp_ticketlock_t *tklock); */ void odp_ticketlock_unlock(odp_ticketlock_t *tklock);
- /** * Check if ticket lock is locked. * diff --git a/include/odp/api/spec/time.h b/include/odp/api/spec/time.h index dd49feef..f79f4a8a 100644 --- a/include/odp/api/spec/time.h +++ b/include/odp/api/spec/time.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */
- /** * @file * diff --git a/include/odp/api/spec/timer.h b/include/odp/api/spec/timer.h index c5c85514..ee314914 100644 --- a/include/odp/api/spec/timer.h +++ b/include/odp/api/spec/timer.h @@ -4,7 +4,6 @@ * SPDX-License-Identifier: BSD-3-Clause */
- /** * @file *
-----------------------------------------------------------------------
Summary of changes: README | 59 ++++++++++++++++++---------------- include/odp/api/spec/align.h | 1 - include/odp/api/spec/buffer.h | 1 - include/odp/api/spec/comp.h | 19 ++++++----- include/odp/api/spec/cpu.h | 2 -- include/odp/api/spec/cpumask.h | 1 - include/odp/api/spec/crypto.h | 1 - include/odp/api/spec/event.h | 1 - include/odp/api/spec/hints.h | 7 +--- include/odp/api/spec/init.h | 6 ++-- include/odp/api/spec/packet.h | 1 - include/odp/api/spec/packet_flags.h | 1 - include/odp/api/spec/packet_io.h | 17 +++++++--- include/odp/api/spec/packet_io_stats.h | 4 +-- include/odp/api/spec/pool.h | 1 - include/odp/api/spec/queue.h | 1 - include/odp/api/spec/random.h | 1 - include/odp/api/spec/rwlock.h | 1 - include/odp/api/spec/schedule.h | 1 - include/odp/api/spec/shared_memory.h | 1 - include/odp/api/spec/std_types.h | 1 - include/odp/api/spec/system_info.h | 1 - include/odp/api/spec/thread.h | 2 -- include/odp/api/spec/ticketlock.h | 3 -- include/odp/api/spec/time.h | 1 - include/odp/api/spec/timer.h | 1 - 26 files changed, 57 insertions(+), 79 deletions(-)
hooks/post-receive