diff mbox

[API-NEXT] api: crypto: correct documentation typos

Message ID 20170606032219.11143-1-bill.fischofer@linaro.org
State Accepted
Commit 1b8c663ecd3b8a7c34ae52163961cdb442383d31
Headers show

Commit Message

Bill Fischofer June 6, 2017, 3:22 a.m. UTC
Correct odp_crypto_auth_capa() to odp_crypto_auth_capability() in
several places in the spec doxygen.

Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>

---
 include/odp/api/spec/crypto.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

-- 
2.11.0

Comments

Yi He June 6, 2017, 3:26 a.m. UTC | #1
Reviewed-by: Yi He <yi.he@linaro.org>


On 6 June 2017 at 11:22, Bill Fischofer <bill.fischofer@linaro.org> wrote:

> Correct odp_crypto_auth_capa() to odp_crypto_auth_capability() in

> several places in the spec doxygen.

>

> Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>

> ---

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

>  1 file changed, 3 insertions(+), 3 deletions(-)

>

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

> index c47d3149..470cba05 100644

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

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

> @@ -296,13 +296,13 @@ typedef struct odp_crypto_session_param_t {

>

>         /** Authentication key

>          *

> -        *  Use odp_crypto_auth_capa() for supported key lengths.

> +        *  Use odp_crypto_auth_capability() for supported key lengths.

>          */

>         odp_crypto_key_t auth_key;

>

>         /** Authentication digest length in bytes

>          *

> -        *  Use odp_crypto_auth_capa() for supported digest lengths.

> +        *  Use odp_crypto_auth_capability() for supported digest lengths.

>          */

>         uint32_t auth_digest_len;

>

> @@ -377,7 +377,7 @@ typedef struct odp_crypto_op_param_t {

>                 /** Pointer to ADD */

>                 uint8_t *ptr;

>

> -               /** AAD length in bytes. Use odp_crypto_auth_capa() for

> +               /** AAD length in bytes. Use odp_crypto_auth_capability()

> for

>                  *  supported AAD lengths. */

>                 uint32_t length;

>         } aad;

> --

> 2.11.0

>

>
Savolainen, Petri (Nokia - FI/Espoo) June 6, 2017, 7:16 a.m. UTC | #2
Reviewed-by: Petri Savolainen <petri.savolainen@linaro.org>


> -----Original Message-----

> From: lng-odp [mailto:lng-odp-bounces@lists.linaro.org] On Behalf Of Yi He

> Sent: Tuesday, June 06, 2017 6:26 AM

> To: Bill Fischofer <bill.fischofer@linaro.org>

> Cc: lng-odp <lng-odp@lists.linaro.org>

> Subject: Re: [lng-odp] [API-NEXT PATCH] api: crypto: correct documentation

> typos

> 

> Reviewed-by: Yi He <yi.he@linaro.org>

> 

> On 6 June 2017 at 11:22, Bill Fischofer <bill.fischofer@linaro.org> wrote:

> 

> > Correct odp_crypto_auth_capa() to odp_crypto_auth_capability() in

> > several places in the spec doxygen.

> >

> > Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>

> > ---

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

> >  1 file changed, 3 insertions(+), 3 deletions(-)

> >

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

> b/include/odp/api/spec/crypto.h

> > index c47d3149..470cba05 100644

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

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

> > @@ -296,13 +296,13 @@ typedef struct odp_crypto_session_param_t {

> >

> >         /** Authentication key

> >          *

> > -        *  Use odp_crypto_auth_capa() for supported key lengths.

> > +        *  Use odp_crypto_auth_capability() for supported key lengths.

> >          */

> >         odp_crypto_key_t auth_key;

> >

> >         /** Authentication digest length in bytes

> >          *

> > -        *  Use odp_crypto_auth_capa() for supported digest lengths.

> > +        *  Use odp_crypto_auth_capability() for supported digest

> lengths.

> >          */

> >         uint32_t auth_digest_len;

> >

> > @@ -377,7 +377,7 @@ typedef struct odp_crypto_op_param_t {

> >                 /** Pointer to ADD */

> >                 uint8_t *ptr;

> >

> > -               /** AAD length in bytes. Use odp_crypto_auth_capa() for

> > +               /** AAD length in bytes. Use

> odp_crypto_auth_capability()

> > for

> >                  *  supported AAD lengths. */

> >                 uint32_t length;

> >         } aad;

> > --

> > 2.11.0

> >

> >
diff mbox

Patch

diff --git a/include/odp/api/spec/crypto.h b/include/odp/api/spec/crypto.h
index c47d3149..470cba05 100644
--- a/include/odp/api/spec/crypto.h
+++ b/include/odp/api/spec/crypto.h
@@ -296,13 +296,13 @@  typedef struct odp_crypto_session_param_t {
 
 	/** Authentication key
 	 *
-	 *  Use odp_crypto_auth_capa() for supported key lengths.
+	 *  Use odp_crypto_auth_capability() for supported key lengths.
 	 */
 	odp_crypto_key_t auth_key;
 
 	/** Authentication digest length in bytes
 	 *
-	 *  Use odp_crypto_auth_capa() for supported digest lengths.
+	 *  Use odp_crypto_auth_capability() for supported digest lengths.
 	 */
 	uint32_t auth_digest_len;
 
@@ -377,7 +377,7 @@  typedef struct odp_crypto_op_param_t {
 		/** Pointer to ADD */
 		uint8_t *ptr;
 
-		/** AAD length in bytes. Use odp_crypto_auth_capa() for
+		/** AAD length in bytes. Use odp_crypto_auth_capability() for
 		 *  supported AAD lengths. */
 		uint32_t length;
 	} aad;