[RFC,0/2] standardize rawdev names

  The names of the rawdev drivers and the resultant libraries they built
were pretty inconsistent. In terms of directory names, some had "rawdev"
in the name, e.g. skeleton_rawdev, ifpga_rawdev, while others didn't.
Also, for the built .so/.a libraries, the names were not always
consistent between make and meson, as, while meson enforced a consistent
naming scheme, make did not, leading to differences - especially for
those drivers with "rawdev" in the directory name.

This patchset attempts to make things more standardized by removing
"rawdev" from all directory names - the drivers are in the "drivers/raw"
directory after all - and then standardizing the library names to
"librte_rawdev_<name>" for both make and meson.

Bruce Richardson (2):
  drivers/raw: remove rawdev from driver directory names
  drivers/raw: standardize name format of rawdev drivers

 drivers/raw/Makefile                                   |  4 ++--
 drivers/raw/dpaa2_cmdif/Makefile                       |  4 ++--
 ..._version.map => rte_rawdev_dpaa2_cmdif_version.map} |  0
 drivers/raw/dpaa2_qdma/Makefile                        |  4 ++--
 ...a_version.map => rte_rawdev_dpaa2_qdma_version.map} |  0
 drivers/raw/{ifpga_rawdev => ifpga}/Makefile           |  6 +++---
 drivers/raw/{ifpga_rawdev => ifpga}/base/Makefile      |  0
 drivers/raw/{ifpga_rawdev => ifpga}/base/README        |  0
 drivers/raw/{ifpga_rawdev => ifpga}/base/ifpga_api.c   |  0
 drivers/raw/{ifpga_rawdev => ifpga}/base/ifpga_api.h   |  0
 .../raw/{ifpga_rawdev => ifpga}/base/ifpga_compat.h    |  0
 .../raw/{ifpga_rawdev => ifpga}/base/ifpga_defines.h   |  0
 .../raw/{ifpga_rawdev => ifpga}/base/ifpga_enumerate.c |  0
 .../raw/{ifpga_rawdev => ifpga}/base/ifpga_enumerate.h |  0
 .../{ifpga_rawdev => ifpga}/base/ifpga_feature_dev.c   |  0
 .../{ifpga_rawdev => ifpga}/base/ifpga_feature_dev.h   |  0
 drivers/raw/{ifpga_rawdev => ifpga}/base/ifpga_fme.c   |  0
 .../raw/{ifpga_rawdev => ifpga}/base/ifpga_fme_dperf.c |  0
 .../raw/{ifpga_rawdev => ifpga}/base/ifpga_fme_error.c |  0
 .../raw/{ifpga_rawdev => ifpga}/base/ifpga_fme_iperf.c |  0
 .../raw/{ifpga_rawdev => ifpga}/base/ifpga_fme_pr.c    |  0
 drivers/raw/{ifpga_rawdev => ifpga}/base/ifpga_hw.h    |  0
 drivers/raw/{ifpga_rawdev => ifpga}/base/ifpga_port.c  |  0
 .../{ifpga_rawdev => ifpga}/base/ifpga_port_error.c    |  0
 drivers/raw/{ifpga_rawdev => ifpga}/base/meson.build   |  0
 .../{ifpga_rawdev => ifpga}/base/opae_at24_eeprom.c    |  0
 .../{ifpga_rawdev => ifpga}/base/opae_at24_eeprom.h    |  0
 drivers/raw/{ifpga_rawdev => ifpga}/base/opae_debug.c  |  0
 drivers/raw/{ifpga_rawdev => ifpga}/base/opae_debug.h  |  0
 .../raw/{ifpga_rawdev => ifpga}/base/opae_eth_group.c  |  0
 .../raw/{ifpga_rawdev => ifpga}/base/opae_eth_group.h  |  0
 drivers/raw/{ifpga_rawdev => ifpga}/base/opae_hw_api.c |  0
 drivers/raw/{ifpga_rawdev => ifpga}/base/opae_hw_api.h |  0
 drivers/raw/{ifpga_rawdev => ifpga}/base/opae_i2c.c    |  0
 drivers/raw/{ifpga_rawdev => ifpga}/base/opae_i2c.h    |  0
 .../{ifpga_rawdev => ifpga}/base/opae_ifpga_hw_api.c   |  0
 .../{ifpga_rawdev => ifpga}/base/opae_ifpga_hw_api.h   |  0
 .../{ifpga_rawdev => ifpga}/base/opae_intel_max10.c    |  0
 .../{ifpga_rawdev => ifpga}/base/opae_intel_max10.h    |  0
 drivers/raw/{ifpga_rawdev => ifpga}/base/opae_osdep.h  |  0
 drivers/raw/{ifpga_rawdev => ifpga}/base/opae_spi.c    |  0
 drivers/raw/{ifpga_rawdev => ifpga}/base/opae_spi.h    |  0
 .../base/opae_spi_transaction.c                        |  0
 .../base/osdep_raw/osdep_generic.h                     |  0
 .../base/osdep_rte/osdep_generic.h                     |  0
 drivers/raw/{ifpga_rawdev => ifpga}/ifpga_rawdev.c     |  0
 drivers/raw/{ifpga_rawdev => ifpga}/ifpga_rawdev.h     |  0
 drivers/raw/{ifpga_rawdev => ifpga}/meson.build        |  0
 .../rte_rawdev_ifpga_version.map}                      |  0
 drivers/raw/ioat/Makefile                              |  4 ++--
 ...md_ioat_version.map => rte_rawdev_ioat_version.map} |  0
 drivers/raw/meson.build                                |  6 +++---
 drivers/raw/{skeleton_rawdev => skeleton}/Makefile     |  4 ++--
 drivers/raw/{skeleton_rawdev => skeleton}/meson.build  |  0
 .../rte_rawdev_skeleton_version.map}                   |  0
 .../{skeleton_rawdev => skeleton}/skeleton_rawdev.c    |  0
 .../{skeleton_rawdev => skeleton}/skeleton_rawdev.h    |  0
 .../skeleton_rawdev_test.c                             |  0
 mk/rte.app.mk                                          | 10 +++++-----
 59 files changed, 21 insertions(+), 21 deletions(-)
 rename drivers/raw/dpaa2_cmdif/{rte_pmd_dpaa2_cmdif_version.map => rte_rawdev_dpaa2_cmdif_version.map} (100%)
 rename drivers/raw/dpaa2_qdma/{rte_pmd_dpaa2_qdma_version.map => rte_rawdev_dpaa2_qdma_version.map} (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/Makefile (82%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/Makefile (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/README (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/ifpga_api.c (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/ifpga_api.h (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/ifpga_compat.h (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/ifpga_defines.h (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/ifpga_enumerate.c (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/ifpga_enumerate.h (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/ifpga_feature_dev.c (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/ifpga_feature_dev.h (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/ifpga_fme.c (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/ifpga_fme_dperf.c (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/ifpga_fme_error.c (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/ifpga_fme_iperf.c (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/ifpga_fme_pr.c (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/ifpga_hw.h (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/ifpga_port.c (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/ifpga_port_error.c (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/meson.build (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/opae_at24_eeprom.c (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/opae_at24_eeprom.h (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/opae_debug.c (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/opae_debug.h (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/opae_eth_group.c (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/opae_eth_group.h (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/opae_hw_api.c (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/opae_hw_api.h (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/opae_i2c.c (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/opae_i2c.h (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/opae_ifpga_hw_api.c (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/opae_ifpga_hw_api.h (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/opae_intel_max10.c (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/opae_intel_max10.h (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/opae_osdep.h (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/opae_spi.c (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/opae_spi.h (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/opae_spi_transaction.c (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/osdep_raw/osdep_generic.h (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/base/osdep_rte/osdep_generic.h (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/ifpga_rawdev.c (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/ifpga_rawdev.h (100%)
 rename drivers/raw/{ifpga_rawdev => ifpga}/meson.build (100%)
 rename drivers/raw/{ifpga_rawdev/rte_pmd_ifpga_rawdev_version.map => ifpga/rte_rawdev_ifpga_version.map} (100%)
 rename drivers/raw/ioat/{rte_pmd_ioat_version.map => rte_rawdev_ioat_version.map} (100%)
 rename drivers/raw/{skeleton_rawdev => skeleton}/Makefile (84%)
 rename drivers/raw/{skeleton_rawdev => skeleton}/meson.build (100%)
 rename drivers/raw/{skeleton_rawdev/rte_pmd_skeleton_rawdev_version.map => skeleton/rte_rawdev_skeleton_version.map} (100%)
 rename drivers/raw/{skeleton_rawdev => skeleton}/skeleton_rawdev.c (100%)
 rename drivers/raw/{skeleton_rawdev => skeleton}/skeleton_rawdev.h (100%)
 rename drivers/raw/{skeleton_rawdev => skeleton}/skeleton_rawdev_test.c (100%)
  

On Fri, Jul 05, 2019 at 10:33:59AM +0100, Bruce Richardson wrote:
> The names of the rawdev drivers and the resultant libraries they built
> were pretty inconsistent. In terms of directory names, some had "rawdev"
> in the name, e.g. skeleton_rawdev, ifpga_rawdev, while others didn't.
> Also, for the built .so/.a libraries, the names were not always
> consistent between make and meson, as, while meson enforced a consistent
> naming scheme, make did not, leading to differences - especially for
> those drivers with "rawdev" in the directory name.
> 
> This patchset attempts to make things more standardized by removing
> "rawdev" from all directory names - the drivers are in the "drivers/raw"
> directory after all - and then standardizing the library names to
> "librte_rawdev_<name>" for both make and meson.
> 
> Bruce Richardson (2): drivers/raw: remove rawdev from driver directory
> names drivers/raw: standardize name format of rawdev drivers
> 
Since the .so/.a files we produce are changing, would this patchset - if
accepted - need a deprecation notice in 19.08 for a future 19.11 merge?
  

05/07/2019 11:35, Bruce Richardson:
> On Fri, Jul 05, 2019 at 10:33:59AM +0100, Bruce Richardson wrote:
> > The names of the rawdev drivers and the resultant libraries they built
> > were pretty inconsistent. In terms of directory names, some had "rawdev"
> > in the name, e.g. skeleton_rawdev, ifpga_rawdev, while others didn't.
> > Also, for the built .so/.a libraries, the names were not always
> > consistent between make and meson, as, while meson enforced a consistent
> > naming scheme, make did not, leading to differences - especially for
> > those drivers with "rawdev" in the directory name.
> > 
> > This patchset attempts to make things more standardized by removing
> > "rawdev" from all directory names - the drivers are in the "drivers/raw"
> > directory after all - and then standardizing the library names to
> > "librte_rawdev_<name>" for both make and meson.
> > 
> > Bruce Richardson (2): drivers/raw: remove rawdev from driver directory
> > names drivers/raw: standardize name format of rawdev drivers
> > 
> Since the .so/.a files we produce are changing, would this patchset - if
> accepted - need a deprecation notice in 19.08 for a future 19.11 merge?

I would say we can merge it in 19.08 without prior notice.
Any other opinion?
  

05/07/2019 11:38, Thomas Monjalon:
> 05/07/2019 11:35, Bruce Richardson:
> > On Fri, Jul 05, 2019 at 10:33:59AM +0100, Bruce Richardson wrote:
> > > The names of the rawdev drivers and the resultant libraries they built
> > > were pretty inconsistent. In terms of directory names, some had "rawdev"
> > > in the name, e.g. skeleton_rawdev, ifpga_rawdev, while others didn't.
> > > Also, for the built .so/.a libraries, the names were not always
> > > consistent between make and meson, as, while meson enforced a consistent
> > > naming scheme, make did not, leading to differences - especially for
> > > those drivers with "rawdev" in the directory name.
> > > 
> > > This patchset attempts to make things more standardized by removing
> > > "rawdev" from all directory names - the drivers are in the "drivers/raw"
> > > directory after all - and then standardizing the library names to
> > > "librte_rawdev_<name>" for both make and meson.
> > > 
> > > Bruce Richardson (2): drivers/raw: remove rawdev from driver directory
> > > names drivers/raw: standardize name format of rawdev drivers
> > > 
> > Since the .so/.a files we produce are changing, would this patchset - if
> > accepted - need a deprecation notice in 19.08 for a future 19.11 merge?
> 
> I would say we can merge it in 19.08 without prior notice.
> Any other opinion?

Cc Neil
  

05/07/2019 11:39, Thomas Monjalon:
> 05/07/2019 11:38, Thomas Monjalon:
> > 05/07/2019 11:35, Bruce Richardson:
> > > On Fri, Jul 05, 2019 at 10:33:59AM +0100, Bruce Richardson wrote:
> > > > The names of the rawdev drivers and the resultant libraries they built
> > > > were pretty inconsistent. In terms of directory names, some had "rawdev"
> > > > in the name, e.g. skeleton_rawdev, ifpga_rawdev, while others didn't.
> > > > Also, for the built .so/.a libraries, the names were not always
> > > > consistent between make and meson, as, while meson enforced a consistent
> > > > naming scheme, make did not, leading to differences - especially for
> > > > those drivers with "rawdev" in the directory name.
> > > > 
> > > > This patchset attempts to make things more standardized by removing
> > > > "rawdev" from all directory names - the drivers are in the "drivers/raw"
> > > > directory after all - and then standardizing the library names to
> > > > "librte_rawdev_<name>" for both make and meson.
> > > > 
> > > > Bruce Richardson (2): drivers/raw: remove rawdev from driver directory
> > > > names drivers/raw: standardize name format of rawdev drivers
> > > > 
> > > Since the .so/.a files we produce are changing, would this patchset - if
> > > accepted - need a deprecation notice in 19.08 for a future 19.11 merge?
> > 
> > I would say we can merge it in 19.08 without prior notice.
> > Any other opinion?
> 
> Cc Neil

We got no more opinion.
Does it mean I can merge it in 19.08-rc3?
  

On Tue, Jul 30, 2019 at 10:17:46AM +0200, Thomas Monjalon wrote:
> 05/07/2019 11:39, Thomas Monjalon:
> > 05/07/2019 11:38, Thomas Monjalon:
> > > 05/07/2019 11:35, Bruce Richardson:
> > > > On Fri, Jul 05, 2019 at 10:33:59AM +0100, Bruce Richardson wrote:
> > > > > The names of the rawdev drivers and the resultant libraries they built
> > > > > were pretty inconsistent. In terms of directory names, some had "rawdev"
> > > > > in the name, e.g. skeleton_rawdev, ifpga_rawdev, while others didn't.
> > > > > Also, for the built .so/.a libraries, the names were not always
> > > > > consistent between make and meson, as, while meson enforced a consistent
> > > > > naming scheme, make did not, leading to differences - especially for
> > > > > those drivers with "rawdev" in the directory name.
> > > > > 
> > > > > This patchset attempts to make things more standardized by removing
> > > > > "rawdev" from all directory names - the drivers are in the "drivers/raw"
> > > > > directory after all - and then standardizing the library names to
> > > > > "librte_rawdev_<name>" for both make and meson.
> > > > > 
> > > > > Bruce Richardson (2): drivers/raw: remove rawdev from driver directory
> > > > > names drivers/raw: standardize name format of rawdev drivers
> > > > > 
> > > > Since the .so/.a files we produce are changing, would this patchset - if
> > > > accepted - need a deprecation notice in 19.08 for a future 19.11 merge?
> > > 
> > > I would say we can merge it in 19.08 without prior notice.
> > > Any other opinion?
> > 
> > Cc Neil
> 
> We got no more opinion.
> Does it mean I can merge it in 19.08-rc3?
> 

Seems like it should be safe enough to me. Rawdevs are pretty new and not
that widely used, I suspect. Any issues that do arise with the rename can
be resolved via symlink, so the risk is low, I suspect.

Regards,
/Bruce
  

On Tue, Jul 30, 2019 at 10:17:46AM +0200, Thomas Monjalon wrote:
> 05/07/2019 11:39, Thomas Monjalon:
> > 05/07/2019 11:38, Thomas Monjalon:
> > > 05/07/2019 11:35, Bruce Richardson:
> > > > On Fri, Jul 05, 2019 at 10:33:59AM +0100, Bruce Richardson wrote:
> > > > > The names of the rawdev drivers and the resultant libraries they built
> > > > > were pretty inconsistent. In terms of directory names, some had "rawdev"
> > > > > in the name, e.g. skeleton_rawdev, ifpga_rawdev, while others didn't.
> > > > > Also, for the built .so/.a libraries, the names were not always
> > > > > consistent between make and meson, as, while meson enforced a consistent
> > > > > naming scheme, make did not, leading to differences - especially for
> > > > > those drivers with "rawdev" in the directory name.
> > > > > 
> > > > > This patchset attempts to make things more standardized by removing
> > > > > "rawdev" from all directory names - the drivers are in the "drivers/raw"
> > > > > directory after all - and then standardizing the library names to
> > > > > "librte_rawdev_<name>" for both make and meson.
> > > > > 
> > > > > Bruce Richardson (2): drivers/raw: remove rawdev from driver directory
> > > > > names drivers/raw: standardize name format of rawdev drivers
> > > > > 
> > > > Since the .so/.a files we produce are changing, would this patchset - if
> > > > accepted - need a deprecation notice in 19.08 for a future 19.11 merge?
> > > 
> > > I would say we can merge it in 19.08 without prior notice.
> > > Any other opinion?
> > 
> > Cc Neil
> 
> We got no more opinion.
> Does it mean I can merge it in 19.08-rc3?
> 
> 
> 
Sorry, I meant to get to this and completely forgot.

I presume that this is solely a name change, and not a functional change,
correct?  

I would think if thats the case, you could just release note the switch, and
distributions could all linker files with the old names to maintain
compatibility.

Neil
  

30/07/2019 14:20, Neil Horman:
> On Tue, Jul 30, 2019 at 10:17:46AM +0200, Thomas Monjalon wrote:
> > 05/07/2019 11:39, Thomas Monjalon:
> > > 05/07/2019 11:38, Thomas Monjalon:
> > > > 05/07/2019 11:35, Bruce Richardson:
> > > > > On Fri, Jul 05, 2019 at 10:33:59AM +0100, Bruce Richardson wrote:
> > > > > > The names of the rawdev drivers and the resultant libraries they built
> > > > > > were pretty inconsistent. In terms of directory names, some had "rawdev"
> > > > > > in the name, e.g. skeleton_rawdev, ifpga_rawdev, while others didn't.
> > > > > > Also, for the built .so/.a libraries, the names were not always
> > > > > > consistent between make and meson, as, while meson enforced a consistent
> > > > > > naming scheme, make did not, leading to differences - especially for
> > > > > > those drivers with "rawdev" in the directory name.
> > > > > > 
> > > > > > This patchset attempts to make things more standardized by removing
> > > > > > "rawdev" from all directory names - the drivers are in the "drivers/raw"
> > > > > > directory after all - and then standardizing the library names to
> > > > > > "librte_rawdev_<name>" for both make and meson.
> > > > > > 
> > > > > > Bruce Richardson (2): drivers/raw: remove rawdev from driver directory
> > > > > > names drivers/raw: standardize name format of rawdev drivers
> > > > > > 
> > > > > Since the .so/.a files we produce are changing, would this patchset - if
> > > > > accepted - need a deprecation notice in 19.08 for a future 19.11 merge?
> > > > 
> > > > I would say we can merge it in 19.08 without prior notice.
> > > > Any other opinion?
> > > 
> > > Cc Neil
> > 
> > We got no more opinion.
> > Does it mean I can merge it in 19.08-rc3?
> > 
> > 
> > 
> Sorry, I meant to get to this and completely forgot.
> 
> I presume that this is solely a name change, and not a functional change,
> correct?

Correct

> I would think if thats the case, you could just release note the switch, and
> distributions could all linker files with the old names to maintain
> compatibility.

I am sending a v2 (rebased with new raw drivers),
and adding a note in the release notes.