From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: Bruce Richardson <bruce.richardson@intel.com>, stable@dpdk.org
Subject: [dpdk-dev] [PATCH] doc/prog_guide: fix formatting of notes in meson chapter
Date: Thu, 3 Sep 2020 15:00:33 +0100 [thread overview]
Message-ID: <20200903140033.671608-1-bruce.richardson@intel.com> (raw)
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(-)
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
--
2.25.1
next reply other threads:[~2020-09-03 14:00 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-03 14:00 Bruce Richardson [this message]
2020-09-04 8:05 ` [dpdk-dev] [dpdk-stable] " Mcnamara, John
2020-10-05 21:57 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200903140033.671608-1-bruce.richardson@intel.com \
--to=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
--cc=stable@dpdk.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).