doc/prog_guide: fix formatting of notes in meson chapter
diff mbox series

Message ID 20200903140033.671608-1-bruce.richardson@intel.com
State Accepted
Delegated to: Thomas Monjalon
Headers show
Series
  • doc/prog_guide: fix formatting of notes in meson chapter
Related show

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/travis-robot success Travis build: passed

Commit Message

Bruce Richardson Sept. 3, 2020, 2 p.m. UTC
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 <bruce.richardson@intel.com>
---
 doc/guides/prog_guide/build-sdk-meson.rst | 25 ++++++++++++++---------
 1 file changed, 15 insertions(+), 10 deletions(-)

Comments

Mcnamara, John Sept. 4, 2020, 8:05 a.m. UTC | #1
> -----Original Message-----
> From: stable <stable-bounces@dpdk.org> On Behalf Of Bruce Richardson
> Sent: Thursday, September 3, 2020 3:01 PM
> To: dev@dpdk.org
> Cc: Richardson, Bruce <bruce.richardson@intel.com>; stable@dpdk.org
> Subject: [dpdk-stable] [PATCH] 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.
> 
> Fixes: 9c3adc289c5e ("doc: add instructions on build using meson")
> Cc: stable@dpdk.org


Acked-by: John McNamara <john.mcnamara@intel.com>
Thomas Monjalon Oct. 5, 2020, 9:57 p.m. UTC | #2
> > 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
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied, thanks

Patch
diff mbox series

diff --git a/doc/guides/prog_guide/build-sdk-meson.rst b/doc/guides/prog_guide/build-sdk-meson.rst
index 44d1cafdf..d621bea56 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