| Message ID | 20210411164435.26361-3-andreas@fatal.se |
|---|---|
| State | Changes Requested |
| Headers | show |
| Series | manpages in scdoc format | expand |
On 11.04.21 18:44, Andreas Henriksson wrote: > Signed-off-by: Andreas Henriksson <andreas@fatal.se> > --- > docs/fw_env.config.5.scd | 45 ++++++++++++++++++++++++++++++++++++++++ > 1 file changed, 45 insertions(+) > create mode 100644 docs/fw_env.config.5.scd > > diff --git a/docs/fw_env.config.5.scd b/docs/fw_env.config.5.scd > new file mode 100644 > index 0000000..389b365 > --- /dev/null > +++ b/docs/fw_env.config.5.scd > @@ -0,0 +1,45 @@ > +fw_env.config(5) "April 2021" "libubootenv" > + > +# SYNOPSIS > + > +*/etc/fw_env.config* > + > +# DESCRIPTION > + > +*fw_printenv* and *fw_setenv* expects a file that specifies where the > +U-Boot environment lives, the offset and the size. > + > +The file can consist of one or two lines, depending on if it's > +a traditionally or redundantly saved environment. > + > +If you use a traditional (non-redundant) environment the file *must* > +contain one line. If you use a redundantly stored environment the > +file *must* consist of two lines. > +The traditional and redundant environments uses different on-disk formats > +and are not interchangable. > + THings can become more complicated as here, for example if you want to say "please use the last N bytes from an eMMC device". You can simply say that this is documented in U-Boot (somewhere, yes...) and add a link here to U-Boot project. > +# SYNTAX > + > +``` > +<path> <offset> <size> > +[<path> <offset> <size>] > +``` > + > +# EXAMPLES > + > +Non-redundant environment on MMC device: > + > +``` > +/dev/mmcblk0 0x260000 0x2000 > +``` > + > +Redundant environment on MMC device: > + > +``` > +/dev/disk/by-path/platform-481d8000.mmc 0x260000 0x20000 > +/dev/disk/by-path/platform-481d8000.mmc 0x300000 0x20000 > +``` > + > +# SEE ALSO > + > +fw_printenv(1), fw_setenv(1) > Best regards, Stefano Babic
diff --git a/docs/fw_env.config.5.scd b/docs/fw_env.config.5.scd new file mode 100644 index 0000000..389b365 --- /dev/null +++ b/docs/fw_env.config.5.scd @@ -0,0 +1,45 @@ +fw_env.config(5) "April 2021" "libubootenv" + +# SYNOPSIS + +*/etc/fw_env.config* + +# DESCRIPTION + +*fw_printenv* and *fw_setenv* expects a file that specifies where the +U-Boot environment lives, the offset and the size. + +The file can consist of one or two lines, depending on if it's +a traditionally or redundantly saved environment. + +If you use a traditional (non-redundant) environment the file *must* +contain one line. If you use a redundantly stored environment the +file *must* consist of two lines. +The traditional and redundant environments uses different on-disk formats +and are not interchangable. + +# SYNTAX + +``` +<path> <offset> <size> +[<path> <offset> <size>] +``` + +# EXAMPLES + +Non-redundant environment on MMC device: + +``` +/dev/mmcblk0 0x260000 0x2000 +``` + +Redundant environment on MMC device: + +``` +/dev/disk/by-path/platform-481d8000.mmc 0x260000 0x20000 +/dev/disk/by-path/platform-481d8000.mmc 0x300000 0x20000 +``` + +# SEE ALSO + +fw_printenv(1), fw_setenv(1)
Signed-off-by: Andreas Henriksson <andreas@fatal.se> --- docs/fw_env.config.5.scd | 45 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 docs/fw_env.config.5.scd