[PATCH 1/2] docs/bpf: fix formatting and link

[PATCH 1/2] docs/bpf: fix formatting and link

[Harry van Haaren]

Small improvements to the documentation based on Sphinx HTML doc output.

Signed-off-by: Harry van Haaren <harry.van.haaren@intel.com>

---

Cc: konstantin.v.ananyev@yandex.ru

---
 doc/guides/prog_guide/bpf_lib.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/doc/guides/prog_guide/bpf_lib.rst b/doc/guides/prog_guide/bpf_lib.rst
index 1feb7734a3..1cf2d59429 100644
--- a/doc/guides/prog_guide/bpf_lib.rst
+++ b/doc/guides/prog_guide/bpf_lib.rst
@@ -10,7 +10,7 @@ user-space dpdk application.
 
 It supports basic set of features from eBPF spec.
 Please refer to the
-`eBPF spec <https://www.kernel.org/doc/Documentation/networking/filter.txt>`
+`eBPF spec <https://www.kernel.org/doc/Documentation/networking/filter.txt>`_
 for more information.
 Also it introduces basic framework to load/unload BPF-based filters
 on eth devices (right now only via SW RX/TX callbacks).
@@ -48,9 +48,9 @@ For example, ``(BPF_IND | BPF_W | BPF_LD)`` means:
 .. code-block:: c
 
     uint32_t tmp;
-    R0 = rte_pktmbuf_read((const struct rte_mbuf *)R6,  src_reg + imm32,
-	sizeof(tmp), &tmp);
-    if (R0 == NULL) return FAILED;
+    R0 = rte_pktmbuf_read((const struct rte_mbuf *)R6,  src_reg + imm32, sizeof(tmp), &tmp);
+    if (R0 == NULL)
+        return FAILED;
     R0 = ntohl(*(uint32_t *)R0);
 
 and ``R1-R5`` were scratched.
-- 
2.32.0

[PATCH 2/2] docs: improve ordering and remove old header titles

[Harry van Haaren]

Move the "source_org" page to after overview, where it fits
better to explain the source-code layout of DPDK, before getting
into details of specific libraries such as EAL.

Also removes the older titles from the 3 documents which still had them.

Signed-off-by: Harry van Haaren <harry.van.haaren@intel.com>

---
 doc/guides/prog_guide/index.rst               | 2 +-
 doc/guides/prog_guide/overview.rst            | 2 --
 doc/guides/prog_guide/perf_opt_guidelines.rst | 2 --
 doc/guides/prog_guide/source_org.rst          | 2 --
 4 files changed, 1 insertion(+), 7 deletions(-)

diff --git a/doc/guides/prog_guide/index.rst b/doc/guides/prog_guide/index.rst
index 6c7942b845..8564883018 100644
--- a/doc/guides/prog_guide/index.rst
+++ b/doc/guides/prog_guide/index.rst
@@ -10,6 +10,7 @@ Programmer's Guide
 
     intro
     overview
+    source_org
     env_abstraction_layer
     service_cores
     trace_lib
@@ -67,7 +68,6 @@ Programmer's Guide
     bpf_lib
     ipsec_lib
     graph_lib
-    source_org
     build-sdk-meson
     meson_ut
     build_app
diff --git a/doc/guides/prog_guide/overview.rst b/doc/guides/prog_guide/overview.rst
index 537a568f1e..a3b6603320 100644
--- a/doc/guides/prog_guide/overview.rst
+++ b/doc/guides/prog_guide/overview.rst
@@ -1,8 +1,6 @@
 ..  SPDX-License-Identifier: BSD-3-Clause
     Copyright(c) 2010-2014 Intel Corporation.
 
-**Part 1: Architecture Overview**
-
 Overview
 ========
 
diff --git a/doc/guides/prog_guide/perf_opt_guidelines.rst b/doc/guides/prog_guide/perf_opt_guidelines.rst
index 88f92909c1..360009f2e4 100644
--- a/doc/guides/prog_guide/perf_opt_guidelines.rst
+++ b/doc/guides/prog_guide/perf_opt_guidelines.rst
@@ -3,8 +3,6 @@
 
 .. _Performance_Optimization:
 
-**Part 3: Performance Optimization**
-
 Performance Optimization Guidelines
 ===================================
 
diff --git a/doc/guides/prog_guide/source_org.rst b/doc/guides/prog_guide/source_org.rst
index 5e4333460a..3d5f7f3bdd 100644
--- a/doc/guides/prog_guide/source_org.rst
+++ b/doc/guides/prog_guide/source_org.rst
@@ -1,8 +1,6 @@
 ..  SPDX-License-Identifier: BSD-3-Clause
     Copyright(c) 2010-2014 Intel Corporation.
 
-**Part 2: Development Environment**
-
 Source Organization
 ===================
 
-- 
2.32.0

Re: [PATCH 1/2] docs/bpf: fix formatting and link

[Konstantin Ananyev]

27/05/2022 14:45, Harry van Haaren пишет:
> Small improvements to the documentation based on Sphinx HTML doc output.
> 
> Signed-off-by: Harry van Haaren <harry.van.haaren@intel.com>
> 
> ---
> 
> Cc: konstantin.v.ananyev@yandex.ru
> 
> ---
>   doc/guides/prog_guide/bpf_lib.rst | 8 ++++----
>   1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/doc/guides/prog_guide/bpf_lib.rst b/doc/guides/prog_guide/bpf_lib.rst
> index 1feb7734a3..1cf2d59429 100644
> --- a/doc/guides/prog_guide/bpf_lib.rst
> +++ b/doc/guides/prog_guide/bpf_lib.rst
> @@ -10,7 +10,7 @@ user-space dpdk application.
>   
>   It supports basic set of features from eBPF spec.
>   Please refer to the
> -`eBPF spec <https://www.kernel.org/doc/Documentation/networking/filter.txt>`
> +`eBPF spec <https://www.kernel.org/doc/Documentation/networking/filter.txt>`_
>   for more information.
>   Also it introduces basic framework to load/unload BPF-based filters
>   on eth devices (right now only via SW RX/TX callbacks).
> @@ -48,9 +48,9 @@ For example, ``(BPF_IND | BPF_W | BPF_LD)`` means:
>   .. code-block:: c
>   
>       uint32_t tmp;
> -    R0 = rte_pktmbuf_read((const struct rte_mbuf *)R6,  src_reg + imm32,
> -	sizeof(tmp), &tmp);
> -    if (R0 == NULL) return FAILED;
> +    R0 = rte_pktmbuf_read((const struct rte_mbuf *)R6,  src_reg + imm32, sizeof(tmp), &tmp);
> +    if (R0 == NULL)
> +        return FAILED;
>       R0 = ntohl(*(uint32_t *)R0);
>   
>   and ``R1-R5`` were scratched.

Acked-by: Konstantin Ananyev <konstantin.v.ananyev@yandex.ru>

Re: [PATCH 1/2] docs/bpf: fix formatting and link

[Thomas Monjalon]

28/05/2022 13:09, Konstantin Ananyev:
> 27/05/2022 14:45, Harry van Haaren пишет:
> > Small improvements to the documentation based on Sphinx HTML doc output.
> > 
> > Signed-off-by: Harry van Haaren <harry.van.haaren@intel.com>
> 
> Acked-by: Konstantin Ananyev <konstantin.v.ananyev@yandex.ru>

Fixes: 14b8f0bbe519 ("doc: add BPF library guide")
Fixes: b901d928361c ("bpf: support packet data load instructions")
Cc: stable@dpdk.org

Series applied, thanks.