zfs/cmd/zed/zed.d
Brian Behlendorf 1180d61152 Fix minor shellcheck 0.7.2 warnings
The first warning of a misspelling is a false positive, so we annotate
the script accordingly.  As for the x-prefix warnings update the check
to use the conventional '[ -z <string> ]' syntax.

all-syslog.sh:46:47: warning: Possible misspelling: ZEVENT_ZIO_OBJECT
    may not be assigned, but ZEVENT_ZIO_OBJSET is. [SC2153]
make_gitrev.sh:53:6: note: Avoid x-prefix in comparisons as it no
    longer serves a purpose [SC2268]
man-dates.sh:10:7: note: Avoid x-prefix in comparisons as it no
    longer serves a purpose [SC2268]

Reviewed-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
Reviewed-by: John Kennedy <john.kennedy@delphix.com>
Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov>
Closes #12208
2021-06-10 10:50:16 -07:00
..
.gitignore systemd mount generator and tracking ZEDLET 2018-04-06 14:11:09 -07:00
Makefile.am zed.d/all-debug.sh: simplify 2021-06-09 13:06:09 -07:00
README Fix broken URL 2017-02-15 11:15:38 -08:00
all-debug.sh zed.d/all-debug.sh: simplify 2021-06-09 13:06:09 -07:00
all-syslog.sh Fix minor shellcheck 0.7.2 warnings 2021-06-10 10:50:16 -07:00
data-notify.sh zed.d/*-notify.sh: use mktemp instead of generating temp path manually 2021-05-10 12:11:44 -07:00
generic-notify.sh zed.d/*-notify.sh: use mktemp instead of generating temp path manually 2021-05-10 12:11:44 -07:00
history_event-zfs-list-cacher.sh.in zed.d/history_event-zfs-list-cacher.sh.in: parallelise, simplify 2021-06-09 13:06:39 -07:00
pool_import-led.sh Enclosure LED fixes 2017-02-10 16:09:45 -08:00
resilver_finish-notify.sh OpenZFS 5997 - FRU field not set during pool creation and never updated 2016-08-12 13:06:48 -07:00
resilver_finish-start-scrub.sh Add device rebuild feature 2020-07-03 11:05:50 -07:00
scrub_finish-notify.sh zed.d/*-notify.sh: use mktemp instead of generating temp path manually 2021-05-10 12:11:44 -07:00
statechange-led.sh zed.d/pool_import-led.sh: fix for current zpool scripts 2021-05-10 12:11:33 -07:00
statechange-notify.sh zed.d/*-notify.sh: use mktemp instead of generating temp path manually 2021-05-10 12:11:44 -07:00
trim_finish-notify.sh zed.d/*-notify.sh: use mktemp instead of generating temp path manually 2021-05-10 12:11:44 -07:00
vdev_attach-led.sh Fix statechange-led.sh & unnecessary libdevmapper warning 2016-10-25 11:05:30 -07:00
vdev_clear-led.sh Multipath autoreplace, control enclosure LEDs, event rate limiting 2016-10-19 12:55:59 -07:00
zed-functions.sh zed-functions.sh: zed_lock(): don't truncate lock 2021-06-09 13:06:05 -07:00
zed.rc zed syslog entries drop important info 2020-10-19 11:01:00 -07:00

README

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.