From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 45A7143815; Thu, 4 Jan 2024 11:52:25 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 150FB402E2; Thu, 4 Jan 2024 11:52:25 +0100 (CET) Received: from out5-smtp.messagingengine.com (out5-smtp.messagingengine.com [66.111.4.29]) by mails.dpdk.org (Postfix) with ESMTP id 2CA4D402CC for ; Thu, 4 Jan 2024 11:52:24 +0100 (CET) Received: from compute2.internal (compute2.nyi.internal [10.202.2.46]) by mailout.nyi.internal (Postfix) with ESMTP id 700C45C017E; Thu, 4 Jan 2024 05:52:23 -0500 (EST) Received: from mailfrontend1 ([10.202.2.162]) by compute2.internal (MEProxy); Thu, 04 Jan 2024 05:52:23 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= cc:cc:content-transfer-encoding:content-type:content-type:date :date:from:from:in-reply-to:in-reply-to:message-id:mime-version :references:reply-to:subject:subject:to:to; s=fm2; t=1704365543; x=1704451943; bh=C1Nn/oaIjh4G0deF8KKKPjspfdvqVtEwmCAxKOsmpVs=; b= s39EUDUUgcHVxQCMcWIk/HM601qHOly9eia94A9vcdwdoCPiIIht9FhkdBFR0WB+ gzOQdtILGMkU2Hv85ZU5d1jftPOoRnqajzR3sCFT7a9j0JpxtupnRxIAw6ktfmUC sHlmhXlqAMmaDslX69fxT1Zxp/HOClU3S2HT0JynwAVDa6k2QIlhXMeb+YiQTbVQ YFZ98gpfbOG+xgpz0QyIS20CyZRIGcxtGr8AhLWYOBKCVg7xaxRPQ98gE9v3Hwag qcks4fwoOari7HhCUKyRtQN7CM3uGty0mWb45M2CRzs8pH3RJl0Rw6U31qgeP5QC xpFJpSkCe0C0crlEGCOT5g== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-transfer-encoding :content-type:content-type:date:date:feedback-id:feedback-id :from:from:in-reply-to:in-reply-to:message-id:mime-version :references:reply-to:subject:subject:to:to:x-me-proxy:x-me-proxy :x-me-sender:x-me-sender:x-sasl-enc; s=fm2; t=1704365543; x= 1704451943; bh=C1Nn/oaIjh4G0deF8KKKPjspfdvqVtEwmCAxKOsmpVs=; b=u irI+LPW050EQ5zFx/fbxDuFbaPUwBkDkABraQivu/noHrJHcVz+FVu+oTpyzWx0p Nea19X0yzcCJHZkYNAcg0D+O5FjVsEwPZuqQN8ZWNhr+5vwZFhzrJ+iBTJZZW59v svChMwRcP5hZXIiYwFkqNnuG9cH/fIl6/VfBxS6MKZqf/TbKdC8p43lzUvAGA0rK YO67spyZAWdWiTONgDBJy9DC70vBuYlZb88OA6BdGnHgjguLjARkJUzu/dIRSZ3a hsWiWTcwjhMOCsS/diLLazcWm0TUv3OVvHxayL6ycLefyebAv+1DcfI5AncrCuX1 O9oGqKc6EkeNLOCJ0gNNA== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvkedrvdegjedgudelucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne cujfgurhephffvvefufffkjghfggfgtgesthhqredttddtjeenucfhrhhomhepvfhhohhm rghsucfoohhnjhgrlhhonhcuoehthhhomhgrshesmhhonhhjrghlohhnrdhnvghtqeenuc ggtffrrghtthgvrhhnpeegtddtleejjeegffekkeektdejvedtheevtdekiedvueeuvdei uddvleevjeeujeenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepmhgrihhlfh hrohhmpehthhhomhgrshesmhhonhhjrghlohhnrdhnvght X-ME-Proxy: Feedback-ID: i47234305:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Thu, 4 Jan 2024 05:52:21 -0500 (EST) From: Thomas Monjalon To: Luca Vizzarro , Paul Szczepanek Cc: dev@dpdk.org, Lijuan Tu , Juraj =?utf-8?B?TGlua2XFoQ==?= Subject: Re: [PATCH] dts: improve documentation Date: Thu, 04 Jan 2024 11:52:20 +0100 Message-ID: <22136588.EfDdHjke4D@thomas> In-Reply-To: <20240103125438.182098-1-Luca.Vizzarro@arm.com> References: <20240103125438.182098-1-Luca.Vizzarro@arm.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="UTF-8" X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org 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 =46or 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] > =20 > - Run DPDK test suites. All options may be specified with the environme= nt variables provided in > - brackets. Command line arguments have higher priority. > + Run DPDK test suites. All options may be specified with the environme= nt 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 en= d of a sentence. > - [DTS_OUTPUT_DIR] Output directory where dts l= ogs and results are > - saved. (default: output) > + [DTS_OUTPUT_DIR] Output directory where dts l= ogs and results are saved. dts -> DTS > +Configuration Schema > +-------------------- > + > +Definitions > +~~~~~~~~~~~ > + > +_`Node name` > + *string* =E2=80=93 A unique identifier for a node. **Examples**: ``SU= T1``, ``TG1``. > + > +_`ARCH` > + *string* =E2=80=93 The CPU architecture. **Supported values**: ``x86_= 64``, ``arm64``, ``ppc64le``. > + > +_`CPU` > + *string* =E2=80=93 The CPU microarchitecture. Use ``native`` for x86.= **Supported values**: ``native``, ``armv8a``, ``dpaa2``, ``thunderx``, ``x= gene1``. > + > +_`OS` > + *string* =E2=80=93 The operating system. **Supported values**: ``linu= x``. > + > +_`Compiler` > + *string* =E2=80=93 The compiler used for building DPDK. **Supported v= alues**: ``gcc``, ``clang``, ``icc``, ``mscv``. > + > +_`Build target` > + *object* =E2=80=93 Build targets supported by DTS for building DPDK, = described as: > + > + =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > + ``arch`` See `ARCH`_ > + ``os`` See `OS`_ > + ``cpu`` See `CPU`_ > + ``compiler`` See `Compiler`_ > + ``compiler_wrapper`` *string* =E2=80=93 Value prepended to the CC var= iable 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.