We want portable shell scripts, not plain bash-specific scripts.
authorNils Gillmann <ng0@n0.is>
Sun, 21 Oct 2018 18:49:41 +0000 (18:49 +0000)
committerNils Gillmann <ng0@n0.is>
Sun, 21 Oct 2018 18:49:41 +0000 (18:49 +0000)
Signed-off-by: Nils Gillmann <ng0@n0.is>
doc/documentation/chapters/contributing.texi

index ed1c19b30d640296ec074f973affc99245c676fd..f4493e6c1bd2b1560d806848a5e857d4cd16db34 100644 (file)
@@ -95,14 +95,23 @@ of languages, in order of preference:
 @enumerate
 @item C
 @item Portable Shell Scripts
-@item Bash Scripts
-@c Nim ?
 @item Python (@geq{}3.6)
 @end enumerate
 
 We welcome efforts to remove our existing python-2.7 scripts to
-replace them either with Bash or, at your choice, python-3.6+.
+replace them either with portable shell scripts or,
+at your choice, python-3.6+.
 
 If you contribute new python based testcases, we advise you to
 not repeat our past misfortunes and write the tests in a standard
 test framework like for example pytest.
+
+For writing portable shell scripts, these tools are useful:
+@uref{https://github.com/koalaman/shellcheck, Shellcheck},
+@uref{https://salsa.debian.org/debian/devscripts/blob/master/scripts/checkbashisms.pl, checkbashisms},
+@uref{http://www.etalabs.net/sh_tricks.html},
+@uref{https://wiki.ubuntu.com/DashAsBinSh},
+and @uref{https://mywiki.wooledge.org/Bashism}
+
+@c You could also run "bin/check_shell_script" (which we still have
+@c to write).