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 68E0945E85; Thu, 12 Dec 2024 15:03:48 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id C307140676; Thu, 12 Dec 2024 15:02:34 +0100 (CET) Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by mails.dpdk.org (Postfix) with ESMTP id A249240651 for ; Thu, 12 Dec 2024 15:02:28 +0100 (CET) Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id 429D8169E; Thu, 12 Dec 2024 06:02:56 -0800 (PST) Received: from localhost.localdomain (JR4XG4HTQC.cambridge.arm.com [10.1.33.58]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPA id 8B5893F58B; Thu, 12 Dec 2024 06:02:27 -0800 (PST) From: Luca Vizzarro To: dev@dpdk.org Cc: Patrick Robb , Luca Vizzarro , Paul Szczepanek Subject: [PATCH v2 7/7] dts: update linters in doc page Date: Thu, 12 Dec 2024 14:00:13 +0000 Message-ID: <20241212140013.17548-8-luca.vizzarro@arm.com> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20241212140013.17548-1-luca.vizzarro@arm.com> References: <20241210103253.3931003-1-luca.vizzarro@arm.com> <20241212140013.17548-1-luca.vizzarro@arm.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit 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 Ruff has now superseded all the previous linters and formatters. Update DTS doc page accordingly. Signed-off-by: Luca Vizzarro Reviewed-by: Paul Szczepanek --- doc/guides/tools/dts.rst | 26 +++++++------------------- 1 file changed, 7 insertions(+), 19 deletions(-) diff --git a/doc/guides/tools/dts.rst b/doc/guides/tools/dts.rst index 8c972c31c4..abc389b42a 100644 --- a/doc/guides/tools/dts.rst +++ b/doc/guides/tools/dts.rst @@ -416,32 +416,20 @@ There are four types of methods that comprise a test suite: DTS Developer Tools ------------------- -There are three tools used in DTS to help with code checking, style and formatting: +There are two tools used in DTS to help with code checking, style and formatting: -* `isort `_ +* `ruff `_ - Alphabetically sorts python imports within blocks. - -* `black `_ - - Does most of the actual formatting (whitespaces, comments, line length etc.) - and works similarly to clang-format. - -* `pylama `_ - - Runs a collection of python linters and aggregates output. - It will run these tools over the repository: - - .. literalinclude:: ../../../dts/pyproject.toml - :language: cfg - :start-after: [tool.pylama] - :end-at: linters + An extremely fast all-in-one linting and formatting solution, which covers most + if not all the major rules such as: pylama, flake8, pylint etc. Its built-in + formatter is also Black-compatible and is able to sort imports automatically + like isort would. * `mypy `_ Enables static typing for Python, exploiting the type hints in the source code. -These three tools are all used in ``devtools/dts-check-format.sh``, +These two tools are all used in ``devtools/dts-check-format.sh``, the DTS code check and format script. Refer to the script for usage: ``devtools/dts-check-format.sh -h``. -- 2.43.0