From patchwork Tue Jun 6 03:22:19 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 103124 Delivered-To: patch@linaro.org Received: by 10.140.91.77 with SMTP id y71csp1220300qgd; Mon, 5 Jun 2017 20:22:31 -0700 (PDT) X-Received: by 10.55.215.130 with SMTP id t2mr16058604qkt.188.1496719351172; Mon, 05 Jun 2017 20:22:31 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1496719351; cv=none; d=google.com; s=arc-20160816; b=ES9t3z5YEcHIYCm/Fx2Ajup0VdmGI0z+mRsBPiQKG/PX0zhhVLreuuk8v0W5XMHfpH g1onQHEah37u0OQ+LR9UCuuf3VHaus/c0LKlbWosOH6SMW2VMRfSCqP8JvIoSRBwQdb/ 2joCuLrzykQ2pn8bKdPGunwREkTQv3ncMOWB24xHh291SFJUtV+Gc9NK1/Y8S92malXt bBFgruNSaFm7vJK6ZVoctYqsHlbPZPBcnxhCdLFgm1dWZG1s7QBSFmAKe/AZkg8QBpIn DBCCFkpVCmLqEOinuglGHeIuhCR5VmYANTh9LB46ucF1GSLmuodaTLZ0DO9J764RKcwO Wv1g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject:message-id:date:to:from :delivered-to:arc-authentication-results; bh=SCSw0syBewksUcIJg5LkN9mj0mpwuU8kf/NiuTgQuv8=; b=iF6y/CET+gICYra6i3dUheDYD+VTagGAuhxjpIikrb3uDo+RQKy8M03id5G8xUY+te 38Jv1pLAqeRv/++llN+3q7FS8Wmdb5l2qvBt0Uva0MzWEPTPHm44EcX0S0Gie7LLx3/W 328XBF2DII9e/eyqSk7ZJctXa2OwkatrSKVNLeWtLZFKP8/L35+JgVFVtgZC+IDlsn17 ux4SQpRnyrbFpAtCPXrKy1KTilFtfW9CrWifsU4AJpL2a3Vd9NZrxG/ue33wZiByEVAo 3/A9/bCOr1dQ6zQrDDluVYD40C9h13DsvJe8Fw2R8Hv6s7fUBsPvoXqhHuOkFl95Das9 WoIQ== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id a4si33487046qkf.331.2017.06.05.20.22.30; Mon, 05 Jun 2017 20:22:31 -0700 (PDT) Received-SPF: pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) client-ip=54.225.227.206; Authentication-Results: mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 7F65B60C27; Tue, 6 Jun 2017 03:22:30 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252 X-Spam-Level: X-Spam-Status: No, score=-1.4 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, RCVD_IN_SORBS_SPAM, URIBL_BLOCKED autolearn=disabled version=3.4.0 Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 125D760BFC; Tue, 6 Jun 2017 03:22:27 +0000 (UTC) X-Original-To: lng-odp@lists.linaro.org Delivered-To: lng-odp@lists.linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 3843260C04; Tue, 6 Jun 2017 03:22:25 +0000 (UTC) Received: from mail-ot0-f179.google.com (mail-ot0-f179.google.com [74.125.82.179]) by lists.linaro.org (Postfix) with ESMTPS id 8DB0A609BA for ; Tue, 6 Jun 2017 03:22:24 +0000 (UTC) Received: by mail-ot0-f179.google.com with SMTP id t31so8314894ota.1 for ; Mon, 05 Jun 2017 20:22:24 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=SCSw0syBewksUcIJg5LkN9mj0mpwuU8kf/NiuTgQuv8=; b=tb714L521phjNGB93/BwDRpRXS3ovJ9KGMJqgwn1zuFNc4QAZ1XTEjTVvZXSC5SXue 1plP2oLZ5iAZobEstYUk/230AQNZTJ181ayVeNBS0biJJzACtVKNL5qzWHX0cFHU6mk4 CTb9OG6bjeR01V8jx8yeX/jRTLk3JJdf73GWWiOfrtVPMm0rw1OjxeUEhi2Rmk8WFzYT Qx2MM3vVdeYKlaRadVS7v+mBXJw9b00EHi2N98bJtghwsvQLBPcW86KN5bNZRJHunoUX oCbMlJtID+tDBuDOdZp+1/+o6WmMNnUEfUtOLPiNj4NEv38elKSNo8F4QmsfyWpPDzbv VLAg== X-Gm-Message-State: AODbwcBY7tiQysIUegxHRpp8yuDvOzupY5AdcgFRN9BLrD2Tes9LS8GY y6965bJyHInfeh37AqMcvnRr X-Received: by 10.157.37.5 with SMTP id k5mr13969381otb.189.1496719343752; Mon, 05 Jun 2017 20:22:23 -0700 (PDT) Received: from localhost.localdomain (cpe-70-121-83-241.austin.res.rr.com. [70.121.83.241]) by smtp.gmail.com with ESMTPSA id c18sm6533631oih.38.2017.06.05.20.22.22 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 05 Jun 2017 20:22:23 -0700 (PDT) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Mon, 5 Jun 2017 22:22:19 -0500 Message-Id: <20170606032219.11143-1-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.11.0 Subject: [lng-odp] [API-NEXT PATCH] api: crypto: correct documentation typos X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: "The OpenDataPlane \(ODP\) List" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" Correct odp_crypto_auth_capa() to odp_crypto_auth_capability() in several places in the spec doxygen. Signed-off-by: Bill Fischofer --- include/odp/api/spec/crypto.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) -- 2.11.0 Reviewed-by: Yi He Reviewed-by: Petri Savolainen 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;