[v2,20.08,4/6] doc: announce deprecation blacklist/whitelist
Checks
Commit Message
Announce upcoming changes for 20.11.
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
doc/guides/rel_notes/deprecation.rst | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
Comments
On Wed, Jul 29, 2020 at 05:58:02PM -0700, Stephen Hemminger wrote:
> Announce upcoming changes for 20.11.
>
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> ---
> doc/guides/rel_notes/deprecation.rst | 21 +++++++++++++++++++++
> 1 file changed, 21 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 7c60779f3e68..abfec0aeaa4b 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -165,3 +165,24 @@ Deprecation Notices
>
> The ``master-lcore`` argument to testpmd will be replaced
> with ``initial-lcore``.
> +
> +* eal: The terms blacklist and whitelist to describe devices used
> + by DPDK will be replaced in the 20.11 relase.
> + This will apply to command line arguments as well as macros.
> +
> + The macro ``RTE_DEV_BLACKLISTED`` will be replaced with ``RTE_DEV_EXCLUDED``
> + and ``RTE_DEV_WHITELISTED`` will be replaced with ``RTE_DEV_INCLUDED``
> + ``RTE_BUS_SCAN_BLACKLIST`` and ``RTE_BUS_SCAN_WHITELIST`` will be
> + replaced with ``RTE_BUS_SCAN_EXCLUDED`` and ``RTE_BUS_SCAN_INCLUDED``
> + respectively. Likewise ``RTE_DEVTYPE_BLACKLISTED_PCI`` and
> + ``RTE_DEVTYPE_WHITELISTED_PCI`` will be replaced with
> + ``RTE_DEVTYPE_EXCLUDED`` and ``RTE_DEVTYPE_INCLUDED``.
> +
> + The old macros will be marked as deprecated in 20.11 and removed
> + in the 21.11 release.
> +
Since these are macros and therefore not part of the ABI I think we can
remove them sooner than 21.11. Therefore similar to the previous patch can
we just use "future" relase rather than 21.11
> + The command line arguments to ``rte_eal_init`` will change from
> + ``-b, --pci-blacklist`` to ``-x, --exclude`` and
> + ``-w, --pci-whitelist`` to ``-i, --include``.
> + The old command line arguments will continue to be accepted in 20.11
> + but will cause a runtime error message.
> --
Error message, or warning message?
Overall, though
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
On Thu, 30 Jul 2020 09:45:19 +0100
Bruce Richardson <bruce.richardson@intel.com> wrote:
> On Wed, Jul 29, 2020 at 05:58:02PM -0700, Stephen Hemminger wrote:
> > Announce upcoming changes for 20.11.
> >
> > Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> > ---
> > doc/guides/rel_notes/deprecation.rst | 21 +++++++++++++++++++++
> > 1 file changed, 21 insertions(+)
> >
> > diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> > index 7c60779f3e68..abfec0aeaa4b 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -165,3 +165,24 @@ Deprecation Notices
> >
> > The ``master-lcore`` argument to testpmd will be replaced
> > with ``initial-lcore``.
> > +
> > +* eal: The terms blacklist and whitelist to describe devices used
> > + by DPDK will be replaced in the 20.11 relase.
> > + This will apply to command line arguments as well as macros.
> > +
> > + The macro ``RTE_DEV_BLACKLISTED`` will be replaced with ``RTE_DEV_EXCLUDED``
> > + and ``RTE_DEV_WHITELISTED`` will be replaced with ``RTE_DEV_INCLUDED``
> > + ``RTE_BUS_SCAN_BLACKLIST`` and ``RTE_BUS_SCAN_WHITELIST`` will be
> > + replaced with ``RTE_BUS_SCAN_EXCLUDED`` and ``RTE_BUS_SCAN_INCLUDED``
> > + respectively. Likewise ``RTE_DEVTYPE_BLACKLISTED_PCI`` and
> > + ``RTE_DEVTYPE_WHITELISTED_PCI`` will be replaced with
> > + ``RTE_DEVTYPE_EXCLUDED`` and ``RTE_DEVTYPE_INCLUDED``.
> > +
> > + The old macros will be marked as deprecated in 20.11 and removed
> > + in the 21.11 release.
> > +
>
> Since these are macros and therefore not part of the ABI I think we can
> remove them sooner than 21.11. Therefore similar to the previous patch can
> we just use "future" relase rather than 21.11
If these are internal, we don't need to wrap them in 21.11.
> > + The command line arguments to ``rte_eal_init`` will change from
> > + ``-b, --pci-blacklist`` to ``-x, --exclude`` and
> > + ``-w, --pci-whitelist`` to ``-i, --include``.
> > + The old command line arguments will continue to be accepted in 20.11
> > + but will cause a runtime error message.
> > --
>
> Error message, or warning message?
Some message to standard error and keep going.
>
> Overall, though
>
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
@@ -165,3 +165,24 @@ Deprecation Notices
The ``master-lcore`` argument to testpmd will be replaced
with ``initial-lcore``.
+
+* eal: The terms blacklist and whitelist to describe devices used
+ by DPDK will be replaced in the 20.11 relase.
+ This will apply to command line arguments as well as macros.
+
+ The macro ``RTE_DEV_BLACKLISTED`` will be replaced with ``RTE_DEV_EXCLUDED``
+ and ``RTE_DEV_WHITELISTED`` will be replaced with ``RTE_DEV_INCLUDED``
+ ``RTE_BUS_SCAN_BLACKLIST`` and ``RTE_BUS_SCAN_WHITELIST`` will be
+ replaced with ``RTE_BUS_SCAN_EXCLUDED`` and ``RTE_BUS_SCAN_INCLUDED``
+ respectively. Likewise ``RTE_DEVTYPE_BLACKLISTED_PCI`` and
+ ``RTE_DEVTYPE_WHITELISTED_PCI`` will be replaced with
+ ``RTE_DEVTYPE_EXCLUDED`` and ``RTE_DEVTYPE_INCLUDED``.
+
+ The old macros will be marked as deprecated in 20.11 and removed
+ in the 21.11 release.
+
+ The command line arguments to ``rte_eal_init`` will change from
+ ``-b, --pci-blacklist`` to ``-x, --exclude`` and
+ ``-w, --pci-whitelist`` to ``-i, --include``.
+ The old command line arguments will continue to be accepted in 20.11
+ but will cause a runtime error message.