| Message ID | 20210804182651.7790-1-hnadeau@iol.unh.edu (mailing list archive) |
|---|---|
| State | New |
| Delegated to: | Thomas Monjalon |
| Headers | show |
| Series | doc: two typos in documentation | expand |
| Context | Check | Description |
|---|---|---|
| ci/checkpatch | success | coding style OK |
| ci/github-robot | fail | github build: failed |
| ci/Intel-compilation | success | Compilation OK |
| ci/iol-spell-check-testing | success | Testing PASS |
| ci/intel-Testing | success | Testing PASS |
| ci/iol-broadcom-Performance | success | Performance Testing PASS |
| ci/iol-intel-Functional | success | Functional Testing PASS |
| ci/iol-broadcom-Functional | success | Functional Testing PASS |
| ci/iol-intel-Performance | success | Performance Testing PASS |
| ci/iol-aarch64-unit-testing | success | Testing PASS |
| ci/iol-aarch64-compile-testing | success | Testing PASS |
| ci/iol-mellanox-Performance | success | Performance Testing PASS |
| ci/iol-x86_64-unit-testing | success | Testing PASS |
| ci/iol-abi-testing | success | Testing PASS |
| ci/iol-x86_64-compile-testing | success | Testing PASS |
04/08/2021 20:26, Henry Nadeau: > - :start-after: Building correct configruration for vdmq. 8< > + :start-after: Building correct configuration for vdmq. 8< While at it, "vmdq" should be "VMDq" I think (to be checked).
Hi Henry, When correcting these tags the corresponding tags within the code must also be updated to match or it will break the literalinclude link and cause the warnings shown below. doc/guides/sample_app_ug/dma.rst:240: WARNING: end-before pattern not found: >8 End of starting to process for each lcore. doc/guides/sample_app_ug/vmdq_forwarding.rst:104: WARNING: start-after pattern not found: Building correct configuration for vdmq. 8< Thanks, Conor. > From: dev <dev-bounces@dpdk.org> On Behalf Of Henry Nadeau > Sent: Wednesday 4 August 2021 19:27 > To: dev@dpdk.org > Cc: thomas@monjalon.net > Subject: [dpdk-dev] [PATCH] doc: two typos in documentation > > Corrected two typos that got added in the most recent merge. > > > Signed-off-by: Henry Nadeau <hnadeau@iol.unh.edu> > --- > doc/guides/sample_app_ug/ioat.rst | 2 +- > doc/guides/sample_app_ug/vmdq_forwarding.rst | 2 +- > 2 files changed, 2 insertions(+), 2 deletions(-) > > diff --git a/doc/guides/sample_app_ug/ioat.rst > b/doc/guides/sample_app_ug/ioat.rst > index ee0a627b06..b364be3b5d 100644 > --- a/doc/guides/sample_app_ug/ioat.rst > +++ b/doc/guides/sample_app_ug/ioat.rst > @@ -236,7 +236,7 @@ function in order to start processing for each lcore: > .. literalinclude:: ../../../examples/ioat/ioatfwd.c > :language: c > :start-after: Start processing for each lcore. 8< > - :end-before: >8 End of starting to processfor each lcore. > + :end-before: >8 End of starting to process for each lcore. This one is within ../../../examples/ioat/ioatfwd.c now ../../../examples/dma/dmafwd.c > :dedent: 0 > > The function launches Rx/Tx processing functions on configured lcores > diff --git a/doc/guides/sample_app_ug/vmdq_forwarding.rst > b/doc/guides/sample_app_ug/vmdq_forwarding.rst > index ae1b5660df..ed28525a15 100644 > --- a/doc/guides/sample_app_ug/vmdq_forwarding.rst > +++ b/doc/guides/sample_app_ug/vmdq_forwarding.rst > @@ -103,7 +103,7 @@ the MAC of VMDq pool 2 on port 1 is > 52:54:00:12:01:02. > > .. literalinclude:: ../../../examples/vmdq/main.c > :language: c > - :start-after: Building correct configruration for vdmq. 8< > + :start-after: Building correct configuration for vdmq. 8< And this one is within ../../../examples/vmdq/main.c > :end-before: >8 End of get_eth_conf. > > Once the network port has been initialized using the correct VMDq values, > -- > 2.25.1
diff --git a/doc/guides/sample_app_ug/ioat.rst b/doc/guides/sample_app_ug/ioat.rst index ee0a627b06..b364be3b5d 100644 --- a/doc/guides/sample_app_ug/ioat.rst +++ b/doc/guides/sample_app_ug/ioat.rst @@ -236,7 +236,7 @@ function in order to start processing for each lcore: .. literalinclude:: ../../../examples/ioat/ioatfwd.c :language: c :start-after: Start processing for each lcore. 8< - :end-before: >8 End of starting to processfor each lcore. + :end-before: >8 End of starting to process for each lcore. :dedent: 0 The function launches Rx/Tx processing functions on configured lcores diff --git a/doc/guides/sample_app_ug/vmdq_forwarding.rst b/doc/guides/sample_app_ug/vmdq_forwarding.rst index ae1b5660df..ed28525a15 100644 --- a/doc/guides/sample_app_ug/vmdq_forwarding.rst +++ b/doc/guides/sample_app_ug/vmdq_forwarding.rst @@ -103,7 +103,7 @@ the MAC of VMDq pool 2 on port 1 is 52:54:00:12:01:02. .. literalinclude:: ../../../examples/vmdq/main.c :language: c - :start-after: Building correct configruration for vdmq. 8< + :start-after: Building correct configuration for vdmq. 8< :end-before: >8 End of get_eth_conf. Once the network port has been initialized using the correct VMDq values,
Corrected two typos that got added in the most recent merge. Signed-off-by: Henry Nadeau <hnadeau@iol.unh.edu> --- doc/guides/sample_app_ug/ioat.rst | 2 +- doc/guides/sample_app_ug/vmdq_forwarding.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)