From patchwork Thu Sep 3 14:00:33 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 76406 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 7FB3CA04BE; Thu, 3 Sep 2020 16:00:42 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id EDC0C1BEAF; Thu, 3 Sep 2020 16:00:41 +0200 (CEST) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by dpdk.org (Postfix) with ESMTP id 0F25EDE0; Thu, 3 Sep 2020 16:00:39 +0200 (CEST) IronPort-SDR: Al3b3WXBr5EZ1dXMKn8/K/oae1Xwgz/MT09EfPUbx5CXZtA4zI16wuuQrRemxWlEb88EOOdgVM ctKTO9S3a6+g== X-IronPort-AV: E=McAfee;i="6000,8403,9732"; a="154975998" X-IronPort-AV: E=Sophos;i="5.76,386,1592895600"; d="scan'208";a="154975998" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga007.jf.intel.com ([10.7.209.58]) by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 03 Sep 2020 07:00:38 -0700 IronPort-SDR: 6jRHakMTxyApWOgnnitbn8pX92XeeLxDgKuG9hYwFStd/S0LJ/7NdgJ6FA7WHaLDajg+VAwtS7 j0v/8zOsfeBQ== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.76,386,1592895600"; d="scan'208";a="341813530" Received: from silpixa00399126.ir.intel.com ([10.237.222.27]) by orsmga007.jf.intel.com with ESMTP; 03 Sep 2020 07:00:37 -0700 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson , stable@dpdk.org Date: Thu, 3 Sep 2020 15:00:33 +0100 Message-Id: <20200903140033.671608-1-bruce.richardson@intel.com> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH] doc/prog_guide: fix formatting of notes in meson chapter X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 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