[v1,4/4] doc: remove reference to RTE_MACHINE_CPUFLAG

Message ID 20200902104343.31774-5-radu.nicolau@intel.com (mailing list archive)
State Superseded, archived
Delegated to: David Marchand
Headers
Series Remove RTE_MACHINE_CPUFLAG_ macros |

Checks

Context Check Description
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/travis-robot success Travis build: passed
ci/iol-testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Radu Nicolau Sept. 2, 2020, 10:43 a.m. UTC
  RTE_MACHINE_CPUFLAG macros are replaced with predefined
compiler defines.

Signed-off-by: Sean Morrissey <sean.morrissey@intel.com>
Signed-off-by: Radu Nicolau <radu.nicolau@intel.com>
---
 doc/guides/prog_guide/writing_efficient_code.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Comments

Bruce Richardson Sept. 2, 2020, 11:21 a.m. UTC | #1
On Wed, Sep 02, 2020 at 10:43:43AM +0000, Radu Nicolau wrote:
> RTE_MACHINE_CPUFLAG macros are replaced with predefined
> compiler defines.
> 
> Signed-off-by: Sean Morrissey <sean.morrissey@intel.com>
> Signed-off-by: Radu Nicolau <radu.nicolau@intel.com>
> ---
>  doc/guides/prog_guide/writing_efficient_code.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/doc/guides/prog_guide/writing_efficient_code.rst b/doc/guides/prog_guide/writing_efficient_code.rst
> index 2639ef7bf..c1f2d627a 100644
> --- a/doc/guides/prog_guide/writing_efficient_code.rst
> +++ b/doc/guides/prog_guide/writing_efficient_code.rst
> @@ -273,5 +273,5 @@ main() function and checks if the current machine is suitable for running the bi
>  Along with compiler optimizations,
>  a set of preprocessor defines are automatically added to the build process (regardless of the compiler version).
>  These defines correspond to the instruction sets that the target CPU should be able to support.
> -For example, a binary compiled for any SSE4.2-capable processor will have RTE_MACHINE_CPUFLAG_SSE4_2 defined,
> +For example, a binary compiled for any SSE4.2-capable processor will have a pre-defined compiler macro,
>  thus enabling compile-time code path selection for different platforms.
> -- 
Personally, I'd suggest just removing the whole section rather than part of
a single line.
  

Patch

diff --git a/doc/guides/prog_guide/writing_efficient_code.rst b/doc/guides/prog_guide/writing_efficient_code.rst
index 2639ef7bf..c1f2d627a 100644
--- a/doc/guides/prog_guide/writing_efficient_code.rst
+++ b/doc/guides/prog_guide/writing_efficient_code.rst
@@ -273,5 +273,5 @@  main() function and checks if the current machine is suitable for running the bi
 Along with compiler optimizations,
 a set of preprocessor defines are automatically added to the build process (regardless of the compiler version).
 These defines correspond to the instruction sets that the target CPU should be able to support.
-For example, a binary compiled for any SSE4.2-capable processor will have RTE_MACHINE_CPUFLAG_SSE4_2 defined,
+For example, a binary compiled for any SSE4.2-capable processor will have a pre-defined compiler macro,
 thus enabling compile-time code path selection for different platforms.