[v2,1/1] api & linux-generic: fixing typos

Message ID 1507204806-24126-2-git-send-email-odpbot@yandex.ru
State New
Headers show
Series
  • api & linux-generic: fixing typos
Related show

Commit Message

Github ODP bot Oct. 5, 2017, noon
From: Mykyta Iziumtsev <mykyta.iziumtsev@linaro.org>


Signed-off-by: Mykyta Iziumtsev <mykyta.iziumtsev@linaro.org>

---
/** Email created from pull request 215 (MykytaI:fixing-typos)
 ** https://github.com/Linaro/odp/pull/215
 ** Patch: https://github.com/Linaro/odp/pull/215.patch
 ** Base sha: 52cfe7ba6d2541cf5ee464e46e91b2da5efe1497
 ** Merge commit sha: 15f371d667f5de257a7f87d952ed6478c9986ff2
 **/
 include/odp/api/spec/packet.h                                    | 4 ++--
 include/odp/api/spec/traffic_mngr.h                              | 6 +++---
 platform/linux-generic/doc/platform_specific.dox                 | 2 +-
 platform/linux-generic/include/odp/api/plat/traffic_mngr_types.h | 2 +-
 4 files changed, 7 insertions(+), 7 deletions(-)

Comments

Maxim Uvarov Oct. 5, 2017, 1:30 p.m. | #1
any patch which touch api spec has to be named:
api: and be considered for api-next branch first.

please split this patch on 2 patches (api: and linux-gen:)

Maxim.

On 10/05/17 15:00, Github ODP bot wrote:
> From: Mykyta Iziumtsev <mykyta.iziumtsev@linaro.org>

> 

> Signed-off-by: Mykyta Iziumtsev <mykyta.iziumtsev@linaro.org>

> ---

> /** Email created from pull request 215 (MykytaI:fixing-typos)

>  ** https://github.com/Linaro/odp/pull/215

>  ** Patch: https://github.com/Linaro/odp/pull/215.patch

>  ** Base sha: 52cfe7ba6d2541cf5ee464e46e91b2da5efe1497

>  ** Merge commit sha: 15f371d667f5de257a7f87d952ed6478c9986ff2

>  **/

>  include/odp/api/spec/packet.h                                    | 4 ++--

>  include/odp/api/spec/traffic_mngr.h                              | 6 +++---

>  platform/linux-generic/doc/platform_specific.dox                 | 2 +-

>  platform/linux-generic/include/odp/api/plat/traffic_mngr_types.h | 2 +-

>  4 files changed, 7 insertions(+), 7 deletions(-)

> 

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

> index 79d8773e9..fbac33cf7 100644

> --- a/include/odp/api/spec/packet.h

> +++ b/include/odp/api/spec/packet.h

> @@ -904,7 +904,7 @@ odp_packet_t odp_packet_ref_static(odp_packet_t pkt);

>   * dynamic references must not be mixed. Results are undefined if these

>   * restrictions are not observed.

>   *

> - * The packet handle 'pkt' may itself by a (dynamic) reference to a packet.

> + * The packet handle 'pkt' may itself be a (dynamic) reference to a packet.

>   *

>   * If the caller does not intend to modify either the packet or the new

>   * reference to it, odp_packet_ref_static() may be used to create

> @@ -931,7 +931,7 @@ odp_packet_t odp_packet_ref(odp_packet_t pkt, uint32_t offset);

>   * packet consists metadata and data of the 'hdr' packet, followed by the

>   * shared part of packet 'pkt'.

>   *

> - * The packet handle ('pkt') may itself by a (dynamic) reference to a packet,

> + * The packet handle ('pkt') may itself be a (dynamic) reference to a packet,

>   * but the header packet handle ('hdr') must be unique. Both packets must be

>   * have been allocated from the same pool and the handles must not refer to

>   * the same packet. Results are undefined if these restrictions are not

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

> index 3a748cef7..c9134e8e4 100644

> --- a/include/odp/api/spec/traffic_mngr.h

> +++ b/include/odp/api/spec/traffic_mngr.h

> @@ -75,7 +75,7 @@ extern "C" {

>  

>  /**

>   * @def ODP_TM_MAX_TM_QUEUES

> - * The largest number of tm_queues that can handled by any one TM system.

> + * The largest number of tm_queues that can be handled by any one TM system.

>   */

>  

>  /**

> @@ -97,7 +97,7 @@ extern "C" {

>  

>  /**

>   * @def ODP_TM_MIN_SHAPER_BW

> - * The largest amount of bandwidth that any shaper's peak or commit rate can

> + * The lowest amount of bandwidth that any shaper's peak or commit rate can

>   * be set to. It is in units of 1000 bytes/second.

>   */

>  

> @@ -143,7 +143,7 @@ extern "C" {

>  

>  /**

>   * @typedef odp_tm_node_t

> - * Each odp_tm_queue_t value is an opaque ODP handle representing a specific

> + * Each odp_tm_node_t value is an opaque ODP handle representing a specific

>   * tm node within a specific TM system.

>   */

>  

> diff --git a/platform/linux-generic/doc/platform_specific.dox b/platform/linux-generic/doc/platform_specific.dox

> index e116ec617..c26661484 100644

> --- a/platform/linux-generic/doc/platform_specific.dox

> +++ b/platform/linux-generic/doc/platform_specific.dox

> @@ -28,7 +28,7 @@

>   *			to odp_init_local() is actually fully defined by these

>   *			requirements: It has to be the value returned by the

>   *			unique call to odp_init_global() made by one single

> - *			acsendant of the current process.

> + *			ascendant of the current process.

>   */

>  

>  /**

> diff --git a/platform/linux-generic/include/odp/api/plat/traffic_mngr_types.h b/platform/linux-generic/include/odp/api/plat/traffic_mngr_types.h

> index f47a13f6f..be3926d46 100644

> --- a/platform/linux-generic/include/odp/api/plat/traffic_mngr_types.h

> +++ b/platform/linux-generic/include/odp/api/plat/traffic_mngr_types.h

> @@ -56,7 +56,7 @@ extern "C" {

>  #define ODP_TM_MAX_SCHED_WEIGHT  255

>  

>  /** The ODP_TM_MAX_TM_QUEUES constant is the largest number of tm_queues

> - * that can handled by any one TM system.

> + * that can be handled by any one TM system.

>   */

>  #define ODP_TM_MAX_TM_QUEUES  (16 * 1024 * 1024)

>  

>

Patch

diff --git a/include/odp/api/spec/packet.h b/include/odp/api/spec/packet.h
index 79d8773e9..fbac33cf7 100644
--- a/include/odp/api/spec/packet.h
+++ b/include/odp/api/spec/packet.h
@@ -904,7 +904,7 @@  odp_packet_t odp_packet_ref_static(odp_packet_t pkt);
  * dynamic references must not be mixed. Results are undefined if these
  * restrictions are not observed.
  *
- * The packet handle 'pkt' may itself by a (dynamic) reference to a packet.
+ * The packet handle 'pkt' may itself be a (dynamic) reference to a packet.
  *
  * If the caller does not intend to modify either the packet or the new
  * reference to it, odp_packet_ref_static() may be used to create
@@ -931,7 +931,7 @@  odp_packet_t odp_packet_ref(odp_packet_t pkt, uint32_t offset);
  * packet consists metadata and data of the 'hdr' packet, followed by the
  * shared part of packet 'pkt'.
  *
- * The packet handle ('pkt') may itself by a (dynamic) reference to a packet,
+ * The packet handle ('pkt') may itself be a (dynamic) reference to a packet,
  * but the header packet handle ('hdr') must be unique. Both packets must be
  * have been allocated from the same pool and the handles must not refer to
  * the same packet. Results are undefined if these restrictions are not
diff --git a/include/odp/api/spec/traffic_mngr.h b/include/odp/api/spec/traffic_mngr.h
index 3a748cef7..c9134e8e4 100644
--- a/include/odp/api/spec/traffic_mngr.h
+++ b/include/odp/api/spec/traffic_mngr.h
@@ -75,7 +75,7 @@  extern "C" {
 
 /**
  * @def ODP_TM_MAX_TM_QUEUES
- * The largest number of tm_queues that can handled by any one TM system.
+ * The largest number of tm_queues that can be handled by any one TM system.
  */
 
 /**
@@ -97,7 +97,7 @@  extern "C" {
 
 /**
  * @def ODP_TM_MIN_SHAPER_BW
- * The largest amount of bandwidth that any shaper's peak or commit rate can
+ * The lowest amount of bandwidth that any shaper's peak or commit rate can
  * be set to. It is in units of 1000 bytes/second.
  */
 
@@ -143,7 +143,7 @@  extern "C" {
 
 /**
  * @typedef odp_tm_node_t
- * Each odp_tm_queue_t value is an opaque ODP handle representing a specific
+ * Each odp_tm_node_t value is an opaque ODP handle representing a specific
  * tm node within a specific TM system.
  */
 
diff --git a/platform/linux-generic/doc/platform_specific.dox b/platform/linux-generic/doc/platform_specific.dox
index e116ec617..c26661484 100644
--- a/platform/linux-generic/doc/platform_specific.dox
+++ b/platform/linux-generic/doc/platform_specific.dox
@@ -28,7 +28,7 @@ 
  *			to odp_init_local() is actually fully defined by these
  *			requirements: It has to be the value returned by the
  *			unique call to odp_init_global() made by one single
- *			acsendant of the current process.
+ *			ascendant of the current process.
  */
 
 /**
diff --git a/platform/linux-generic/include/odp/api/plat/traffic_mngr_types.h b/platform/linux-generic/include/odp/api/plat/traffic_mngr_types.h
index f47a13f6f..be3926d46 100644
--- a/platform/linux-generic/include/odp/api/plat/traffic_mngr_types.h
+++ b/platform/linux-generic/include/odp/api/plat/traffic_mngr_types.h
@@ -56,7 +56,7 @@  extern "C" {
 #define ODP_TM_MAX_SCHED_WEIGHT  255
 
 /** The ODP_TM_MAX_TM_QUEUES constant is the largest number of tm_queues
- * that can handled by any one TM system.
+ * that can be handled by any one TM system.
  */
 #define ODP_TM_MAX_TM_QUEUES  (16 * 1024 * 1024)