docs: Clarify documentation for binaries and docs builds
Signed-off-by: Anton Komlev <anton.komlev@arm.com>
Change-Id: I0a412426c40717e086c9bc4330cbb27a4cc810ad
diff --git a/docs/getting_started/tfm_getting_started.rst b/docs/getting_started/tfm_getting_started.rst
index 4e32ec3..5ea61b1 100644
--- a/docs/getting_started/tfm_getting_started.rst
+++ b/docs/getting_started/tfm_getting_started.rst
@@ -338,38 +338,15 @@
To build the TF-M firmware the following tools are needed:
-.. csv-table:: Tool dependencies
- :header: "Name", "Version", "Component"
+ - C compiler of supported toolchains
+ - CMake version 3.15 or later
+ - Git
+ - gmake, aka GNU Make
+ - Python v3.x
+ - a set of python modules listed in ``tools/requiremtns.txt``
- "C compiler",,"Firmware"
- "CMake",,
- "GNU Make",,
- "tf-m-tests",CMake handles it,
- "mbed-crypto",CMake handles it,
- "MCUboot",CMake handles it,
- "Python",3.x,"Firmware, User Guide"
- "yaml",,"Firmware"
- "pyasn1",,"Firmware"
- "jinja2",,"Firmware"
- "cryptography",,"Firmware"
- "cbor",,"Firmware"
- "click",,"Firmware"
- "imgtool",,"Firmware"
- "Doxygen",">1.8","Reference manual"
- "Sphinx","=2.0.1","User Guide"
- "sphinxcontrib-plantuml",,"User Guide"
- "sphinxcontrib-svg2pdfconverter",,"User Guide"
- "sphinx-rtd-theme",,"User Guide"
- "sphinx-tabs",,"User Guide"
- "Git",,
- "PlantUML",">v1.2018.11","Reference Manual, User Guide"
- "Graphviz dot",">v2.38.0","Reference manual"
- "Java runtime environment (JRE)",">1.8","Reference Manual, User Guide"
- "LaTex",,"pdf version of Reference Manual and User Guide"
- "PdfLaTex",,"pdf version of Reference Manual and User Guide"
- "librsvg2-bin",, "User Guide"
-
-Dependency chain:
+Dependency chain
+----------------
.. uml::
@@ -380,32 +357,15 @@
FontSize 16
AttributeFontColor black
AttributeFontSize 16
- BackgroundColor<<pdf>> #A293E2
- BackgroundColor<<doc>> #90DED6
}
state fw as "Firmware" : TF-M binary
state c_comp as "C Compiler" : C99
- state gmake as "GNU make"
- state u_guide as "User Guide" <<doc>>
- state refman as "Reference Manual" <<doc>>
- state rtd_theme as "sphinx-rtd-theme" <<doc>>
- state tabs as "sphinx-tabs" <<doc>>
- state sphnix_puml as "sphinxcontrib-plantuml" <<doc>>
- state sphnix_svg as "sphinxcontrib-svg2pdfconverter" <<doc>>
- state JRE as "JRE" <<doc>> : Java Runtime Environment
- state gwiz as "Graphwiz dot" <<doc>>
- state Sphinx as "Sphinx" <<doc>>
- state m2r as "m2r" <<doc>>
- state PlantUML as "PlantUML" <<doc>>
- state LaTex as "LaTex" <<pdf>>
- state PdfLaTex as "PdfLaTex" <<<<pdf>>>>
- state Doxygen as "Doxygen" <<doc>>
- state librsvg as "librsvg2-bin" <<doc>>
+ state python as "Python" : v3.x
- [*] --> fw
fw --> c_comp
fw --> CMake
CMake --> gmake
+ CMake --> Ninja
fw --> cryptography
fw --> pyasn1
fw --> yaml
@@ -413,43 +373,16 @@
fw --> cbor
fw --> click
fw --> imgtool
- cryptography --> Python3
- pyasn1 --> Python3
- yaml --> Python3
- jinja2 --> Python3
- cbor --> Python3
- click --> Python3
- imgtool --> Python3
-
- [*] --> u_guide
- u_guide --> Sphinx
- Sphinx --> m2r
- Sphinx --> rtd_theme
- Sphinx --> tabs
- Sphinx --> sphnix_puml
- Sphinx --> sphnix_svg
- m2r --> Python3
- rtd_theme --> Python3
- tabs --> Python3
- sphnix_puml --> Python3
- sphnix_svg --> Python3
- sphnix_svg --> librsvg
- Sphinx --> PlantUML
- PlantUML --> JRE
- PlantUML --> gwiz
- Sphinx --> LaTex
- LaTex --> PdfLaTex
-
- [*] --> refman
- refman --> Doxygen
- Doxygen --> PlantUML
- Doxygen --> LaTex
- state Legend {
- state x as "For PDF generation only" <<pdf>>
- state y as "For document generation only" <<doc>>
- state z as "Mandatory"
- }
-
+ c_comp --> GCC
+ c_comp --> CLANG
+ c_comp --> IAR
+ cryptography --> python
+ pyasn1 --> python
+ yaml --> python
+ jinja2 --> python
+ cbor --> python
+ click --> python
+ imgtool --> python
@enduml
##########