From 63c74d539efe088c5dfa085cfcce017fb502581f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Magimel?= Date: Thu, 11 Dec 2025 10:01:04 +0000 Subject: [PATCH] docs(dev,setup): update the script helper --- doc/sphinx/development/setup.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/sphinx/development/setup.rst b/doc/sphinx/development/setup.rst index e1578d4..e15ad6b 100644 --- a/doc/sphinx/development/setup.rst +++ b/doc/sphinx/development/setup.rst @@ -23,16 +23,19 @@ The supported tools are as follows: COMMAND may be one of the following: tidy [FILES..] runs perltidy on several or all the Perl source files, modifying them if needed - tidycheck [FILES..] runs perltidy in dry-run mode, and returns an error if files are not tidy + checktidy [FILES..] runs perltidy in dry-run mode, and returns an error if files are not tidy perlcritic runs perlcritic on all the Perl source files shellcheck [FILES..] runs shellcheck on all the shell source files lint runs tidy, perlcritic and shellcheck on all files in one command + doc generates the documentation sphinx-view-objects shows the named objects of the Sphinx documentation that can be referenced - rebuild forces the rebuild of the devenv docker image that is needed to run all the above commands - run spawn an interactive shell to run any arbitrary command in the devenv docker doc-serve starts a local HTTP python server on PORT to view generated documentation + bash spawns an interactive shell to run any arbitrary command in the devenv docker + run runs an arbitrary command in the devenv docker + rebuild forces the rebuild of the devenv docker image that is needed to run all the above commands + Before submitting a pull request, you'll need at minimum to run ``lint``. It might be a good idea to setup a git pre-commit hook to do this on modified files, see below.