README.rst 2.14 KB
Newer Older
Stefano Babic's avatar
Stefano Babic committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
libubootenv - Library to access U-Boot environment
==================================================

libubootenv is a library that provides a hardware independent way to access
to U-Boot environment. U-Boot has its default environment compiled board-dependently
and this means that tools to access the environment are also board specific, too.

Source Code: https://github.com/sbabic/libubootenv

Documentation (doxygen): https://sbabic.github.io/libubootenv

Replacement old tools
---------------------

Part of the library are the replacement of the "fw_printenv / fw_setenv" tools that
can be used with any board - they accept as parameter a file as initial environment if none is found
on the persistent storage. The syntax for the file and for the data configuration file
is the same as the one described in the U-Boot project.

::

        Usage fw_printenv [OPTION]
         -h,                              : print this help
         -c, --config <filename>          : configuration file (old fw_env.config)
         -f, --defenv <filename>          : default environment if no one found
         -V,                              : print version and exit
         -n, --no-header                  : do not print variable name

        Usage fw_setenv [OPTION]
         -h,                              : print this help
         -c, --config <filename>          : configuration file (old fw_env.config)
         -f, --defenv <filename>          : default environment if no one found
         -V,                              : print version and exit
         -s, --script <filename>          : read variables to be set from a script

License
-------

39
libubootenv is licensed under LGPL-2.1
Stefano Babic's avatar
Stefano Babic committed
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55

OE / Yocto support
------------------

Recipe is provided in meta-swupdate layer https://github.com/sbabic/meta-swupdate.git 

Contributing to the project
---------------------------

Contributions are welcome !  You can submit your patches (or post questions
regarding the project) to the swupdate Mailing List:

	swupdate@googlegroups.com

Please read the [contributing](http://sbabic.github.io/swupdate/contributing.html)
chapter in the documentation how to contribute to the project.