Skip to content

Commit

Permalink
fix: adding run command in code to match doc (#460)
Browse files Browse the repository at this point in the history
* fix: devenv: sync doc and actually supported commands, add run cmd

---------

Co-authored-by: perrze <[email protected]>
Co-authored-by: Stéphane Lesimple <[email protected]>
Co-authored-by: Adrien Barreau <[email protected]>
  • Loading branch information
4 people authored Apr 8, 2024
1 parent f51bee2 commit 010959c
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions docker/devenv/run-tool.sh
Original file line number Diff line number Diff line change
Expand Up @@ -72,22 +72,26 @@ case "$cmd" in
fi
;;
bash) docker exec -it $NAME bash;;
run) docker exec -it $NAME "$@";;
*)
cat <<EOF
Usage: $0 COMMAND [OPTIONS]
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 <COMMAND> spawn an interactive shell to run any arbitrary command in the devenv docker
doc-serve <PORT> 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 <COMMAND> 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
EOF
esac

0 comments on commit 010959c

Please sign in to comment.