doc: remove references to the old build system

Message ID 20210915162845.3000652-1-thomas@monjalon.net (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series doc: remove references to the old build system |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/github-robot: build success github build: passed
ci/iol-spell-check-testing warning Testing issues
ci/Intel-compilation success Compilation OK
ci/intel-Testing fail Testing issues
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS

Commit Message

Thomas Monjalon Sept. 15, 2021, 4:28 p.m. UTC
  Some docs and comments in Meson files are still mentioning
the old build system based on "make", removed in 20.11.
After one year, such references are better to be removed.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/contributing/abi_versioning.rst | 3 +--
 doc/guides/linux_gsg/build_dpdk.rst        | 3 +--
 doc/guides/rel_notes/release_21_11.rst     | 4 ++--
 drivers/common/mlx5/linux/meson.build      | 2 --
 drivers/net/mlx4/meson.build               | 2 --
 drivers/net/tap/meson.build                | 2 --
 6 files changed, 4 insertions(+), 12 deletions(-)
  

Comments

Bruce Richardson Sept. 15, 2021, 4:33 p.m. UTC | #1
On Wed, Sep 15, 2021 at 06:28:45PM +0200, Thomas Monjalon wrote:
> Some docs and comments in Meson files are still mentioning
> the old build system based on "make", removed in 20.11.
> After one year, such references are better to be removed.
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> ---
>  doc/guides/contributing/abi_versioning.rst | 3 +--
>  doc/guides/linux_gsg/build_dpdk.rst        | 3 +--
>  doc/guides/rel_notes/release_21_11.rst     | 4 ++--
>  drivers/common/mlx5/linux/meson.build      | 2 --
>  drivers/net/mlx4/meson.build               | 2 --
>  drivers/net/tap/meson.build                | 2 --
>  6 files changed, 4 insertions(+), 12 deletions(-)
> 
<snip>
>  
> -   Unlike with the make build system present in older DPDK releases,
> -   the meson system is not
> +   The meson system is not
>     designed to be used directly from a build directory. Instead it is
>     recommended that it be installed either system-wide or to a known
>     location in the user's home directory. The install location can be set

While the other removals look good to me, I suspect there are quite a few
users out there still working on old releases and building using make. This
comment therefore I feel could still be relevant and should be kept.

For the rest of the patch:
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
  
David Marchand Sept. 16, 2021, 2:35 p.m. UTC | #2
On Wed, Sep 15, 2021 at 6:28 PM Thomas Monjalon <thomas@monjalon.net> wrote:
>
> Some docs and comments in Meson files are still mentioning
> the old build system based on "make", removed in 20.11.
> After one year, such references are better to be removed.
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

Acked-by: David Marchand <david.marchand@redhat.com>
  

Patch

diff --git a/doc/guides/contributing/abi_versioning.rst b/doc/guides/contributing/abi_versioning.rst
index 7ff18f4f74..dd96527ee5 100644
--- a/doc/guides/contributing/abi_versioning.rst
+++ b/doc/guides/contributing/abi_versioning.rst
@@ -417,8 +417,7 @@  versioning, in the ``meson.build`` file we add the following
    use_function_versioning = true
 
 at the start of the head of the file. This will indicate to the tool-chain to
-enable the function version macros when building. There is no corresponding
-directive required for the ``make`` build system.
+enable the function version macros when building.
 
 
 .. _aliasing_experimental_symbols:
diff --git a/doc/guides/linux_gsg/build_dpdk.rst b/doc/guides/linux_gsg/build_dpdk.rst
index 0b08492ca2..738a0f4aa3 100644
--- a/doc/guides/linux_gsg/build_dpdk.rst
+++ b/doc/guides/linux_gsg/build_dpdk.rst
@@ -191,8 +191,7 @@  and the sources for that build are stored in ``$(SRCS-y)``.
 
 .. note::
 
-   Unlike with the make build system present in older DPDK releases,
-   the meson system is not
+   The meson system is not
    designed to be used directly from a build directory. Instead it is
    recommended that it be installed either system-wide or to a known
    location in the user's home directory. The install location can be set
diff --git a/doc/guides/rel_notes/release_21_11.rst b/doc/guides/rel_notes/release_21_11.rst
index 43d367bcad..6f5393dc83 100644
--- a/doc/guides/rel_notes/release_21_11.rst
+++ b/doc/guides/rel_notes/release_21_11.rst
@@ -17,8 +17,8 @@  DPDK Release 21.11
 
    Build the docs and view the output file to ensure the changes are correct::
 
-      make doc-guides-html
-      xdg-open build/doc/html/guides/rel_notes/release_21_11.html
+      ninja -C build doc
+      xdg-open build/doc/guides/html/rel_notes/release_21_11.html
 
 
 New Features
diff --git a/drivers/common/mlx5/linux/meson.build b/drivers/common/mlx5/linux/meson.build
index 6abf27ce63..cbea58f557 100644
--- a/drivers/common/mlx5/linux/meson.build
+++ b/drivers/common/mlx5/linux/meson.build
@@ -55,8 +55,6 @@  endif
 
 deps += ['bus_auxiliary']
 
-# To maintain the compatibility with the make build system
-# mlx5_autoconf.h file is still generated.
 # input array for meson member search:
 # [ "MACRO to define if found", "header for the search",
 #   "symbol to search", "struct member to search" ]
diff --git a/drivers/net/mlx4/meson.build b/drivers/net/mlx4/meson.build
index 5ab6b7f16d..99a30eab8f 100644
--- a/drivers/net/mlx4/meson.build
+++ b/drivers/net/mlx4/meson.build
@@ -83,8 +83,6 @@  if get_option('buildtype').contains('debug')
 else
     cflags += [ '-UPEDANTIC' ]
 endif
-# To maintain the compatibility with the make build system
-# mlx4_autoconf.h file is still generated.
 # input array for meson member search:
 # [ "MACRO to define if found", "header for the search",
 #   "symbol to search", "struct member to search" ]
diff --git a/drivers/net/tap/meson.build b/drivers/net/tap/meson.build
index 43fd7775e6..c09713a67b 100644
--- a/drivers/net/tap/meson.build
+++ b/drivers/net/tap/meson.build
@@ -18,8 +18,6 @@  deps = ['bus_vdev', 'gso', 'hash']
 
 cflags += '-DTAP_MAX_QUEUES=16'
 
-# To maintain the compatibility with the make build system
-# tap_autoconf.h file is still generated.
 # input array for meson symbol search:
 # [ "MACRO to define if found", "header for the search",
 #   "enum/define", "symbol to search" ]