[PATCH 0/3] Document the new build system

Sebastian Huber sebastian.huber at embedded-brains.de
Fri Jul 3 09:17:43 UTC 2020


This patch set adds an updated documetation of the new build system.
You can have a look at the generated documents here:

https://ftp.rtems.org/pub/rtems/people/sebh/user.pdf

https://ftp.rtems.org/pub/rtems/people/sebh/eng.pdf

Changes from the previous version:

* Doorstop was removed as the tool to manage the build specification
  items.  The how-to section was updated accordingly.  Only a text
  editor is now required to manage the items.

* The documenation of the build specification item types in the RTEMS
  Software Engineering  manual is now generated by a script from
  specification items:

  https://git.rtems.org/sebh/rtems-qual.git/tree/spec2doc.py

  https://git.rtems.org/sebh/rtems-qual.git/tree/spec/spec

Sebastian Huber (3):
  common: Enable numfig role
  eng: Add build system chapter
  user: Document new build system

 common/conf.py             |   3 +
 eng/build-system.rst       | 406 +++++++++++++++++++++++++++++++++++++
 eng/index.rst              |   1 +
 images/eng/bld-bsp.dot     |  33 +++
 images/eng/bld-bsp.pdf     | Bin 0 -> 15044 bytes
 images/eng/bld-bsp.png     | Bin 0 -> 32435 bytes
 images/eng/bld-bsp2.dot    |  42 ++++
 images/eng/bld-bsp2.pdf    | Bin 0 -> 16314 bytes
 images/eng/bld-bsp2.png    | Bin 0 -> 33936 bytes
 images/eng/bld-deps.dot    |  59 ++++++
 images/eng/bld-deps.pdf    | Bin 0 -> 18559 bytes
 images/eng/bld-deps.png    | Bin 0 -> 18098 bytes
 images/eng/bld-deps2.dot   |  52 +++++
 images/eng/bld-deps2.pdf   | Bin 0 -> 18241 bytes
 images/eng/bld-deps2.png   | Bin 0 -> 40695 bytes
 user/bld/index.rst         | 283 ++++++++++++++++++++++++++
 user/index.rst             |   1 +
 user/start/bootstrap.rst   |  61 ------
 user/start/bsp-build.rst   | 149 ++++++--------
 user/start/bsp-test.rst    |  14 +-
 user/start/index.rst       |   1 -
 user/start/preparation.rst |  10 +-
 22 files changed, 961 insertions(+), 154 deletions(-)
 create mode 100644 eng/build-system.rst
 create mode 100644 images/eng/bld-bsp.dot
 create mode 100644 images/eng/bld-bsp.pdf
 create mode 100644 images/eng/bld-bsp.png
 create mode 100644 images/eng/bld-bsp2.dot
 create mode 100644 images/eng/bld-bsp2.pdf
 create mode 100644 images/eng/bld-bsp2.png
 create mode 100644 images/eng/bld-deps.dot
 create mode 100644 images/eng/bld-deps.pdf
 create mode 100644 images/eng/bld-deps.png
 create mode 100644 images/eng/bld-deps2.dot
 create mode 100644 images/eng/bld-deps2.pdf
 create mode 100644 images/eng/bld-deps2.png
 create mode 100644 user/bld/index.rst
 delete mode 100644 user/start/bootstrap.rst

-- 
2.26.2



More information about the devel mailing list