[6/6] doc: remove internal libs from release notes

Message ID 20181015145057.37864-6-ferruh.yigit@intel.com (mailing list archive)
State Rejected, archived
Delegated to: Thomas Monjalon
Headers
Series [1/6] doc: add missing shared library versions to release notes |

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Ferruh Yigit Oct. 15, 2018, 2:50 p.m. UTC
  These libraries has exported functions but the target of those functions
are not user but other libraries.

The version of these libraries doesn't mean much to the user so can be
dropped from release notes.

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
Indeed this is more a question, should we keep them or remove them?
---
 doc/guides/rel_notes/release_18_11.rst | 7 -------
 1 file changed, 7 deletions(-)
  

Comments

Shreyansh Jain Oct. 16, 2018, 11:52 a.m. UTC | #1
On Monday 15 October 2018 08:20 PM, Ferruh Yigit wrote:
> These libraries has exported functions but the target of those functions
> are not user but other libraries.
> 
> The version of these libraries doesn't mean much to the user so can be
> dropped from release notes.
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> ---
> Indeed this is more a question, should we keep them or remove them?

+1 for removing them.
At least for dpaa/fslmc perspective, I don't see any additional benefit 
in release note. These libraries (dpaa/fslmc) are not actually 
'libraries' in true (read, plugability) sense :)

> ---
>   doc/guides/rel_notes/release_18_11.rst | 7 -------
>   1 file changed, 7 deletions(-)
> 
> diff --git a/doc/guides/rel_notes/release_18_11.rst b/doc/guides/rel_notes/release_18_11.rst
> index 03f73484e..8b755a7e9 100644
> --- a/doc/guides/rel_notes/release_18_11.rst
> +++ b/doc/guides/rel_notes/release_18_11.rst
> @@ -291,12 +291,6 @@ The libraries prepended with a plus sign were incremented in this version.
>        librte_bbdev.so.1
>        librte_bitratestats.so.2
>        librte_bpf.so.1
> -   + librte_bus_dpaa.so.2
> -   + librte_bus_fslmc.so.2
> -   + librte_bus_ifpga.so.2
> -   + librte_bus_pci.so.2
> -   + librte_bus_vdev.so.2
> -   + librte_bus_vmbus.so.2
>        librte_cfgfile.so.2
>        librte_cmdline.so.2
>        librte_compressdev.so.1
> @@ -322,7 +316,6 @@ The libraries prepended with a plus sign were incremented in this version.
>        librte_meter.so.2
>        librte_metrics.so.1
>        librte_net.so.1
> -     librte_pci.so.1
>        librte_pdump.so.2
>        librte_pipeline.so.3
>        librte_pmd_bnxt.so.2
>
  
Thomas Monjalon Oct. 25, 2018, 12:07 a.m. UTC | #2
16/10/2018 13:52, Shreyansh Jain:
> On Monday 15 October 2018 08:20 PM, Ferruh Yigit wrote:
> > These libraries has exported functions but the target of those functions
> > are not user but other libraries.
> > 
> > The version of these libraries doesn't mean much to the user so can be
> > dropped from release notes.
> > 
> > Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> > ---
> > Indeed this is more a question, should we keep them or remove them?
> 
> +1 for removing them.
> At least for dpaa/fslmc perspective, I don't see any additional benefit 
> in release note. These libraries (dpaa/fslmc) are not actually 
> 'libraries' in true (read, plugability) sense :)

> > --- a/doc/guides/rel_notes/release_18_11.rst
> > +++ b/doc/guides/rel_notes/release_18_11.rst
> > -   + librte_bus_dpaa.so.2
> > -   + librte_bus_fslmc.so.2
> > -   + librte_bus_ifpga.so.2
> > -   + librte_bus_pci.so.2
> > -   + librte_bus_vdev.so.2
> > -   + librte_bus_vmbus.so.2

The ABI of bus libraries is important if you want to plug a PMD
into an older DPDK: if bus ABI has changed, you cannot.
I am for keeping them.

> > -     librte_pci.so.1

This is a true library!
  

Patch

diff --git a/doc/guides/rel_notes/release_18_11.rst b/doc/guides/rel_notes/release_18_11.rst
index 03f73484e..8b755a7e9 100644
--- a/doc/guides/rel_notes/release_18_11.rst
+++ b/doc/guides/rel_notes/release_18_11.rst
@@ -291,12 +291,6 @@  The libraries prepended with a plus sign were incremented in this version.
      librte_bbdev.so.1
      librte_bitratestats.so.2
      librte_bpf.so.1
-   + librte_bus_dpaa.so.2
-   + librte_bus_fslmc.so.2
-   + librte_bus_ifpga.so.2
-   + librte_bus_pci.so.2
-   + librte_bus_vdev.so.2
-   + librte_bus_vmbus.so.2
      librte_cfgfile.so.2
      librte_cmdline.so.2
      librte_compressdev.so.1
@@ -322,7 +316,6 @@  The libraries prepended with a plus sign were incremented in this version.
      librte_meter.so.2
      librte_metrics.so.1
      librte_net.so.1
-     librte_pci.so.1
      librte_pdump.so.2
      librte_pipeline.so.3
      librte_pmd_bnxt.so.2