[dpdk-dev,v2] PCI: ABI change request for adding new field in rte_pci_id structure

  From: Ziye <ziye.yang@intel.com>

The purpose of this patch is used to add a new field
"class" in rte_pci_id structure. The new class field includes
class_id, subcalss_id, programming interface of a pci device.
With this field, we can identify pci device by its class info,
which can be more flexible instead of probing the device by
vendor_id OR device_id OR subvendor_id OR subdevice_id.
For example, we can probe all nvme devices by class field, which
can be quite convenient.

As release_2_3.rst is replaced with release_16_04.rst.

Signed-off-by: Ziye Yang <ziye.yang@intel.com>
---
 doc/guides/rel_notes/release_16_04.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
  

On Tue, Feb 16, 2016 at 12:15:19PM +0800, Ziye Yang wrote:
> From: Ziye <ziye.yang@intel.com>
> 
> The purpose of this patch is used to add a new field
> "class" in rte_pci_id structure. The new class field includes
> class_id, subcalss_id, programming interface of a pci device.
> With this field, we can identify pci device by its class info,
> which can be more flexible instead of probing the device by
> vendor_id OR device_id OR subvendor_id OR subdevice_id.
> For example, we can probe all nvme devices by class field, which
> can be quite convenient.
> 
> As release_2_3.rst is replaced with release_16_04.rst.
> 
> Signed-off-by: Ziye Yang <ziye.yang@intel.com>
> ---
>  doc/guides/rel_notes/release_16_04.rst | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
> 
> diff --git a/doc/guides/rel_notes/release_16_04.rst b/doc/guides/rel_notes/release_16_04.rst
> index 27fc624..fe843a5 100644
> --- a/doc/guides/rel_notes/release_16_04.rst
> +++ b/doc/guides/rel_notes/release_16_04.rst
> @@ -95,9 +95,10 @@ This section should contain API changes. Sample format:
>  ABI Changes
>  -----------
>  
> -* Add a short 1-2 sentence description of the ABI change that was announced in
> -  the previous releases and made in this release. Use fixed width quotes for
> -  ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
> +* New field ``class`` is added into ``rte_pci_id`` structure. This new
> +  added ``class`` field can be used to probe pci devices by class related
> +  info. With this new field, the size of structure ``rte_pci_device`` will
> +  be increased.
>  
>  
>  Shared Library Versions
> -- 

Hi,

since this is new ABI change announcement, and not one that was previously
announced and is now being applied, this announcement should go in the 
deprecation.rst file, rather than release_16_04.rst.

Thomas, is there some reason why the deprecation notices are not called out in
the release notes for a new release? Why are they kept separately?

/Bruce
  

2016-02-16 10:11, Bruce Richardson:
> Thomas, is there some reason why the deprecation notices are not called out in
> the release notes for a new release? Why are they kept separately?

No strong reason.
It is part of the release notes but not in the versioned section.
Probably because there is no interest in keeping the history of planned
deprecations in the release notes. When the API/ABI is changed, the deprecation
notice is replaced by an entry in the versioned section.