Age | Commit message (Collapse) | Author |
|
Change-Id: Ica15c40b54cde1cf0ae365ed80c38d2f086f6b2f
Signed-off-by: Anton Komlev <anton.komlev@arm.com>
|
|
CMake fails to generate proper rules for PDF generation both for the
Reference Manual (doxygen) and for the user Guide. The problem is
caused by CMAKE_MAKE_PROGRAM not being set when the document creation
targets are defined. As a result CMake generates "empty" targets which
do not execute the final step of PDF generation. The problem was
triggered by project re-organization.
To fix the problem document generation files are included after the
project() command. Also the defined state of CMAKE_MAKE_PROGRAM is
verified and a meaningful error message is printed to make the build
more robust.
In addition
- I made some minor changes to make the document build related cmake
files more consistent.
- Fixed spelling issues.
Change-Id: Id5d8dc756a50b3fee8966b51461ad3607d2027b4
Signed-off-by: Gyorgy Szing <Gyorgy.Szing@arm.com>
|
|
Adds include of Utils.cmake to FindPlantUML.cmake. Solves the
building error `Unknown CMake command win_fix_dir_sep`.
Change-Id: Iaed5a6cc92e96832e668f32065d73d28d59033e5
Signed-off-by: Tudor Cretu <tudor.cretu@arm.com>
|
|
Technical documentation of TF-M is captured in GitHub flavored
markdown files. This change add support for building HTML and
PDF output of these files using the Sphinx tool.
Change-Id: I8be11256f2c654c248b1974974a5de6190ca0fc3
Signed-off-by: Gyorgy Szing <Gyorgy.Szing@arm.com>
|
|
This change enables checking for availability of tools needed to build
the doxygen documentation (Reference Manual), and building the manual.
During the configuration phase CMake will search for doxygen, PlanUML,
dot, java and Latex tools.
Then it will "configure" the file doxygen/Doxyfile.in, and generate
the following targets:
- doc_refman: to build HTML documentation
- doc_refman_pdf: to build PDF documentation
- install_doc: to install all build documentation files
If any mandatory tool is missing, CMake will issue a warning and not
generate the targets. Thus missing tools will not stop the user to build
the firmware, just remove the documentation build capability.
PDF generation is optional, if latex is missing, HTML documentation
can still be generated.
Change was tested on:
-Win10 with native windows doxygen and MixTex for PDF generation.
-Linux Mint 18.1 Serena (based on Ubuntu 16.04 - Xenial Xerus)
Change-Id: I25fb80bb8eee8e510c9bd55bffb5974d2360651f
Signed-off-by: Gyorgy Szing <Gyorgy.Szing@arm.com>
|