mirror of
https://git.proxmox.com/git/mirror_zfs.git
synced 2024-11-17 10:01:01 +03:00
f9caf08a74
Google moved their style guides to GitHub. Update the shell style guide URL to the new location. Reviewed-by: George Melikov <mail@gmelikov.ru> Reviewed-by: Giuseppe Di Natale <dinatale2@llnl.gov> Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Christopher Voltz <christopher.voltz@hpe.com> Closes #5797
31 lines
1.0 KiB
Plaintext
31 lines
1.0 KiB
Plaintext
Shell scripts are the recommended choice for ZEDLETs that mostly call
|
|
other utilities and do relatively little data manipulation.
|
|
|
|
Shell scripts MUST work on both bash and dash.
|
|
|
|
Shell scripts MUST run cleanly through ShellCheck:
|
|
http://www.shellcheck.net/
|
|
|
|
General functions reside in "zed-functions.sh". Use them where applicable.
|
|
|
|
Additional references that may be of use:
|
|
|
|
Google Shell Style Guide
|
|
https://github.com/google/styleguide/blob/gh-pages/shell.xml
|
|
|
|
Dash as /bin/sh
|
|
https://wiki.ubuntu.com/DashAsBinSh
|
|
|
|
Common shell script mistakes
|
|
http://www.pixelbeat.org/programming/shell_script_mistakes.html
|
|
|
|
Filenames and Pathnames in Shell: How to do it Correctly
|
|
http://www.dwheeler.com/essays/filenames-in-shell.html
|
|
|
|
Autoconf: Portable Shell Programming
|
|
https://www.gnu.org/software/autoconf/manual/autoconf.html#Portable-Shell
|
|
|
|
Please BE CONSISTENT with the existing style, check for errors,
|
|
minimize dependencies where possible, try to be portable,
|
|
and comment anything non-obvious. Festina lente.
|