From: Thomas Monjalon <thomas@monjalon.net>
To: Luca Vizzarro <Luca.Vizzarro@arm.com>,
Paul Szczepanek <Paul.Szczepanek@arm.com>
Cc: dev@dpdk.org, "Lijuan Tu" <lijuan.tu@intel.com>,
"Juraj Linkeš" <juraj.linkes@pantheon.tech>
Subject: Re: [PATCH] dts: improve documentation
Date: Thu, 04 Jan 2024 11:52:20 +0100 [thread overview]
Message-ID: <22136588.EfDdHjke4D@thomas> (raw)
In-Reply-To: <20240103125438.182098-1-Luca.Vizzarro@arm.com>
03/01/2024 13:54, Luca Vizzarro:
> Improve instructions for installing dependencies, configuring and
> launching the project. Finally, document the configuration schema
> by adding more comments to the example and documenting every
> property and definition.
Thank you for taking care of the documentation.
> +Luca Vizzarro <Luca.Vizzarro@arm.com>
For consistency, we don't use uppercase characters in email addresses.
> - poetry install
> + poetry install --no-root
Please could you explain this change in the commit log?
> DTS needs to know which nodes to connect to and what hardware to use on those nodes.
> -Once that's configured, DTS needs a DPDK tarball and it's ready to run.
> +Once that's configured, DTS needs a DPDK tarball or a git ref ID and it's ready to run.
That's assuming DTS is compiling DPDK.
We may want to provide an already compiled DPDK to DTS.
> - usage: main.py [-h] [--config-file CONFIG_FILE] [--output-dir OUTPUT_DIR] [-t TIMEOUT]
> - [-v VERBOSE] [-s SKIP_SETUP] [--tarball TARBALL]
> - [--compile-timeout COMPILE_TIMEOUT] [--test-cases TEST_CASES]
> - [--re-run RE_RUN]
> + (dts-py3.10) $ ./main.py --help
Why adding this line?
Should we remove the shell prefix referring to a specific Python version?
> + usage: main.py [-h] [--config-file CONFIG_FILE] [--output-dir OUTPUT_DIR] [-t TIMEOUT] [-v VERBOSE]
> + [-s SKIP_SETUP] [--tarball TARBALL] [--compile-timeout COMPILE_TIMEOUT]
> + [--test-cases TEST_CASES] [--re-run RE_RUN]
>
> - Run DPDK test suites. All options may be specified with the environment variables provided in
> - brackets. Command line arguments have higher priority.
> + Run DPDK test suites. All options may be specified with the environment variables provided in brackets.
In general it is better to avoid long lines, and split after a punctation.
I think we should take the habit to always go to the next line after the end of a sentence.
> - [DTS_OUTPUT_DIR] Output directory where dts logs and results are
> - saved. (default: output)
> + [DTS_OUTPUT_DIR] Output directory where dts logs and results are saved.
dts -> DTS
> +Configuration Schema
> +--------------------
> +
> +Definitions
> +~~~~~~~~~~~
> +
> +_`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``.
> +
> +_`Compiler`
> + *string* – The compiler used for building DPDK. **Supported values**: ``gcc``, ``clang``, ``icc``, ``mscv``.
> +
> +_`Build target`
> + *object* – 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.
Please don't add compilation configuration for now,
I would like to work on the schema first.
This is mostly imported from the old DTS and needs to be rethink.
next prev parent reply other threads:[~2024-01-04 10:52 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-03 12:54 Luca Vizzarro
2024-01-04 10:52 ` Thomas Monjalon [this message]
2024-01-04 12:34 ` Luca Vizzarro
2024-01-04 13:15 ` Thomas Monjalon
2024-01-12 13:24 ` Juraj Linkeš
2024-01-12 17:16 ` Luca Vizzarro
2024-01-15 9:36 ` Juraj Linkeš
2024-01-15 11:44 ` Luca Vizzarro
2024-01-16 11:44 ` [PATCH v2 1/2] " Luca Vizzarro
2024-01-16 11:44 ` [PATCH v2 2/2] dts: add configuration schema docs Luca Vizzarro
2024-01-16 16:48 ` Juraj Linkeš
2024-01-16 16:47 ` [PATCH v2 1/2] dts: improve documentation Juraj Linkeš
2024-01-19 17:29 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=22136588.EfDdHjke4D@thomas \
--to=thomas@monjalon.net \
--cc=Luca.Vizzarro@arm.com \
--cc=Paul.Szczepanek@arm.com \
--cc=dev@dpdk.org \
--cc=juraj.linkes@pantheon.tech \
--cc=lijuan.tu@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).