[v2] doc: clarify PMD order in release notes

Message ID 20210512160443.1155817-1-ferruh.yigit@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series [v2] doc: clarify PMD order in release notes |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/github-robot success github build: passed
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS

Commit Message

Ferruh Yigit May 12, 2021, 4:04 p.m. UTC
  PMD updates are expected in alphabetical order based on their vendor
name. Clarify this expectation in the section comment.

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
v2:
* Do not restrict clarification for ethdev
---
 doc/guides/rel_notes/release_21_05.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Comments

Thomas Monjalon May 19, 2021, 8:42 p.m. UTC | #1
12/05/2021 18:04, Ferruh Yigit:
> PMD updates are expected in alphabetical order based on their vendor
> name. Clarify this expectation in the section comment.
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> ---
> -     * Device abstraction libs and PMDs
> +     * Device abstraction libs and PMDs (PMDs ordered alphabetically by vendor name)

I would avoid the repetition of "PMDs".
May I apply with this modification?
  
Ferruh Yigit May 19, 2021, 11:06 p.m. UTC | #2
On 5/19/2021 9:42 PM, Thomas Monjalon wrote:
> 12/05/2021 18:04, Ferruh Yigit:
>> PMD updates are expected in alphabetical order based on their vendor
>> name. Clarify this expectation in the section comment.
>>
>> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
>> ---
>> -     * Device abstraction libs and PMDs
>> +     * Device abstraction libs and PMDs (PMDs ordered alphabetically by vendor name)
> 
> I would avoid the repetition of "PMDs".
> May I apply with this modification?
> 

Ack, if it is not too late.
  
Thomas Monjalon May 20, 2021, 7:34 a.m. UTC | #3
20/05/2021 01:06, Ferruh Yigit:
> On 5/19/2021 9:42 PM, Thomas Monjalon wrote:
> > 12/05/2021 18:04, Ferruh Yigit:
> >> PMD updates are expected in alphabetical order based on their vendor
> >> name. Clarify this expectation in the section comment.
> >>
> >> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> >> ---
> >> -     * Device abstraction libs and PMDs
> >> +     * Device abstraction libs and PMDs (PMDs ordered alphabetically by vendor name)
> > 
> > I would avoid the repetition of "PMDs".
> > May I apply with this modification?
> 
> Ack, if it is not too late.

Applied, thanks
  

Patch

diff --git a/doc/guides/rel_notes/release_21_05.rst b/doc/guides/rel_notes/release_21_05.rst
index b144ae9e9dbc..b56d66d2a245 100644
--- a/doc/guides/rel_notes/release_21_05.rst
+++ b/doc/guides/rel_notes/release_21_05.rst
@@ -43,7 +43,7 @@  New Features
 
      Suggested order in release notes items:
      * Core libs (EAL, mempool, ring, mbuf, buses)
-     * Device abstraction libs and PMDs
+     * Device abstraction libs and PMDs (PMDs ordered alphabetically by vendor name)
        - ethdev (lib, PMDs)
        - cryptodev (lib, PMDs)
        - eventdev (lib, PMDs)