From 1509ef9350671ee13381ce8e3c1741c2effc28b1 Mon Sep 17 00:00:00 2001 From: Bruce Richardson Date: Thu, 3 Sep 2020 15:00:33 +0100 Subject: [PATCH] doc: fix formatting of notes in meson guide 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") Cc: stable@dpdk.org Signed-off-by: Bruce Richardson Acked-by: John McNamara --- doc/guides/prog_guide/build-sdk-meson.rst | 25 ++++++++++++++--------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/doc/guides/prog_guide/build-sdk-meson.rst b/doc/guides/prog_guide/build-sdk-meson.rst index 44d1cafdf0..d621bea565 100644 --- a/doc/guides/prog_guide/build-sdk-meson.rst +++ b/doc/guides/prog_guide/build-sdk-meson.rst @@ -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 -- 2.20.1