diff mbox series

[v2,6/6] doc: dpdk documentation changes for new dts config

Message ID 20240705171341.23894-14-npratte@iol.unh.edu (mailing list archive)
State Superseded, archived
Headers
Series dts: Remove Excess Attributes From User Config |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation warning apply issues

Commit Message

Nicholas Pratte July 5, 2024, 5:13 p.m. UTC 
Adjusted DPDK documentation to reflect the changes made to the dts
conf.yaml configuration file.

Bugzilla ID: 1360
Signed-off-by: Nicholas Pratte <npratte@iol.unh.edu>
 
---
 doc/guides/tools/dts.rst | 26 ++++++--------------------
 1 file changed, 6 insertions(+), 20 deletions(-)

Comments

Juraj Linkeš Sept. 10, 2024, 2:17 p.m. UTC | #1 
On 5. 7. 2024 19:13, Nicholas Pratte wrote:
> Adjusted DPDK documentation to reflect the changes made to the dts
> conf.yaml configuration file.
> 

Looking at the changes to conf.yaml, looks like there are missing pieces 
(such as moved vdevs and memory_channels), but the patch no longer 
applies and it's hard to verify without that. But this is likely not 
needed because the Pydantic changes are going to simplify this.
Dean Marx Nov. 6, 2024, 8:57 p.m. UTC | #2 
On Fri, Jul 5, 2024 at 1:20 PM Nicholas Pratte <npratte@iol.unh.edu> wrote:

> Adjusted DPDK documentation to reflect the changes made to the dts
> conf.yaml configuration file.
>
> Bugzilla ID: 1360
> Signed-off-by: Nicholas Pratte <npratte@iol.unh.edu>
>

Reviewed-by: Dean Marx <dmarx@iol.unh.edu>
Luca Vizzarro Nov. 18, 2024, 5:21 p.m. UTC | #3 
As Juraj already said this is no longer needed.
diff mbox series

Patch

diff --git a/doc/guides/tools/dts.rst b/doc/guides/tools/dts.rst
index 515b15e4d8..a64580e0de 100644
--- a/doc/guides/tools/dts.rst
+++ b/doc/guides/tools/dts.rst
@@ -437,14 +437,6 @@  _`Node name`
    *string* – A unique identifier for a node.
    **Examples**: ``SUT1``, ``TG1``.
 
-_`ARCH`
-   *string* – The CPU architecture.
-   **Supported values**: ``x86_64``, ``arm64``, ``ppc64le``.
-
-_`CPU`
-   *string* – The CPU microarchitecture. Use ``native`` for x86.
-   **Supported values**: ``native``, ``armv8a``, ``dpaa2``, ``thunderx``, ``xgene1``.
-
 _`OS`
    *string* – The operating system. **Supported values**: ``linux``.
 
@@ -456,9 +448,6 @@  _`Build target`
    *mapping* – Build targets supported by DTS for building DPDK, described as:
 
    ==================== =================================================================
-   ``arch``             See `ARCH`_
-   ``os``               See `OS`_
-   ``cpu``              See `CPU`_
    ``compiler``         See `Compiler`_
    ``compiler_wrapper`` *string* – Value prepended to the CC variable for the DPDK build.
 
@@ -565,18 +554,15 @@  involved in the testing. These can be defined with the following mappings:
    |                       |                                                                                       |
    |                       | **NB**: Use only as last resort. SSH keys are **strongly** preferred.                 |
    +-----------------------+---------------------------------------------------------------------------------------+
-   | ``arch``              | The architecture of this node. See `ARCH`_ for supported values.                      |
-   +-----------------------+---------------------------------------------------------------------------------------+
    | ``os``                | The operating system of this node. See `OS`_ for supported values.                    |
    +-----------------------+---------------------------------------------------------------------------------------+
-   | ``lcores``            | | (*optional*, defaults to 1) *string* – Comma-separated list of logical              |
-   |                       | | cores to use. An empty string means use all lcores.                                 |
-   |                       |                                                                                       |
-   |                       | **Example**: ``1,2,3,4,5,18-22``                                                      |
+   | ``dpdk_config``       | Configuration relating to DPDK (to be specified on SUT Nodes)                         |
    +-----------------------+---------------------------------------------------------------------------------------+
-   | ``use_first_core``    | (*optional*, defaults to ``false``) *boolean*                                         |
+   | ``lcores``            | | (*optional*, defaults to 1 if not used) *string* – Comma-separated list of logical  |
+   |                       | | cores to use. An empty string means use all lcores except core 0. core 0 is used    |
+   |                       | | only when explicitly specified                                                      |
    |                       |                                                                                       |
-   |                       | Indicates whether DPDK should use only the first physical core or not.                |
+   |                       | **Example**: ``1,2,3,4,5,18-22``                                                      |
    +-----------------------+---------------------------------------------------------------------------------------+
    | ``memory_channels``   | (*optional*, defaults to 1) *integer*                                                 |
    |                       |                                                                                       |
@@ -617,4 +603,4 @@  And they both have two network ports which are physically connected to each othe
 
 .. literalinclude:: ../../../dts/conf.yaml
    :language: yaml
-   :start-at: test_runs:
+   :start-at: test_runs:
\ No newline at end of file