DPDK patches and discussions
 help / color / mirror / Atom feed
From: Akhil Goyal <akhil.goyal@nxp.com>
To: "Somalapuram, Amaranath" <Amaranath.Somalapuram@amd.com>,
	"dev@dpdk.org" <dev@dpdk.org>
Cc: "stable@dpdk.org" <stable@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH v1 1/6] doc: documentation update
Date: Fri, 8 Nov 2019 13:16:25 +0000	[thread overview]
Message-ID: <VE1PR04MB6639EB4352D470C0A2D288FCE67B0@VE1PR04MB6639.eurprd04.prod.outlook.com> (raw)
In-Reply-To: <DM5PR1201MB24740941812DAA2AC31D2EB4F87F0@DM5PR1201MB2474.namprd12.prod.outlook.com>


> 
> Hi Akhil,
> If I use fix as a tag. I get the below message.
> Is this messages is ok or do we need to have bug numbers for this?
> 
> ./devtools/check-git-log.sh
> Missing 'Fixes' tag:
>         doc: fix app usage in CCP guide
> 
> Regards,
> S.Amarnath
> 
Yes, it should have a fixes tag 
For this patch it would be 
Fixes: 4433ced9aa4b ("doc: add AMD CCP guide")
And patch title would be "doc: fix app usage in CCP guide".

You should find the commit ID of the original patch which introduced this issue.
You can use git blame.

Please make similar changes in all the patches.

Regards,
Akhil

> 
> Title should be "doc: fix app usage in CCP guide"
> 
> >
> > From: Amaranath Somalapuram <asomalap@amd.com>
> >
> > Update the docs, fixing description of some parameter.
> > Changing AES_CBC to aes-cbc, SHA1_HMAC to sha1-hmac.
> Patch description should be something like:
> Command line arguments for running l2fwd-crypto was updated but the AMD
> CCP PMD still uses old arguments.
> This patch updates the command line arguments of l2fwd-crypto while running
> with crypto-ccp
> 
> 
> Please add a fixes line here specifying the commit Id and patch title  Of the patch
> which originally introduced this issue.
> 
> > Cc: stable@dpdk.org
> >
> > Signed-off-by: Amaranath Somalapuram <asomalap@amd.com>
> > ---
> >  doc/guides/cryptodevs/ccp.rst | 32 ++++++++++++++++----------------
> >  1 file changed, 16 insertions(+), 16 deletions(-)
> >
> > diff --git a/doc/guides/cryptodevs/ccp.rst
> > b/doc/guides/cryptodevs/ccp.rst index 034d20367..a43fe92de 100644
> > --- a/doc/guides/cryptodevs/ccp.rst
> > +++ b/doc/guides/cryptodevs/ccp.rst
> > @@ -109,14 +109,14 @@ To validate ccp pmd, l2fwd-crypto example can be
> > used with following command:
> >
> >  .. code-block:: console
> >
> > -     sudo ./build/l2fwd-crypto -l 1 -n 4 --vdev "crypto_ccp" -- -p 0x1
> > -     --chain CIPHER_HASH --cipher_op ENCRYPT --cipher_algo AES_CBC
> > -     --cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f
> > -     --iv 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:ff
> > -     --auth_op GENERATE --auth_algo SHA1_HMAC
> > -     --auth_key
> > 11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
> > -
> >
> > :11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:1
> > 1:11:11
> > -     :11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
> > +        sudo ./build/l2fwd-crypto -l 1 -n 4 --vdev "crypto_ccp" -- -p 0x1
> > +        --chain CIPHER_HASH --cipher_op ENCRYPT --cipher_algo aes-cbc
> > +        --cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f
> > +        --cipher_iv 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:ff
> > +        --auth_op GENERATE --auth_algo sha1-hmac
> > +        --auth_key
> > 11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
> > +
> > + :11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:1
> > + 1:1
> > 1:11
> > +        :11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
> >
> >  The CCP PMD also supports computing authentication over CPU with
> > cipher offloaded to CCP.
> >  To enable this feature, pass an additional argument as ccp_auth_opt=1
> > to -- vdev parameters as @@ -124,14 +124,14 @@ following:
> >
> >  .. code-block:: console
> >
> > -     sudo ./build/l2fwd-crypto -l 1 -n 4 --vdev "crypto_ccp,ccp_auth_opt=1"
> > -- -p 0x1
> > -     --chain CIPHER_HASH --cipher_op ENCRYPT --cipher_algo AES_CBC
> > -     --cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f
> > -     --iv 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:ff
> > -     --auth_op GENERATE --auth_algo SHA1_HMAC
> > -     --auth_key
> > 11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
> > -
> >
> > :11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:1
> > 1:11:11
> > -     :11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
> > +        sudo ./build/l2fwd-crypto -l 1 -n 4 --vdev
> > + "crypto_ccp,ccp_auth_opt=1" -- -
> > p 0x1
> > +        --chain CIPHER_HASH --cipher_op ENCRYPT --cipher_algo aes-cbc
> > +        --cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f
> > +        --cipher_iv 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:ff
> > +        --auth_op GENERATE --auth_algo sha1-hmac
> > +        --auth_key
> > 11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
> > +
> > + :11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:1
> > + 1:1
> > 1:11
> > +        :11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
> >
> >  Limitations
> >  -----------
> > --
> > 2.17.1


      reply	other threads:[~2019-11-08 13:16 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-10-15  7:00 asomalap
2019-10-15 10:53 ` Akhil Goyal
2019-11-04  4:51   ` Somalapuram, Amaranath
2019-11-08 13:16     ` Akhil Goyal [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=VE1PR04MB6639EB4352D470C0A2D288FCE67B0@VE1PR04MB6639.eurprd04.prod.outlook.com \
    --to=akhil.goyal@nxp.com \
    --cc=Amaranath.Somalapuram@amd.com \
    --cc=dev@dpdk.org \
    --cc=stable@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).