doc: avoid meson deprecation in setup
Checks
Commit Message
The command "meson build" causes a deprecation warning with meson 0.64.0.
WARNING: Running the setup command as `meson [options]` instead of `meson setup [options]` is ambiguous and deprecated.
Therefore fix the examples in the documentation.
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
doc/guides/cryptodevs/armv8.rst | 2 +-
doc/guides/cryptodevs/uadk.rst | 2 +-
doc/guides/freebsd_gsg/build_dpdk.rst | 2 +-
doc/guides/gpus/cuda.rst | 4 ++--
doc/guides/howto/openwrt.rst | 4 ++--
doc/guides/nics/ark.rst | 2 +-
doc/guides/nics/mvneta.rst | 2 +-
doc/guides/nics/mvpp2.rst | 2 +-
doc/guides/platform/bluefield.rst | 4 ++--
doc/guides/platform/cnxk.rst | 4 ++--
doc/guides/platform/octeontx.rst | 8 ++++----
doc/guides/prog_guide/build-sdk-meson.rst | 4 ++--
doc/guides/prog_guide/lto.rst | 2 +-
doc/guides/prog_guide/profile_app.rst | 2 +-
doc/guides/sample_app_ug/vm_power_management.rst | 14 ++++++--------
15 files changed, 28 insertions(+), 30 deletions(-)
Comments
On Tue, Nov 15, 2022 at 09:35:16AM -0800, Stephen Hemminger wrote:
> The command "meson build" causes a deprecation warning with meson 0.64.0.
> WARNING: Running the setup command as `meson [options]` instead of `meson setup [options]` is ambiguous and deprecated.
>
> Therefore fix the examples in the documentation.
>
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> ---
> doc/guides/cryptodevs/armv8.rst | 2 +-
> doc/guides/cryptodevs/uadk.rst | 2 +-
> doc/guides/freebsd_gsg/build_dpdk.rst | 2 +-
> doc/guides/gpus/cuda.rst | 4 ++--
> doc/guides/howto/openwrt.rst | 4 ++--
> doc/guides/nics/ark.rst | 2 +-
> doc/guides/nics/mvneta.rst | 2 +-
> doc/guides/nics/mvpp2.rst | 2 +-
> doc/guides/platform/bluefield.rst | 4 ++--
> doc/guides/platform/cnxk.rst | 4 ++--
> doc/guides/platform/octeontx.rst | 8 ++++----
> doc/guides/prog_guide/build-sdk-meson.rst | 4 ++--
> doc/guides/prog_guide/lto.rst | 2 +-
> doc/guides/prog_guide/profile_app.rst | 2 +-
> doc/guides/sample_app_ug/vm_power_management.rst | 14 ++++++--------
> 15 files changed, 28 insertions(+), 30 deletions(-)
>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
The fact that this needs to be changed in so many places is indicative that
we need some cleanup in the docs - but then again, we knew that already!
:-)
On 2022/11/16 上午1:35, Stephen Hemminger wrote:
> The command "meson build" causes a deprecation warning with meson 0.64.0.
> WARNING: Running the setup command as `meson [options]` instead of `meson setup [options]` is ambiguous and deprecated.
>
> Therefore fix the examples in the documentation.
>
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
Thanks Stephen
For doc/guides/cryptodevs/uadk.rst
Acked-by: Zhangfei Gao <zhangfei.gao@linaro.org>
It will be great if updating https://core.dpdk.org/doc/quick-start/ as
well, here is what I learned from.
Thanks
On Tue, Nov 15, 2022 at 6:39 PM Bruce Richardson
<bruce.richardson@intel.com> wrote:
>
> On Tue, Nov 15, 2022 at 09:35:16AM -0800, Stephen Hemminger wrote:
> > The command "meson build" causes a deprecation warning with meson 0.64.0.
> > WARNING: Running the setup command as `meson [options]` instead of `meson setup [options]` is ambiguous and deprecated.
> >
> > Therefore fix the examples in the documentation.
> >
> > Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> > ---
> > doc/guides/cryptodevs/armv8.rst | 2 +-
> > doc/guides/cryptodevs/uadk.rst | 2 +-
> > doc/guides/freebsd_gsg/build_dpdk.rst | 2 +-
> > doc/guides/gpus/cuda.rst | 4 ++--
> > doc/guides/howto/openwrt.rst | 4 ++--
> > doc/guides/nics/ark.rst | 2 +-
> > doc/guides/nics/mvneta.rst | 2 +-
> > doc/guides/nics/mvpp2.rst | 2 +-
> > doc/guides/platform/bluefield.rst | 4 ++--
> > doc/guides/platform/cnxk.rst | 4 ++--
> > doc/guides/platform/octeontx.rst | 8 ++++----
> > doc/guides/prog_guide/build-sdk-meson.rst | 4 ++--
> > doc/guides/prog_guide/lto.rst | 2 +-
> > doc/guides/prog_guide/profile_app.rst | 2 +-
> > doc/guides/sample_app_ug/vm_power_management.rst | 14 ++++++--------
> > 15 files changed, 28 insertions(+), 30 deletions(-)
> >
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
>
> The fact that this needs to be changed in so many places is indicative that
> we need some cleanup in the docs - but then again, we knew that already!
> :-)
>
Indeed, and I see many places still showing the issue after the patch.
Stephen, can you look at other guides?
Thanks!
> -----Original Message-----
> From: Stephen Hemminger <stephen@networkplumber.org>
> Sent: Wednesday, November 16, 2022 1:35 AM
> To: dev@dpdk.org
> Cc: Stephen Hemminger <stephen@networkplumber.org>; Ruifeng Wang <Ruifeng.Wang@arm.com>;
> Zhangfei Gao <zhangfei.gao@linaro.org>; Bruce Richardson <bruce.richardson@intel.com>;
> Elena Agostini <eagostini@nvidia.com>; Shepard Siegel <shepard.siegel@atomicrules.com>; Ed
> Czeck <ed.czeck@atomicrules.com>; John Miller <john.miller@atomicrules.com>; Zyta Szpak
> <zr@semihalf.com>; Liron Himi <lironh@marvell.com>; Nithin Dabilpuram
> <ndabilpuram@marvell.com>; Kiran Kumar K <kirankumark@marvell.com>; Sunil Kumar Kori
> <skori@marvell.com>; Satha Rao <skoteshwar@marvell.com>; David Hunt <david.hunt@intel.com>
> Subject: [PATCH] doc: avoid meson deprecation in setup
>
> The command "meson build" causes a deprecation warning with meson 0.64.0.
> WARNING:
> Running the setup command as `meson [options]` instead of `meson setup [options]` is
> ambiguous and deprecated.
>
> Therefore fix the examples in the documentation.
>
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> ---
> doc/guides/cryptodevs/armv8.rst | 2 +-
> doc/guides/cryptodevs/uadk.rst | 2 +-
> doc/guides/freebsd_gsg/build_dpdk.rst | 2 +-
> doc/guides/gpus/cuda.rst | 4 ++--
> doc/guides/howto/openwrt.rst | 4 ++--
> doc/guides/nics/ark.rst | 2 +-
> doc/guides/nics/mvneta.rst | 2 +-
> doc/guides/nics/mvpp2.rst | 2 +-
> doc/guides/platform/bluefield.rst | 4 ++--
> doc/guides/platform/cnxk.rst | 4 ++--
> doc/guides/platform/octeontx.rst | 8 ++++----
> doc/guides/prog_guide/build-sdk-meson.rst | 4 ++--
> doc/guides/prog_guide/lto.rst | 2 +-
> doc/guides/prog_guide/profile_app.rst | 2 +-
> doc/guides/sample_app_ug/vm_power_management.rst | 14 ++++++--------
> 15 files changed, 28 insertions(+), 30 deletions(-)
>
> diff --git a/doc/guides/cryptodevs/armv8.rst b/doc/guides/cryptodevs/armv8.rst index
> 8963f66a206c..1a006754cbe4 100644
> --- a/doc/guides/cryptodevs/armv8.rst
> +++ b/doc/guides/cryptodevs/armv8.rst
Change looks good to me. Thanks.
Some occurrences in doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst need update as well.
@@ -47,7 +47,7 @@ To build DPDK with this virtual crypto PMD, the user is required to:
.. code-block:: console
- meson build
+ meson setup build
ninja -C build
The corresponding device can be created only if the following features
@@ -87,7 +87,7 @@ Test steps
cd dpdk
mkdir build
- meson build (--reconfigure)
+ meson setup build (--reconfigure)
cd build
ninja
sudo ninja install
@@ -44,7 +44,7 @@ Building DPDK
The following commands can be used to build and install DPDK on a system.
The final, install, step generally needs to be run as root::
- meson build
+ meson setup build
cd build
ninja
ninja install
@@ -25,7 +25,7 @@ Three ways:
- Set ``export CFLAGS=-I/usr/local/cuda/include`` before building
- Add CFLAGS in the meson command line ``CFLAGS=-I/usr/local/cuda/include meson build``
-- Add the ``-Dc_args`` in meson command line ``meson build -Dc_args=-I/usr/local/cuda/include``
+- Add the ``-Dc_args`` in meson command line ``meson setup build -Dc_args=-I/usr/local/cuda/include``
If headers are not found, the CUDA GPU driver library is not built.
@@ -51,7 +51,7 @@ An example would be:
.. code-block:: console
- $ meson build -Dc_args="-I/usr/local/cuda/include -I/path/to/gdrcopy/include"
+ $ meson setup build -Dc_args="-I/usr/local/cuda/include -I/path/to/gdrcopy/include"
If headers are not found, the CUDA GPU driver library is built without the CPU map capability
and will return error if the application invokes the gpudev ``rte_gpu_mem_cpu_map`` function.
@@ -100,8 +100,8 @@ first.
ar = 'x86_64-openwrt-linux-ar'
strip = 'x86_64-openwrt-linux-strip'
- meson builddir --cross-file openwrt-cross
- ninja -C builddir
+ meson setup build --cross-file openwrt-cross
+ ninja -C build
Running DPDK application on OpenWrt
-----------------------------------
@@ -282,7 +282,7 @@ CFLAGS environment prior to the meson build step. I.e.,
.. code-block:: console
export CFLAGS="-DRTE_LIBRTE_ARK_MIN_TX_PKTLEN=60"
- meson build
+ meson setup build
Supported ARK RTL PCIe Instances
@@ -117,7 +117,7 @@ Add path to libmusdk.pc in PKG_CONFIG_PATH environment variable.
.. code-block:: console
export PKG_CONFIG_PATH=$<musdk_install_dir>/lib/pkgconfig/:$PKG_CONFIG_PATH
- meson build --cross-file config/arm/arm64_armada_linux_gcc
+ meson setup build --cross-file config/arm/arm64_armada_linux_gcc
ninja -C build
@@ -133,7 +133,7 @@ Add path to libmusdk.pc in PKG_CONFIG_PATH environment variable.
export PKG_CONFIG_PATH=$<musdk_install_dir>/lib/pkgconfig/:$PKG_CONFIG_PATH
- meson build --cross-file config/arm/arm64_armada_linux_gcc
+ meson setup build --cross-file config/arm/arm64_armada_linux_gcc
ninja -C build
@@ -61,7 +61,7 @@ rdma-core library with corresponding kernel drivers is required.
.. code-block:: console
- meson build
+ meson setup build
ninja -C build
Cross Compilation
@@ -115,5 +115,5 @@ Then, untar the tarball at the cross toolchain directory on the x86 host.
.. code-block:: console
- meson build --cross-file config/arm/arm64_bluefield_linux_gcc
+ meson setup build --cross-file config/arm/arm64_bluefield_linux_gcc
ninja -C build
@@ -606,14 +606,14 @@ CN9K:
.. code-block:: console
- meson build --cross-file config/arm/arm64_cn9k_linux_gcc
+ meson setup build --cross-file config/arm/arm64_cn9k_linux_gcc
ninja -C build
CN10K:
.. code-block:: console
- meson build --cross-file config/arm/arm64_cn10k_linux_gcc
+ meson setup build --cross-file config/arm/arm64_cn10k_linux_gcc
ninja -C build
.. note::
@@ -94,14 +94,14 @@ drivers can be compiled with the following steps,
.. code-block:: console
- meson build -Dexamples=<application>
+ meson setup build -Dexamples=<application>
ninja -C build
The example applications can be compiled using the following:
.. code-block:: console
- meson build -Dexamples=<application>
+ meson setup build -Dexamples=<application>
ninja -C build
Cross Compilation
@@ -127,7 +127,7 @@ Now this build system can be used to build applications for **OCTEON TX** :sup:`
.. code-block:: console
cd <dpdk directory>
- meson build --cross-file config/arm/arm64_thunderx_linux_gcc
+ meson setup build --cross-file config/arm/arm64_thunderx_linux_gcc
ninja -C build
The example applications can be compiled using the following:
@@ -135,7 +135,7 @@ The example applications can be compiled using the following:
.. code-block:: console
cd <dpdk directory>
- meson build --cross-file config/arm/arm64_thunderx_linux_gcc -Dexamples=<application>
+ meson setup build --cross-file config/arm/arm64_thunderx_linux_gcc -Dexamples=<application>
ninja -C build
.. note::
@@ -9,7 +9,7 @@ Summary
For many platforms, compiling and installing DPDK should work using the
following set of commands::
- meson build
+ meson setup build
cd build
ninja
ninja install
@@ -57,7 +57,7 @@ Configuring the Build
----------------------
To configure a build, run the meson tool, passing the path to the directory
-to be used for the build e.g. ``meson build``, as shown above. If calling
+to be used for the build e.g. ``meson setup build``, as shown above. If calling
meson from somewhere other than the root directory of the DPDK project the
path to the root directory should be passed as the first parameter, and the
build path as the second. For example, to build DPDK in /tmp/dpdk-build::
@@ -30,4 +30,4 @@ Link time optimization can be enabled by setting meson built-in 'b_lto' option:
.. code-block:: console
- meson build -Db_lto=true
+ meson setup build -Db_lto=true
@@ -42,7 +42,7 @@ and recompile the DPDK:
.. code-block:: console
- meson build
+ meson setup build
meson configure build -Dc_args=-DRTE_ETHDEV_PROFILE_WITH_VTUNE
ninja -C build
@@ -255,11 +255,10 @@ To build just the ``vm_power_manager`` application using ``meson``/``ninja``:
.. code-block:: console
cd dpdk
- meson build
- cd build
- ninja
+ meson setup build
+ ninja -C build
meson configure -Dexamples=vm_power_manager
- ninja
+ ninja -C build
The resulting binary is ``dpdk/build/examples/dpdk-vm_power_manager``.
@@ -494,11 +493,10 @@ To build just the ``vm_power_manager`` application using ``meson``/``ninja``:
.. code-block:: console
cd dpdk
- meson build
- cd build
- ninja
+ meson setup build
+ ninja -C build
meson configure -Dexamples=vm_power_manager/guest_cli
- ninja
+ ninja -C build
The resulting binary is ``dpdk/build/examples/guest_cli``.