maintain/style: notes about work directory

Signed-off-by: Leah Rowe <leah@libreboot.org>
master
Leah Rowe 2023-09-15 08:04:41 +01:00
parent a575774180
commit 10dd889a2a
1 changed files with 12 additions and 0 deletions

View File

@ -82,6 +82,8 @@ attention to how the functions are formatted, e.g. where `{` and `}` go:
```
#!/usr/bin/env sh
. "include/err.sh"
main()
{
foo
@ -119,6 +121,16 @@ complicated_function()
main $@
```
PWD is always root of lbmk
--------------------------
In any script executed by lbmk, under `script/`, the work directory is relative
to the main `lbmk` script. In other words, all scripts under `script/` also
assume this.
This is actually one of the reasons for that design, as also alluded to in
the main [lbmk maintenance manual](index.md).
main should only be a simple skeleton
-------------------------------------