Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in / Register
Toggle navigation
Menu
Open sidebar
adam.huang
Arm Trusted Firmware
Commits
989429e8
Commit
989429e8
authored
Jan 31, 2020
by
Sandrine Bailleux
Committed by
TrustedFirmware Code Review
Jan 31, 2020
Browse files
Merge "Add support for documentation build as a target in Makefile" into integration
parents
f69a5828
6de32378
Changes
3
Hide whitespace changes
Inline
Side-by-side
Makefile
View file @
989429e8
...
@@ -702,6 +702,9 @@ PYTHON ?= python3
...
@@ -702,6 +702,9 @@ PYTHON ?= python3
PRINT_MEMORY_MAP_PATH
?=
tools/memory
PRINT_MEMORY_MAP_PATH
?=
tools/memory
PRINT_MEMORY_MAP
?=
${PRINT_MEMORY_MAP_PATH}
/print_memory_map.py
PRINT_MEMORY_MAP
?=
${PRINT_MEMORY_MAP_PATH}
/print_memory_map.py
# Variables for use with documentation build using Sphinx tool
DOCS_PATH
?=
docs
################################################################################
################################################################################
# Include BL specific makefiles
# Include BL specific makefiles
################################################################################
################################################################################
...
@@ -878,7 +881,7 @@ endif
...
@@ -878,7 +881,7 @@ endif
# Build targets
# Build targets
################################################################################
################################################################################
.PHONY
:
all msg_start clean realclean distclean cscope locate-checkpatch checkcodebase checkpatch fiptool sptool fip fwu_fip certtool dtbs memmap
.PHONY
:
all msg_start clean realclean distclean cscope locate-checkpatch checkcodebase checkpatch fiptool sptool fip fwu_fip certtool dtbs memmap
doc
.SUFFIXES
:
.SUFFIXES
:
all
:
msg_start
all
:
msg_start
...
@@ -1076,6 +1079,10 @@ romlib.bin: libraries
...
@@ -1076,6 +1079,10 @@ romlib.bin: libraries
memmap
:
all
memmap
:
all
${Q}${PYTHON}
$(PRINT_MEMORY_MAP)
$(BUILD_PLAT)
${Q}${PYTHON}
$(PRINT_MEMORY_MAP)
$(BUILD_PLAT)
doc
:
@
echo
" BUILD DOCUMENTATION"
${Q}${MAKE}
--no-print-directory
-C
${DOCS_PATH}
html
cscope
:
cscope
:
@
echo
" CSCOPE"
@
echo
" CSCOPE"
${Q}
find
${CURDIR}
-name
"*.[chsS]"
>
cscope.files
${Q}
find
${CURDIR}
-name
"*.[chsS]"
>
cscope.files
...
@@ -1116,6 +1123,7 @@ help:
...
@@ -1116,6 +1123,7 @@ help:
@
echo
" sptool Build the Secure Partition Package creation tool"
@
echo
" sptool Build the Secure Partition Package creation tool"
@
echo
" dtbs Build the Device Tree Blobs (if required for the platform)"
@
echo
" dtbs Build the Device Tree Blobs (if required for the platform)"
@
echo
" memmap Print the memory map of the built binaries"
@
echo
" memmap Print the memory map of the built binaries"
@
echo
" doc Build html based documentation using Sphinx tool"
@
echo
""
@
echo
""
@
echo
"Note: most build targets require PLAT to be set to a specific platform."
@
echo
"Note: most build targets require PLAT to be set to a specific platform."
@
echo
""
@
echo
""
...
...
docs/change-log-upcoming.rst
View file @
989429e8
...
@@ -23,7 +23,7 @@ New Features
...
@@ -23,7 +23,7 @@ New Features
- Example: "Add support for Branch Target Identification (BTI)"
- Example: "Add support for Branch Target Identification (BTI)"
- Build System
- Build System
-
Example: "
Add support for d
efault stack-protector flag"
- Add support for d
ocumentation build as a target in Makefile
- CPU Support
- CPU Support
- Example: "cortex-a55: Workaround for erratum 1221012"
- Example: "cortex-a55: Workaround for erratum 1221012"
...
...
docs/getting_started/docs-build.rst
View file @
989429e8
...
@@ -56,21 +56,28 @@ as root or using ``sudo``.
...
@@ -56,21 +56,28 @@ as root or using ``sudo``.
Building rendered documentation
Building rendered documentation
-------------------------------
-------------------------------
From the ``docs`` directory of the project, run the following commands. It is
Documents can be built into HTML-formatted pages from project root directory by
important to note that you will not get the correct result if the commands are
running the following command.
run from the project root directory, as that would invoke the top-level Makefile
for |TF-A| itself.
.. code:: shell
.. code:: shell
make clean
make doc
make html
Output from the build process will be placed in:
Output from the build process will be placed in:
::
::
<tf-a root>/docs/build/html/
docs/build/html/
We also support building documentation in other formats. From the ``docs``
directory of the project, run the following command to see the supported
formats. It is important to note that you will not get the correct result if
the command is run from the project root directory, as that would invoke the
top-level Makefile for |TF-A| itself.
.. code:: shell
make help
--------------
--------------
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment