| Message ID | 1433438290-11394-1-git-send-email-mike.holmes@linaro.org |
|---|---|
| State | Accepted |
| Commit | afba2fa2a2baf4f1d4d04d6c633848af370deae4 |
| Headers | show |
On Thu, Jun 4, 2015 at 12:18 PM, Mike Holmes <mike.holmes@linaro.org> wrote: > Signed-off-by: Mike Holmes <mike.holmes@linaro.org> > Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> > --- > include/odp/api/crypto.h | 4 ++-- > include/odp/api/packet_io.h | 2 +- > include/odp/api/pool.h | 2 +- > include/odp/api/queue.h | 4 ++-- > 4 files changed, 6 insertions(+), 6 deletions(-) > > diff --git a/include/odp/api/crypto.h b/include/odp/api/crypto.h > index 792549c..a9a2a1d 100644 > --- a/include/odp/api/crypto.h > +++ b/include/odp/api/crypto.h > @@ -110,7 +110,7 @@ typedef struct odp_crypto_data_range { > } odp_crypto_data_range_t; > > /** > - * Crypto API session creation paramters > + * Crypto API session creation parameters > * > * @todo Add "odp_session_proc_info_t" > */ > @@ -133,7 +133,7 @@ typedef struct odp_crypto_session_params { > * Controls ordering of authentication and cipher operations, > * and is relative to the operation (encode vs decode). > * When encoding, @c TRUE indicates the authentication operation > - * should be peformed @b after the cipher operation else before. > + * should be performed @b after the cipher operation else before. > * When decoding, @c TRUE indicates the reverse order of operation. > * > * @var odp_crypto_session_params_t::compl_queue > diff --git a/include/odp/api/packet_io.h b/include/odp/api/packet_io.h > index 89356a6..5b04737 100644 > --- a/include/odp/api/packet_io.h > +++ b/include/odp/api/packet_io.h > @@ -64,7 +64,7 @@ extern "C" { > * > * @note Packets arriving via this interface assigned to a CoS by the > * classifier are received into the pool associated with that CoS. > This > - * will occur either becuase this pktio is assigned a default CoS via > + * will occur either because this pktio is assigned a default CoS via > * the odp_pktio_default_cos_set() routine, or because a matching PMR > * assigned the packet to a specific CoS. The default pool specified > * here is applicable only for those packets that are not assigned > to a > diff --git a/include/odp/api/pool.h b/include/odp/api/pool.h > index e5061ab..1ae7119 100644 > --- a/include/odp/api/pool.h > +++ b/include/odp/api/pool.h > @@ -37,7 +37,7 @@ extern "C" { > * Invalid pool > */ > > -/** Maximum queue name lenght in chars */ > +/** Maximum queue name length in chars */ > #define ODP_POOL_NAME_LEN 32 > > /** > diff --git a/include/odp/api/queue.h b/include/odp/api/queue.h > index 6a8b15f..f7a0777 100644 > --- a/include/odp/api/queue.h > +++ b/include/odp/api/queue.h > @@ -41,7 +41,7 @@ extern "C" { > > /** > * @def ODP_QUEUE_NAME_LEN > - * Maximum queue name lenght in chars > + * Maximum queue name length in chars > */ > > > @@ -213,7 +213,7 @@ odp_queue_t odp_queue_lookup(const char *name); > /** > * Set queue context > * > - * Its the responsability of the interface user to make sure > + * It is the responsibility of the interface user to make sure > * queue context allocation is done in an area reachable for > * all EOs accessing the context > * > -- > 2.1.4 > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > https://lists.linaro.org/mailman/listinfo/lng-odp >
why this is for api-next? Patch fixes only spelling in doxygen description. It does not modify API. It has to go to master. Maxim. On 06/05/15 06:17, Bill Fischofer wrote: > > > On Thu, Jun 4, 2015 at 12:18 PM, Mike Holmes <mike.holmes@linaro.org > <mailto:mike.holmes@linaro.org>> wrote: > > Signed-off-by: Mike Holmes <mike.holmes@linaro.org > <mailto:mike.holmes@linaro.org>> > > > Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org > <mailto:bill.fischofer@linaro.org>> > > --- > include/odp/api/crypto.h | 4 ++-- > include/odp/api/packet_io.h | 2 +- > include/odp/api/pool.h | 2 +- > include/odp/api/queue.h | 4 ++-- > 4 files changed, 6 insertions(+), 6 deletions(-) > > diff --git a/include/odp/api/crypto.h b/include/odp/api/crypto.h > index 792549c..a9a2a1d 100644 > --- a/include/odp/api/crypto.h > +++ b/include/odp/api/crypto.h > @@ -110,7 +110,7 @@ typedef struct odp_crypto_data_range { > } odp_crypto_data_range_t; > > /** > - * Crypto API session creation paramters > + * Crypto API session creation parameters > * > * @todo Add "odp_session_proc_info_t" > */ > @@ -133,7 +133,7 @@ typedef struct odp_crypto_session_params { > * Controls ordering of authentication and cipher operations, > * and is relative to the operation (encode vs decode). > * When encoding, @c TRUE indicates the authentication operation > - * should be peformed @b after the cipher operation else before. > + * should be performed @b after the cipher operation else before. > * When decoding, @c TRUE indicates the reverse order of operation. > * > * @var odp_crypto_session_params_t::compl_queue > diff --git a/include/odp/api/packet_io.h b/include/odp/api/packet_io.h > index 89356a6..5b04737 100644 > --- a/include/odp/api/packet_io.h > +++ b/include/odp/api/packet_io.h > @@ -64,7 +64,7 @@ extern "C" { > * > * @note Packets arriving via this interface assigned to a CoS by the > * classifier are received into the pool associated with > that CoS. This > - * will occur either becuase this pktio is assigned a > default CoS via > + * will occur either because this pktio is assigned a > default CoS via > * the odp_pktio_default_cos_set() routine, or because a > matching PMR > * assigned the packet to a specific CoS. The default pool > specified > * here is applicable only for those packets that are not > assigned to a > diff --git a/include/odp/api/pool.h b/include/odp/api/pool.h > index e5061ab..1ae7119 100644 > --- a/include/odp/api/pool.h > +++ b/include/odp/api/pool.h > @@ -37,7 +37,7 @@ extern "C" { > * Invalid pool > */ > > -/** Maximum queue name lenght in chars */ > +/** Maximum queue name length in chars */ > #define ODP_POOL_NAME_LEN 32 > > /** > diff --git a/include/odp/api/queue.h b/include/odp/api/queue.h > index 6a8b15f..f7a0777 100644 > --- a/include/odp/api/queue.h > +++ b/include/odp/api/queue.h > @@ -41,7 +41,7 @@ extern "C" { > > /** > * @def ODP_QUEUE_NAME_LEN > - * Maximum queue name lenght in chars > + * Maximum queue name length in chars > */ > > > @@ -213,7 +213,7 @@ odp_queue_t odp_queue_lookup(const char *name); > /** > * Set queue context > * > - * Its the responsability of the interface user to make sure > + * It is the responsibility of the interface user to make sure > * queue context allocation is done in an area reachable for > * all EOs accessing the context > * > -- > 2.1.4 > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org <mailto:lng-odp@lists.linaro.org> > https://lists.linaro.org/mailman/listinfo/lng-odp > > > > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > https://lists.linaro.org/mailman/listinfo/lng-odp
On 5 June 2015 at 04:26, Maxim Uvarov <maxim.uvarov@linaro.org> wrote: > why this is for api-next? > > Patch fixes only spelling in doxygen description. It does not modify API. > It has to go to master. > All changes in the include directory go into api-next, every time we try a short cut we open ourselves up to discussion on was it wise. See this kernel discussion http://www.kegel.com/kerspell/. Importantly "Correcting spelling mistakes is not as easy as it sounds; it cannot really be automated, as many reasonable-sounding corrections could actually change the meaning of the comments." If it makes it in api-next it can be quickly cherry picked back to master, but the API might have been affected if the description is now incorrect. > > Maxim. > > > On 06/05/15 06:17, Bill Fischofer wrote: > >> >> >> On Thu, Jun 4, 2015 at 12:18 PM, Mike Holmes <mike.holmes@linaro.org >> <mailto:mike.holmes@linaro.org>> wrote: >> >> Signed-off-by: Mike Holmes <mike.holmes@linaro.org >> <mailto:mike.holmes@linaro.org>> >> >> >> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org <mailto: >> bill.fischofer@linaro.org>> >> >> >> --- >> include/odp/api/crypto.h | 4 ++-- >> include/odp/api/packet_io.h | 2 +- >> include/odp/api/pool.h | 2 +- >> include/odp/api/queue.h | 4 ++-- >> 4 files changed, 6 insertions(+), 6 deletions(-) >> >> diff --git a/include/odp/api/crypto.h b/include/odp/api/crypto.h >> index 792549c..a9a2a1d 100644 >> --- a/include/odp/api/crypto.h >> +++ b/include/odp/api/crypto.h >> @@ -110,7 +110,7 @@ typedef struct odp_crypto_data_range { >> } odp_crypto_data_range_t; >> >> /** >> - * Crypto API session creation paramters >> + * Crypto API session creation parameters >> * >> * @todo Add "odp_session_proc_info_t" >> */ >> @@ -133,7 +133,7 @@ typedef struct odp_crypto_session_params { >> * Controls ordering of authentication and cipher operations, >> * and is relative to the operation (encode vs decode). >> * When encoding, @c TRUE indicates the authentication operation >> - * should be peformed @b after the cipher operation else before. >> + * should be performed @b after the cipher operation else before. >> * When decoding, @c TRUE indicates the reverse order of operation. >> * >> * @var odp_crypto_session_params_t::compl_queue >> diff --git a/include/odp/api/packet_io.h b/include/odp/api/packet_io.h >> index 89356a6..5b04737 100644 >> --- a/include/odp/api/packet_io.h >> +++ b/include/odp/api/packet_io.h >> @@ -64,7 +64,7 @@ extern "C" { >> * >> * @note Packets arriving via this interface assigned to a CoS by the >> * classifier are received into the pool associated with >> that CoS. This >> - * will occur either becuase this pktio is assigned a >> default CoS via >> + * will occur either because this pktio is assigned a >> default CoS via >> * the odp_pktio_default_cos_set() routine, or because a >> matching PMR >> * assigned the packet to a specific CoS. The default pool >> specified >> * here is applicable only for those packets that are not >> assigned to a >> diff --git a/include/odp/api/pool.h b/include/odp/api/pool.h >> index e5061ab..1ae7119 100644 >> --- a/include/odp/api/pool.h >> +++ b/include/odp/api/pool.h >> @@ -37,7 +37,7 @@ extern "C" { >> * Invalid pool >> */ >> >> -/** Maximum queue name lenght in chars */ >> +/** Maximum queue name length in chars */ >> #define ODP_POOL_NAME_LEN 32 >> >> /** >> diff --git a/include/odp/api/queue.h b/include/odp/api/queue.h >> index 6a8b15f..f7a0777 100644 >> --- a/include/odp/api/queue.h >> +++ b/include/odp/api/queue.h >> @@ -41,7 +41,7 @@ extern "C" { >> >> /** >> * @def ODP_QUEUE_NAME_LEN >> - * Maximum queue name lenght in chars >> + * Maximum queue name length in chars >> */ >> >> >> @@ -213,7 +213,7 @@ odp_queue_t odp_queue_lookup(const char *name); >> /** >> * Set queue context >> * >> - * Its the responsability of the interface user to make sure >> + * It is the responsibility of the interface user to make sure >> * queue context allocation is done in an area reachable for >> * all EOs accessing the context >> * >> -- >> 2.1.4 >> >> _______________________________________________ >> lng-odp mailing list >> lng-odp@lists.linaro.org <mailto:lng-odp@lists.linaro.org> >> https://lists.linaro.org/mailman/listinfo/lng-odp >> >> >> >> >> _______________________________________________ >> lng-odp mailing list >> lng-odp@lists.linaro.org >> https://lists.linaro.org/mailman/listinfo/lng-odp >> > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > https://lists.linaro.org/mailman/listinfo/lng-odp >
OK. Merged, Maxim. On 06/05/15 13:52, Mike Holmes wrote: > > > On 5 June 2015 at 04:26, Maxim Uvarov <maxim.uvarov@linaro.org > <mailto:maxim.uvarov@linaro.org>> wrote: > > why this is for api-next? > > Patch fixes only spelling in doxygen description. It does not > modify API. It has to go to master. > > > > All changes in the include directory go into api-next, every time we > try a short cut we open ourselves up to discussion on was it wise. See > this kernel discussion http://www.kegel.com/kerspell/. > > Importantly "Correcting spelling mistakes is not as easy as it sounds; > it cannot really be automated, as many reasonable-sounding corrections > could actually change the meaning of the comments." > > If it makes it in api-next it can be quickly cherry picked back to > master, but the API might have been affected if the description is now > incorrect. > > > Maxim. > > > On 06/05/15 06:17, Bill Fischofer wrote: > > > > On Thu, Jun 4, 2015 at 12:18 PM, Mike Holmes > <mike.holmes@linaro.org <mailto:mike.holmes@linaro.org> > <mailto:mike.holmes@linaro.org > <mailto:mike.holmes@linaro.org>>> wrote: > > Signed-off-by: Mike Holmes <mike.holmes@linaro.org > <mailto:mike.holmes@linaro.org> > <mailto:mike.holmes@linaro.org > <mailto:mike.holmes@linaro.org>>> > > > Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org > <mailto:bill.fischofer@linaro.org> > <mailto:bill.fischofer@linaro.org > <mailto:bill.fischofer@linaro.org>>> > > > --- > include/odp/api/crypto.h | 4 ++-- > include/odp/api/packet_io.h | 2 +- > include/odp/api/pool.h | 2 +- > include/odp/api/queue.h | 4 ++-- > 4 files changed, 6 insertions(+), 6 deletions(-) > > diff --git a/include/odp/api/crypto.h > b/include/odp/api/crypto.h > index 792549c..a9a2a1d 100644 > --- a/include/odp/api/crypto.h > +++ b/include/odp/api/crypto.h > @@ -110,7 +110,7 @@ typedef struct odp_crypto_data_range { > } odp_crypto_data_range_t; > > /** > - * Crypto API session creation paramters > + * Crypto API session creation parameters > * > * @todo Add "odp_session_proc_info_t" > */ > @@ -133,7 +133,7 @@ typedef struct odp_crypto_session_params { > * Controls ordering of authentication and cipher > operations, > * and is relative to the operation (encode vs decode). > * When encoding, @c TRUE indicates the authentication > operation > - * should be peformed @b after the cipher operation > else before. > + * should be performed @b after the cipher operation > else before. > * When decoding, @c TRUE indicates the reverse order > of operation. > * > * @var odp_crypto_session_params_t::compl_queue > diff --git a/include/odp/api/packet_io.h > b/include/odp/api/packet_io.h > index 89356a6..5b04737 100644 > --- a/include/odp/api/packet_io.h > +++ b/include/odp/api/packet_io.h > @@ -64,7 +64,7 @@ extern "C" { > * > * @note Packets arriving via this interface assigned to > a CoS by the > * classifier are received into the pool associated with > that CoS. This > - * will occur either becuase this pktio is assigned a > default CoS via > + * will occur either because this pktio is assigned a > default CoS via > * the odp_pktio_default_cos_set() routine, or because a > matching PMR > * assigned the packet to a specific CoS. The > default pool > specified > * here is applicable only for those packets that > are not > assigned to a > diff --git a/include/odp/api/pool.h b/include/odp/api/pool.h > index e5061ab..1ae7119 100644 > --- a/include/odp/api/pool.h > +++ b/include/odp/api/pool.h > @@ -37,7 +37,7 @@ extern "C" { > * Invalid pool > */ > > -/** Maximum queue name lenght in chars */ > +/** Maximum queue name length in chars */ > #define ODP_POOL_NAME_LEN 32 > > /** > diff --git a/include/odp/api/queue.h b/include/odp/api/queue.h > index 6a8b15f..f7a0777 100644 > --- a/include/odp/api/queue.h > +++ b/include/odp/api/queue.h > @@ -41,7 +41,7 @@ extern "C" { > > /** > * @def ODP_QUEUE_NAME_LEN > - * Maximum queue name lenght in chars > + * Maximum queue name length in chars > */ > > > @@ -213,7 +213,7 @@ odp_queue_t odp_queue_lookup(const > char *name); > /** > * Set queue context > * > - * Its the responsability of the interface user to make sure > + * It is the responsibility of the interface user to make > sure > * queue context allocation is done in an area reachable for > * all EOs accessing the context > * > -- > 2.1.4 > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org <mailto:lng-odp@lists.linaro.org> > <mailto:lng-odp@lists.linaro.org > <mailto:lng-odp@lists.linaro.org>> > https://lists.linaro.org/mailman/listinfo/lng-odp > > > > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org <mailto:lng-odp@lists.linaro.org> > https://lists.linaro.org/mailman/listinfo/lng-odp > > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org <mailto:lng-odp@lists.linaro.org> > https://lists.linaro.org/mailman/listinfo/lng-odp > > > > > -- > Mike Holmes > Technical Manager - Linaro Networking Group > Linaro.org <http://www.linaro.org/>***│ *Open source software for ARM SoCs >
diff --git a/include/odp/api/crypto.h b/include/odp/api/crypto.h index 792549c..a9a2a1d 100644 --- a/include/odp/api/crypto.h +++ b/include/odp/api/crypto.h @@ -110,7 +110,7 @@ typedef struct odp_crypto_data_range { } odp_crypto_data_range_t; /** - * Crypto API session creation paramters + * Crypto API session creation parameters * * @todo Add "odp_session_proc_info_t" */ @@ -133,7 +133,7 @@ typedef struct odp_crypto_session_params { * Controls ordering of authentication and cipher operations, * and is relative to the operation (encode vs decode). * When encoding, @c TRUE indicates the authentication operation - * should be peformed @b after the cipher operation else before. + * should be performed @b after the cipher operation else before. * When decoding, @c TRUE indicates the reverse order of operation. * * @var odp_crypto_session_params_t::compl_queue diff --git a/include/odp/api/packet_io.h b/include/odp/api/packet_io.h index 89356a6..5b04737 100644 --- a/include/odp/api/packet_io.h +++ b/include/odp/api/packet_io.h @@ -64,7 +64,7 @@ extern "C" { * * @note Packets arriving via this interface assigned to a CoS by the * classifier are received into the pool associated with that CoS. This - * will occur either becuase this pktio is assigned a default CoS via + * will occur either because this pktio is assigned a default CoS via * the odp_pktio_default_cos_set() routine, or because a matching PMR * assigned the packet to a specific CoS. The default pool specified * here is applicable only for those packets that are not assigned to a diff --git a/include/odp/api/pool.h b/include/odp/api/pool.h index e5061ab..1ae7119 100644 --- a/include/odp/api/pool.h +++ b/include/odp/api/pool.h @@ -37,7 +37,7 @@ extern "C" { * Invalid pool */ -/** Maximum queue name lenght in chars */ +/** Maximum queue name length in chars */ #define ODP_POOL_NAME_LEN 32 /** diff --git a/include/odp/api/queue.h b/include/odp/api/queue.h index 6a8b15f..f7a0777 100644 --- a/include/odp/api/queue.h +++ b/include/odp/api/queue.h @@ -41,7 +41,7 @@ extern "C" { /** * @def ODP_QUEUE_NAME_LEN - * Maximum queue name lenght in chars + * Maximum queue name length in chars */ @@ -213,7 +213,7 @@ odp_queue_t odp_queue_lookup(const char *name); /** * Set queue context * - * Its the responsability of the interface user to make sure + * It is the responsibility of the interface user to make sure * queue context allocation is done in an area reachable for * all EOs accessing the context *
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> --- include/odp/api/crypto.h | 4 ++-- include/odp/api/packet_io.h | 2 +- include/odp/api/pool.h | 2 +- include/odp/api/queue.h | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-)