From 50c9d9395151ef1cca8812b21984ba4ae2b9467a Mon Sep 17 00:00:00 2001 From: chrysn Date: Thu, 1 Feb 2024 14:39:43 +0100 Subject: [PATCH] rust/doc: Document `make info-rust` for IDE/editor setup --- doc/doxygen/src/using-rust.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/doxygen/src/using-rust.md b/doc/doxygen/src/using-rust.md index e89b37e5e0ee..e72114fe8bb5 100644 --- a/doc/doxygen/src/using-rust.md +++ b/doc/doxygen/src/using-rust.md @@ -39,6 +39,16 @@ maintained in coordination with the riot-wrappers crate. [riot-module-examples]: https://gitlab.com/etonomy/riot-module-examples [additional examples]: https://gitlab.com/etonomy/riot-examples/ +IDE / editor setup +------------------ + +Users of Rust often take advantage of autocompletion or inline help. +To use this on RIOT projects, +some flags and environment variables have to be set, +which are listed by `make info-rust`. +These can be configured in the IDE's project setup +or exported as environment variables. + How it works ------------