diff mbox series

[Concept,2/2] doc: gcc: Document Rust toolchain for ulib examples

Message ID 20260316184650.3881337-3-sjg@u-boot.org
State New
Headers
Series doc: gcc: Add missing build dependencies |

Commit Message

Simon Glass March 16, 2026, 6:46 p.m. UTC 
  From: Simon Glass <sjg@chromium.org>

Boards with CONFIG_ULIB automatically build the Rust examples in
examples/rust/ when cargo is available. Document how to install the
Rust toolchain via rustup.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

 doc/build/gcc.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
diff mbox series

Patch

diff --git a/doc/build/gcc.rst b/doc/build/gcc.rst
index ae1168b20ff..847b39b0d7b 100644
--- a/doc/build/gcc.rst
+++ b/doc/build/gcc.rst
@@ -218,6 +218,20 @@  Important ones are
 * clean - remove most generated files but keep the configuration
 * mrproper - remove all generated files + config + various backup files
 
+Rust examples
+~~~~~~~~~~~~~
+
+Boards with ``CONFIG_ULIB`` (sandbox, qemu_arm64, qemu-x86, qemu-riscv64 and
+others) automatically build the Rust examples in ``examples/rust/`` if
+``cargo`` is found.  The recommended way to install the Rust toolchain is via
+`rustup <https://rustup.rs/>`_:
+
+.. code-block:: bash
+
+    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+
+If ``cargo`` is not installed the Rust examples are silently skipped.
+
 Installation
 ------------