[v2,7/7] dts: update linters in doc page
Checks
Commit Message
Ruff has now superseded all the previous linters and formatters. Update
DTS doc page accordingly.
Signed-off-by: Luca Vizzarro <luca.vizzarro@arm.com>
Reviewed-by: Paul Szczepanek <paul.szczepanek@arm.com>
---
doc/guides/tools/dts.rst | 26 +++++++-------------------
1 file changed, 7 insertions(+), 19 deletions(-)
Comments
Hi Luca,
There is no error with this series.
The error is caused by the CI doesn't apply any changes with doc/*.
In history, Community decided to exclude doc/*, as doc/* change frequently, especially the release notes, cause a lot of conflict with main tree.
We manually merged this patch and successfully compiled it.
Regards,
Xu, Hailin
> -----Original Message-----
> From: Luca Vizzarro <luca.vizzarro@arm.com>
> Sent: Thursday, December 12, 2024 10:00 PM
> To: dev@dpdk.org
> Cc: Patrick Robb <probb@iol.unh.edu>; Luca Vizzarro
> <luca.vizzarro@arm.com>; Paul Szczepanek <paul.szczepanek@arm.com>
> Subject: [PATCH v2 7/7] dts: update linters in doc page
>
> Ruff has now superseded all the previous linters and formatters. Update DTS
> doc page accordingly.
>
> Signed-off-by: Luca Vizzarro <luca.vizzarro@arm.com>
> Reviewed-by: Paul Szczepanek <paul.szczepanek@arm.com>
> ---
> 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 <https://pycqa.github.io/isort/>`_
> +* `ruff <https://astral.sh/ruff/>`_
>
> - Alphabetically sorts python imports within blocks.
> -
> -* `black <https://github.com/psf/black>`_
> -
> - Does most of the actual formatting (whitespaces, comments, line length
> etc.)
> - and works similarly to clang-format.
> -
> -* `pylama <https://github.com/klen/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 <https://github.com/python/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
@@ -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 <https://pycqa.github.io/isort/>`_
+* `ruff <https://astral.sh/ruff/>`_
- Alphabetically sorts python imports within blocks.
-
-* `black <https://github.com/psf/black>`_
-
- Does most of the actual formatting (whitespaces, comments, line length etc.)
- and works similarly to clang-format.
-
-* `pylama <https://github.com/klen/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 <https://github.com/python/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``.