libreboot
/
lbwww
1
0
Fork 0
Code Packages Projects Releases Activity

maintain/style: update err reference 

it's a variable now, called err, rather than
 a function called err. the variable defines
the name of a function that handles errors.

Signed-off-by: Leah Rowe <info@minifree.org>
master
Leah Rowe 2024-08-29 21:11:48 +01:00
parent 9909590362
commit d450d080ff
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
site/docs/maintain/style.md
View File

@ -82,7 +82,7 @@ attention to how the functions are formatted, e.g. where `{` and `}` go:
```
#!/usr/bin/env sh
. "include/err.sh"
. "include/lib.sh"
main()
{
@ -94,7 +94,7 @@ main()
foo()
{
printf "I'm a function that does stuff.\n"
bar || err "foo: an error occured"
bar || $err "foo: an error occured"
do_something_else
}
@ -107,7 +107,7 @@ bar()
do_something_else()
{
complicated_function bla bla bla || \
err "do_something_else: something happened that wasn't nice"
$err "do_something_else: something happened that wasn't nice"
}
complicated_function()
@ -169,7 +169,7 @@ However, neither of these should be relied upon exclusively. When a script runs
must be handled.
The general rule is to call `err()`, which is provided in lbmk by
the file `include/err.sh`. This is inspired by the way `err()` is called in
the file `include/lib.sh`. This is inspired by the way `err()` is called in
BSD programs (from `err.h`, a non-standard BSD libc extension).
Where a script must perform certain cleanup before exiting, the script should
@ -177,11 +177,11 @@ implement its own `fail()` function that performs cleanup, and then
calls `err()`. The `err()` function takes a string as argument, which will be
printed to the screen.
If `err` is being called from `main()`, just write the error message. However,
If `$err` is being called from `main()`, just write the error message. However,
if it's being called from another function, you should write the function name.
For example:
err "function_name: this shit doesn't work. fix it."
$err "function_name: this shit doesn't work. fix it."
Do not directly exit
--------------------
@ -276,7 +276,7 @@ follow-up line. For example:
function_name()
{
really stupidly long command that may also return error state || \
err "function_name: you fucked up. try again."
$err "function_name: you fucked up. try again."
}
```