[PATCH rtems-docs 0/1] user: Add docu for use of Rust with RTEMS

Frank Kuehndel frank.kuehndel at embedded-brains.de
Fri Feb 16 20:52:52 UTC 2024


From: Frank Kühndel <frank.kuehndel at embedded-brains.de>

This is the long promised Rust on RTEMS step-by-step guide.

For reviewing it, I suggest the natural order:

  1) user/rust/index.rst -- The introduction
  2) user/rust/bare-metal.rst -- The step-by-step guide
  
If you prefer reviewing the PDF or HTML, you can download them here:

  https://share.embedded-brains.de/index.php/s/morK77CeTdXwpc4

Some notes/questions:

* I did not find the right place where to put this text. Currently,
  it is an extra chapter at top level in the user manual. Chapter
  "Quick Start" seemed not to be the right place to me.

* I assume that someone (DLR?) writes a step-by-step guide for
  using Rust with libstd once it becomes available. This might be
  an additional section in an extra file next to

    user/rust/bare-metal.rst

  Moreover, the current paragraph "At the time of writing no such
  target exists. [...]" will then be removed/replaced.

* There are a few links to external sources. Should they be deleted?

* There is a sub-section on creating a container. This sub-section
  is completely optional. I used this container to test the
  instructions in a clean environment. There are good reasons to keep
  it in the document and there are good reasons to remove it. What do
  you think?

* I wrote instructions to "Build the RTEMS Tools" and to "Build and
  Install the RTEMS BSPs". Yet, I could just refer to the
  "Quick Start" sections instead. I believe it is more straightforward
  for the reader the way it is now. Do you prefer these sections to be
  removed?

Frank Kühndel (1):
  user: Add docu for use of Rust with RTEMS

 user/index.rst           |   3 +-
 user/overview/index.rst  |   2 +
 user/rust/bare-metal.rst | 549 +++++++++++++++++++++++++++++++++++++++
 user/rust/index.rst      |  64 +++++
 4 files changed, 617 insertions(+), 1 deletion(-)
 create mode 100644 user/rust/bare-metal.rst
 create mode 100644 user/rust/index.rst

-- 
2.35.3



More information about the devel mailing list