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 3B14E43817; Thu, 4 Jan 2024 14:15:30 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 1C512402CC; Thu, 4 Jan 2024 14:15:30 +0100 (CET) Received: from out3-smtp.messagingengine.com (out3-smtp.messagingengine.com [66.111.4.27]) by mails.dpdk.org (Postfix) with ESMTP id A0867402C7 for ; Thu, 4 Jan 2024 14:15:28 +0100 (CET) Received: from compute5.internal (compute5.nyi.internal [10.202.2.45]) by mailout.nyi.internal (Postfix) with ESMTP id D2B925C01A1; Thu, 4 Jan 2024 08:15:27 -0500 (EST) Received: from mailfrontend2 ([10.202.2.163]) by compute5.internal (MEProxy); Thu, 04 Jan 2024 08:15:27 -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=1704374127; x=1704460527; bh=ADWg6mnHk+n9u4lI/uOc4g4ccYy9Ro84n3umw99icS8=; b= hlqQSeap76Isz14lb6H/CaqBi1i4cXD6WEfcRo8feMRymT7u1neSzhH4P2WuHnlG tVfh0HFwclibQ2ql5StVGAOXnk+5UdN2FsEjm9as85CrgMsmxBwrnHjrrfVomz5+ uzJxWedZiUDIkeIa0KHflxfzgfAl+L0hpU+x6r3bbnpd/SuQZX11kVLT7/CzfVsH E5Vcj+4pjiisHXiju210ncBO9HXCua4jT0gz/Bh4qFyUbtRibrK56d55MNu5nWkY VFc7ChU7+7FWnxM/NVfGHgG7sWeWsXRMzw8itVFM1FyPg1boSatyKJMeANKDAUAg e16Q5mO3gtFw5Li6mpxDfg== 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=1704374127; x= 1704460527; bh=ADWg6mnHk+n9u4lI/uOc4g4ccYy9Ro84n3umw99icS8=; b=B xbZjKGpkNgx775F1a8eC+++67k9EvliiNIxZd4AY40hkQiihtvG4xVgciOhbgP70 syqLaXw/uZzBhnjpVxXqN/xDCAL6RskGfkZ8GGmJ+q9FTbX5tPPbd7E8hm6dr9OI c/xOZlQtjagL660BtVBbDUCm8lmdVtipfv3mv5AZEGOUFdpbZTqRHhielI3Ki+5i Ssio9h2KYQng6gbs6kTLNUFzUYNK3cJMP7n0t9Xc9Tr1NZcNRrtHjxy6zjmRhBib /r8xZJEJnt4ItOvA6EC/ZhVoFhXRDUdPeoUR2MKN3gkXxgmQIzcQe4NVpkEhSmsD AgVyMKL9aehfGn/ab7+LA== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvkedrvdegjedggeelucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne cujfgurhephffvvefufffkjghfggfgtgesthfuredttddtvdenucfhrhhomhepvfhhohhm rghsucfoohhnjhgrlhhonhcuoehthhhomhgrshesmhhonhhjrghlohhnrdhnvghtqeenuc ggtffrrghtthgvrhhnpedtjeeiieefhedtfffgvdelteeufeefheeujefgueetfedttdei kefgkeduhedtgfenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepmhgrihhlfh hrohhmpehthhhomhgrshesmhhonhhjrghlohhnrdhnvght X-ME-Proxy: Feedback-ID: i47234305:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Thu, 4 Jan 2024 08:15:25 -0500 (EST) From: Thomas Monjalon To: Luca Vizzarro Cc: dev@dpdk.org, Lijuan Tu , Juraj =?utf-8?B?TGlua2XFoQ==?= , Paul Szczepanek Subject: Re: [PATCH] dts: improve documentation Date: Thu, 04 Jan 2024 14:15:23 +0100 Message-ID: <2588274.Lt9SDvczpP@thomas> In-Reply-To: <115ac141-685b-4b60-a338-ae446c2ab966@arm.com> References: <20240103125438.182098-1-Luca.Vizzarro@arm.com> <22136588.EfDdHjke4D@thomas> <115ac141-685b-4b60-a338-ae446c2ab966@arm.com> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" 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 04/01/2024 13:34, Luca Vizzarro: > On 04/01/2024 10:52, Thomas Monjalon wrote: > >> 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. > > Yes, that is correct. At the current state, DTS is always compiled from > source though, so it may be reasonable to leave it as it is until this > feature may be implemented. Nonetheless, my change just informs the user > of the (already implemented) feature that uses `git archive` from the > local repository to create a tarball. A sensible change would be to add > this explanation I have just given, but it is a technicality and it > won't really make a difference to the user. Yes I would like to make it clear in this doc that DTS is compiling DPDK. Please could you change to something like "DTS needs a DPDK tarball or a git ref ID to compile" ? I hope we will change it later to allow external compilation. > >> + (dts-py3.10) $ ./main.py --help > > > > Why adding this line? > > Just running `./main.py` will just throw a confusing error to the user. > I am in the process of sorting this out as it is misleading and not > helpful. Specifying the line in this case just hints to the user on the > origin of that help/usage document. Yes would be good to have a message to help the user instead of a confusing error. > > Should we remove the shell prefix referring to a specific Python version? > > I have purposely left the prefix to indicate that we are in a Poetry > shell environment, as that is a pre-requisite to run DTS. So more of an > implicit reminder. The Python version specified is in line with the > minimum requirement of DTS. OK > > 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. > > I left the output of `--help` under a code block as it is originally > printed in the console. Could surely amend it in the docs to be easier > to read, but the user could as easily print it themselves in their own > terminal in the comfort of their own environment. I was not referring to the console output. Maybe I misunderstood it. For the doc sentences, please try to split sentences on different lines. > >> - [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 > > As above. The output of `--help` only changed as a result of not being > updated before in parallel with code changes. Consistently this is what > the user would see right now. It may or may not be a good idea to update > this whenever changed in the future. I did not understand it is part of the help message. > Nonetheless, I am keen to update the code as part of this patch to > resolve your comments. Yes please update the code for this small wording fix. > > 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. > > While I understand the concern on wanting to rework the schema, which is > a great point you make, it may be reasonable to provide something useful > to close the existing documentation gap. And incrementally updating from > there. If there is no realistic timeline set in place for a schema > rework, it may just be better to have something rather than nothing. And > certainly it would not be very useful to upstream a partial documentation. I don't know. I have big doubts about the current schema. I will review it with your doc patches. Can you please split this patch in 2 so that the schema doc is in a different patch? > Thank you a lot for your review! You have made some good points which > open up new potential tasks to add to the pipeline.