Commit Graph

7 Commits

Author SHA1 Message Date
Simon Glass
8891453c77 doc: Provide a motivation for ulib
The reason for providing a U-Boot library will not be obvious to many.
Add a comment about this.

Signed-off-by: Simon Glass <sjg@chromium.org>
2025-09-11 15:19:22 -06:00
Simon Glass
bc33a6a74d doc: ulib: Add Rust examples documentation
Add docs for the Rust examples in the ulib documentation, covering:

- Rust demo programs (dynamic and static linking)
- Build instructions using both Makefile and cargo
- u-boot-sys crate structure and FFI bindings
- Building examples outside the U-Boot tree

This provides parallel documentation to the existing C examples, making
it possible to use either language with ulib.

Co-developed-by: Claude <noreply@anthropic.com>
Signed-off-by: Simon Glass <sjg@chromium.org>
2025-09-11 15:19:22 -06:00
Simon Glass
f5570d48b6 doc: ulib: Clarify calling functions in any header
It is already possible to call functions in any U-Boot header. Add more
detail to explain what is meant in this 'future work' item.

Signed-off-by: Simon Glass <sjg@chromium.org>
2025-09-11 15:19:22 -06:00
Simon Glass
2700bef70c doc: Fix a few nits in the ulib docs
TIdy up a few minor typos and grammar errors.

Signed-off-by: Simon Glass <sjg@chromium.org>
2025-09-11 15:19:22 -06:00
Simon Glass
cf01d4702f ulib: doc: Expand the documentation to cover new features
Most of the ulib functionality is in place now. Update the documentation
to match. Include details of how to run the example.

Signed-off-by: Simon Glass <sjg@chromium.org>
2025-09-08 13:10:54 -06:00
Simon Glass
6eace9ce95 doc: ulib: Provide some documentation on the ulib examples
Update the documentation to point to the examples.

Series-to: concept
Cover-letter:
ulib: Provide examples for building outside the tree
The ulib tests are built within the U-Boot build system, so make use of
various settings which are provided.

When using ulib outside the U-Boot tree (and outside its build
environment), things are a little more tricky.

This series provides a few simple examples to illustrate how to make
it work. An example Makefile is provided as well.

The same Makefile is used from CI just to ensure that it continues to
work as expected.
END

Signed-off-by: Simon Glass <sjg@chromium.org>
2025-09-05 15:47:40 -06:00
Simon Glass
00548f1c6a doc: Add ulib documentation for shared and static libraries
Add documentation for the U-Boot Library (ulib) feature, explaining how
to build and use both shared (.so) and static (.a) libraries.

Series-to: concept
Cover-letter:
ulib: Provide test programs and documentation
This series completes the implementation of a basic U-Boot library:

- ensure that no output is written during init
- provide a static library to match the existing shared library
- add test programs for both, to ensure they continue to build correctly
- provide documentation to describe how to use the libraries

This is still very early in the implementation, but this series provides
enough for some initial experimentation.
END

Co-developed-by: Claude <noreply@anthropic.com>
Signed-off-by: Simon Glass <sjg@chromium.org>
Series-links: 1:25
2025-09-05 12:51:05 -06:00