Skip to contentSkip to conversation

doc: remove references to the old build system

PATCH Superseded Thomas Monjalon 3 participants 5 messages Sep 15, 2021 – Sep 23, 2021

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: remove references to the old build system

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.

---
 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(-)
doc/guides/contributing/abi_versioning.rst +1 -2
index 7ff18f4f74..dd96527ee5 100644
@@ -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:
doc/guides/linux_gsg/build_dpdk.rst +1 -2
index 0b08492ca2..738a0f4aa3 100644
@@ -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
doc/guides/rel_notes/release_21_11.rst +2 -2
index 43d367bcad..6f5393dc83 100644
@@ -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
drivers/common/mlx5/linux/meson.build +0 -2
index 6abf27ce63..cbea58f557 100644
@@ -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" ]
drivers/net/mlx4/meson.build +0 -2
index 5ab6b7f16d..99a30eab8f 100644
@@ -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" ]
drivers/net/tap/meson.build +0 -2
index 43fd7775e6..c09713a67b 100644
@@ -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" ]
Signature · 1 line
2.33.0
Acked-by on v1 1/1
#1 lore raw
Quoted 14 lines · Thomas Monjalon

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.

---
 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>

doc/guides/linux_gsg/build_dpdk.rst and the sources for that build are stored in ``$(SRCS-y)``. · line 197

Quoted 7 lines
doc/guides/linux_gsg/build_dpdk.rst +1 -2
-   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:

#3 lore raw

PATCH v2 1/1 doc: remove references to the old build system

In reply to Thomas Monjalon

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.

---
v2: keep comparison with make in build guide longer

---
 doc/guides/contributing/abi_versioning.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 --
 5 files changed, 3 insertions(+), 10 deletions(-)
doc/guides/contributing/abi_versioning.rst +1 -2
index 7ff18f4f74..dd96527ee5 100644
@@ -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:
doc/guides/rel_notes/release_21_11.rst +2 -2
index 68b6405ae0..ad7c1afec0 100644
@@ -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
drivers/common/mlx5/linux/meson.build +0 -2
index 6abf27ce63..cbea58f557 100644
@@ -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" ]
drivers/net/mlx4/meson.build +0 -2
index 5ab6b7f16d..99a30eab8f 100644
@@ -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" ]
drivers/net/tap/meson.build +0 -2
index 43fd7775e6..c09713a67b 100644
@@ -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" ]
Signature · 1 line
2.33.0