Skip to content

Commit 9550c64

Browse files
committed
docs: fw_binaries: Add documentation about paths-relative-to
This new option of the configuration file indicates that paths to images are relative to a specific path. Signed-off-by: Félix Piédallu <[email protected]>
1 parent 9fdc428 commit 9550c64

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/fw_binaries.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ explains what firmware and configuration options are needed for each SoC family.
1010
A firmware configuration file for snagrecover has the following structure:
1111

1212
```
13+
paths-relative-to: THIS_FILE
1314
fw_1:
1415
path: /path/to/fw_1
1516
option1: value1
@@ -28,6 +29,20 @@ type of SoC you are using, you will probably want to configure your U-Boot build
2829
so that it can interact with snagflash correctly after recovery (e.g. use DFU,
2930
UMS or fastboot).
3031

32+
The key `paths-relative-to` is optional and indicates that paths to images are
33+
relative to a specific path, either:
34+
35+
- `CWD`: the current working directory, e.g the default behaviour
36+
- `THIS_FILE`: the directory containing the current configuration file
37+
- a path to a directory.
38+
39+
If `THIS_FILE` or a path is specified, snagrecover will effectively join this
40+
path and the images paths. `CWD` is actually a no-op and will keep the default
41+
behaviour.
42+
Absolute paths to images will not be modified by this option.
43+
44+
This is useful when distributing the configuration file alongside images.
45+
3146
## General tips on configuring U-Boot
3247

3348
In many cases, in can be necessary to build the recovery U-Boot yourself e.g.

0 commit comments

Comments
 (0)