1
0
mirror of https://github.com/koalaman/shellcheck.git synced 2025-01-03 17:50:07 -08:00

Created SC2329 (markdown)

Vidar Holen 2024-05-04 14:44:08 -07:00
parent b8b5efd1c7
commit 904cc04561

35
SC2329.md Normal file

@ -0,0 +1,35 @@
## This function is never invoked. Check usage (or ignored if invoked indirectly).
### Problematic code:
```sh
#!/bin/sh
f() {
echo "Hello World"
}
exit
```
### Correct code:
```sh
#!/bin/sh
f() {
echo "Hello World"
}
f
exit
```
### Rationale:
ShellCheck found a function that goes out of scope before it's ever invoked. Verify that the function is called. It could be misspelled, or its invocation could also be unreachable (as in `f() { ..; }; exit; f`).
Note that if the example script did not end in `exit`, this warning would not be emitted. This is because the function could be invoked by another script that `source`s it.
### Exceptions:
ShellCheck is currently bad at figuring out functions that are invoked via `trap`. In such cases, please [[ignore]] the message with a directive.
### Related resources:
* Help by adding links to BashFAQ, StackOverflow, man pages, POSIX, etc!