[1/2] docs/bpf: fix formatting and link
Checks
Commit Message
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(-)
Comments
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>
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.
@@ -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.