doc/prog_guide: fix formatting of notes in meson chapter
PATCH 1/1 doc/prog_guide: fix formatting of notes in meson chapter
The "note" callouts in the chapter describing the meson build were incorrectly formatted, so adjust to use the correct markdown syntax.
--- doc/guides/prog_guide/build-sdk-meson.rst | 25 ++++++++++++++--------- 1 file changed, 15 insertions(+), 10 deletions(-)
doc/guides/prog_guide/build-sdk-meson.rst +15 -10
@@ -102,14 +102,17 @@ Examples of setting some of the same options using meson configure:: meson configure -Denable_trace_fp=true -NOTE: once meson has been run to configure a build in a directory, it -cannot be run again on the same directory. Instead ``meson configure`` -should be used to change the build settings within the directory, and when -``ninja`` is called to do the build itself, it will trigger the necessary -re-scan from meson. +.. note:: -NOTE: machine=default uses a config that works on all supported architectures -regardless of the capabilities of the machine where the build is happening. + once meson has been run to configure a build in a directory, it + cannot be run again on the same directory. Instead ``meson configure`` + should be used to change the build settings within the directory, and when + ``ninja`` is called to do the build itself, it will trigger the necessary + re-scan from meson. + +.. note:: + machine=default uses a config that works on all supported architectures + regardless of the capabilities of the machine where the build is happening. As well as those settings taken from ``meson configure``, other options such as the compiler to use can be passed via environment variables. For
@@ -117,9 +120,11 @@ example:: CC=clang meson clang-build -NOTE: for more comprehensive overriding of compilers or other environment -settings, the tools for cross-compilation may be considered. However, for -basic overriding of the compiler etc., the above form works as expected. +.. note:: + + for more comprehensive overriding of compilers or other environment + settings, the tools for cross-compilation may be considered. However, for + basic overriding of the compiler etc., the above form works as expected. Performing the Build
Signature · 1 line
2.25.1
Quoted 8 lines
-----Original Message-----
From: stable <[email protected]> On Behalf Of Bruce Richardson
Sent: Thursday, September 3, 2020 3:01 PM
To: [email protected]
Cc: Richardson, Bruce <[email protected]>; [email protected]
Subject: [dpdk-stable] [PATCH] doc/prog_guide: fix formatting of notes in meson chapter
Quoted 5 lines
The "note" callouts in the chapter describing the meson build were incorrectly formatted, so adjust to use the correct markdown syntax.
Fixes 9c3adc289c5e ("doc: add instructions on build using meson")
Thomas Monjalon
AppliedQuoted 7 lines
Quoted 5 lines
The "note" callouts in the chapter describing the meson build were incorrectly formatted, so adjust to use the correct markdown syntax.
Fixes 9c3adc289c5e ("doc: add instructions on build using meson")Acked-by John McNamara <[email protected]>
Applied, thanks