diff mbox series

[1/1] doc: fix note in FreeBSD guide

Message ID 20251031115342.4064625-1-thomas@monjalon.net (mailing list archive)
State New
Delegated to: Thomas Monjalon
Headers
Series [1/1] doc: fix note in FreeBSD guide |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/intel-Functional success Functional PASS
ci/github-robot: build success github build: passed
ci/github-robot-post success github post: success

Commit Message

Thomas Monjalon Oct. 31, 2025, 11:53 a.m. UTC 
The note about the prefix of the package pyelftools was not showed
in the documentation output because the syntax was missing a colon,
so it was considered as a simple comment in the source file.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/freebsd_gsg/build_dpdk.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Thomas Monjalon Nov. 1, 2025, 11:13 a.m. UTC | #1 
31/10/2025 12:53, Thomas Monjalon:
> The note about the prefix of the package pyelftools was not showed
> in the documentation output because the syntax was missing a colon,
> so it was considered as a simple comment in the source file.
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

Fixes: 9e6f75e259a8 ("doc: update build section of FreeBSD guide")
Cc: stable@dpdk.org
Bruce Richardson Nov. 3, 2025, 9:43 a.m. UTC | #2 
On Sat, Nov 01, 2025 at 12:13:31PM +0100, Thomas Monjalon wrote:
> 31/10/2025 12:53, Thomas Monjalon:
> > The note about the prefix of the package pyelftools was not showed
> > in the documentation output because the syntax was missing a colon,
> > so it was considered as a simple comment in the source file.
> > 
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> 
> Fixes: 9e6f75e259a8 ("doc: update build section of FreeBSD guide")
> Cc: stable@dpdk.org
> 
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
>
diff mbox series

Patch

diff --git a/doc/guides/freebsd_gsg/build_dpdk.rst b/doc/guides/freebsd_gsg/build_dpdk.rst
index f98292bf41..a442473ec2 100644
--- a/doc/guides/freebsd_gsg/build_dpdk.rst
+++ b/doc/guides/freebsd_gsg/build_dpdk.rst
@@ -18,7 +18,7 @@  The following FreeBSD packages are required to build DPDK:
 * pkgconf
 * py38-pyelftools
 
-.. note:
+.. note::
 
   The specific package for pyelftools is dependent on the version of python in use,
   Python 3.8 being the version at type of writing, hence the ``py38`` prefix.