DPDK-dev Archive on lore.kernel.org
 help / color / Atom feed
From: Jerin Jacob <jerinjacobk@gmail.com>
To: "McDaniel, Timothy" <timothy.mcdaniel@intel.com>
Cc: "Jerin Jacob" <jerinj@marvell.com>,
	"Mattias Rönnblom" <mattias.ronnblom@ericsson.com>,
	dpdk-dev <dev@dpdk.org>, "Gage Eads" <gage.eads@intel.com>,
	"Van Haaren, Harry" <harry.van.haaren@intel.com>
Subject: Re: [dpdk-dev] [PATCH] doc: announce changes to eventdev public data structures
Date: Mon, 3 Aug 2020 11:39:16 +0530
Message-ID: <CALBAE1Oa=gRj5EgG4jmGi3LDN7akj6=czgvoY5GPJGfdHtb7aw@mail.gmail.com> (raw)
In-Reply-To: <1596223885-27437-1-git-send-email-timothy.mcdaniel@intel.com>

On Sat, Aug 1, 2020 at 1:04 AM McDaniel, Timothy
<timothy.mcdaniel@intel.com> wrote:
>
> From: "McDaniel, Timothy" <timothy.mcdaniel@intel.com>

The patch should have some description and
Please change the subject to: "doc: eventdev ABI change to support DLB PMD"

>
> Signed-off-by: McDaniel, Timothy <timothy.mcdaniel@intel.com>

We don't use "," in the Signed-off-by.
Please change to ``Signed-off-by: McDaniel Timothy
<timothy.mcdaniel@intel.com>``

> ---
>  doc/guides/rel_notes/deprecation.rst |   11 +++++++++++
>  1 file changed, 11 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 99c9806..b9682a7 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -148,3 +148,14 @@ Deprecation Notices
>    Python 2 support will be completely removed in 20.11.
>    In 20.08, explicit deprecation warnings will be displayed when running
>    scripts with Python 2.
> +
> +* eventdev: ABI change to support DLB PMD and future extensions
> +  The following structures and will be modified to support to DLB PMD and future
> +  extension in the eventdev library.
> +  - ``rte_event_dev_info``
> +  - ``rte_event_dev_config``
> +  - ``rte_event_port_conf``
> +  Patches containing justification, documentation, and proposed modifications
> +  can be found at:
> +  - https://patches.dpdk.org/patch/71457/
> +  - https://patches.dpdk.org/patch/71456/

The HTML rendering of the above text is not proper.
Please run  "make doc-guides-html" to check generated HTML output.

You could use the below text as an example for sphinx syntax.

* eventdev: ABI change to support DLB PMD and future extensions:
  ``rte_event_dev_info``, ``rte_event_dev_config``, ``rte_event_port_conf`` will
  be modified to support to DLB PMD and future extension in the
eventdev library.
  Patches containing justification, documentation, and proposed modifications
  can be found at:

  - https://patches.dpdk.org/patch/71457/
  - https://patches.dpdk.org/patch/71456/

With the above changes:

Acked-by: Jerin Jacob <jerinj@marvell.com>


> --
> 1.7.10
>

  reply index

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-02 22:13 McDaniel, Timothy
2020-07-30 16:33 ` McDaniel, Timothy
2020-07-30 18:48   ` Jerin Jacob
2020-07-31 18:51 ` McDaniel, Timothy
2020-07-31 19:03   ` Jerin Jacob
2020-07-31 19:31 ` McDaniel, Timothy
2020-08-03  6:09   ` Jerin Jacob [this message]
2020-08-03 17:55     ` [dpdk-dev] [PATCH] doc: eventdev ABI change to support DLB PMD McDaniel, Timothy
2020-08-04  7:38       ` Jerin Jacob
2020-08-04 15:44         ` Hemant Agrawal
2020-08-05 23:39           ` Thomas Monjalon
2020-08-07 16:21             ` McDaniel, Timothy
2020-08-04 13:46       ` Van Haaren, Harry
2020-08-05  9:36 ` [dpdk-dev] [PATCH] doc: announce changes to eventdev public data structures Kinsella, Ray
2020-08-05 23:46   ` Thomas Monjalon

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='CALBAE1Oa=gRj5EgG4jmGi3LDN7akj6=czgvoY5GPJGfdHtb7aw@mail.gmail.com' \
    --to=jerinjacobk@gmail.com \
    --cc=dev@dpdk.org \
    --cc=gage.eads@intel.com \
    --cc=harry.van.haaren@intel.com \
    --cc=jerinj@marvell.com \
    --cc=mattias.ronnblom@ericsson.com \
    --cc=timothy.mcdaniel@intel.com \
    /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

DPDK-dev Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/dpdk-dev/0 dpdk-dev/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 dpdk-dev dpdk-dev/ https://lore.kernel.org/dpdk-dev \
		dev@dpdk.org
	public-inbox-index dpdk-dev

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.dpdk.dev


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git