diff options
author | Nils Gillmann <ng0@n0.is> | 2018-10-21 18:49:41 +0000 |
---|---|---|
committer | Nils Gillmann <ng0@n0.is> | 2018-10-21 18:49:41 +0000 |
commit | a3991d078b2583cd09e58230333e8070a723e332 (patch) | |
tree | f656c74827e908a388ae7fe4a7dd71521c8dc5dd /doc | |
parent | 93def6b58a5ed44d6752958b08a3e49e418f3dda (diff) | |
download | gnunet-a3991d078b2583cd09e58230333e8070a723e332.tar.gz gnunet-a3991d078b2583cd09e58230333e8070a723e332.zip |
We want portable shell scripts, not plain bash-specific scripts.
Signed-off-by: Nils Gillmann <ng0@n0.is>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/documentation/chapters/contributing.texi | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/doc/documentation/chapters/contributing.texi b/doc/documentation/chapters/contributing.texi index ed1c19b30..f4493e6c1 100644 --- a/doc/documentation/chapters/contributing.texi +++ b/doc/documentation/chapters/contributing.texi | |||
@@ -95,14 +95,23 @@ of languages, in order of preference: | |||
95 | @enumerate | 95 | @enumerate |
96 | @item C | 96 | @item C |
97 | @item Portable Shell Scripts | 97 | @item Portable Shell Scripts |
98 | @item Bash Scripts | ||
99 | @c Nim ? | ||
100 | @item Python (@geq{}3.6) | 98 | @item Python (@geq{}3.6) |
101 | @end enumerate | 99 | @end enumerate |
102 | 100 | ||
103 | We welcome efforts to remove our existing python-2.7 scripts to | 101 | We welcome efforts to remove our existing python-2.7 scripts to |
104 | replace them either with Bash or, at your choice, python-3.6+. | 102 | replace them either with portable shell scripts or, |
103 | at your choice, python-3.6+. | ||
105 | 104 | ||
106 | If you contribute new python based testcases, we advise you to | 105 | If you contribute new python based testcases, we advise you to |
107 | not repeat our past misfortunes and write the tests in a standard | 106 | not repeat our past misfortunes and write the tests in a standard |
108 | test framework like for example pytest. | 107 | test framework like for example pytest. |
108 | |||
109 | For writing portable shell scripts, these tools are useful: | ||
110 | @uref{https://github.com/koalaman/shellcheck, Shellcheck}, | ||
111 | @uref{https://salsa.debian.org/debian/devscripts/blob/master/scripts/checkbashisms.pl, checkbashisms}, | ||
112 | @uref{http://www.etalabs.net/sh_tricks.html}, | ||
113 | @uref{https://wiki.ubuntu.com/DashAsBinSh}, | ||
114 | and @uref{https://mywiki.wooledge.org/Bashism} | ||
115 | |||
116 | @c You could also run "bin/check_shell_script" (which we still have | ||
117 | @c to write). | ||