aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordanh-arm <dan.handley@arm.com>2015-03-17 14:22:15 +0000
committerdanh-arm <dan.handley@arm.com>2015-03-17 14:22:15 +0000
commit09c731ebd62348f7acd9ab94be033f0ae176a87f (patch)
tree6d0de53dab04b8a91a3c210ea0a22ddb3f5a85c5
parent007f54b6db70fa3d0a13bf2134cc1c51875af774 (diff)
parent4da85bb06ec369be101f3c92310bae42ff4ee5cb (diff)
Merge pull request #267 from sandrine-bailleux/sb/doc-fixes
Documentation fixes in 'make help' message and User Guide
-rw-r--r--Makefile15
-rw-r--r--docs/user-guide.md3
2 files changed, 14 insertions, 4 deletions
diff --git a/Makefile b/Makefile
index 6563d3c..78fed57 100644
--- a/Makefile
+++ b/Makefile
@@ -627,16 +627,23 @@ cscope:
${Q}cscope -b -q -k
help:
- @echo "usage: ${MAKE} PLAT=<${HELP_PLATFORMS}> <all|bl1|bl2|bl31|distclean|clean|checkcodebase|checkpatch>"
+ @echo "usage: ${MAKE} PLAT=<${HELP_PLATFORMS}> [OPTIONS] [TARGET]"
@echo ""
@echo "PLAT is used to specify which platform you wish to build."
@echo "If no platform is specified, PLAT defaults to: ${DEFAULT_PLAT}"
@echo ""
+ @echo "Please refer to the User Guide for a list of all supported options."
+ @echo "Note that the build system doesn't track dependencies for build "
+ @echo "options. Therefore, if any of the build options are changed "
+ @echo "from a previous build, a clean build must be performed."
+ @echo ""
@echo "Supported Targets:"
- @echo " all Build the BL1, BL2 and BL31 binaries"
+ @echo " all Build all individual bootloader binaries"
@echo " bl1 Build the BL1 binary"
@echo " bl2 Build the BL2 binary"
- @echo " bl31 Build the BL31 binary"
+ @echo " bl31 Build the BL3-1 binary"
+ @echo " bl32 Build the BL3-2 binary"
+ @echo " fip Build the Firmware Image Package (FIP)"
@echo " checkcodebase Check the coding style of the entire source tree"
@echo " checkpatch Check the coding style on changes in the current"
@echo " branch against BASE_COMMIT (default origin/master)"
@@ -646,7 +653,7 @@ help:
@echo " certtool Build the Certificate generation tool"
@echo " fiptool Build the Firmware Image Package(FIP) creation tool"
@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 "example: build all targets for the FVP platform:"
@echo " CROSS_COMPILE=aarch64-none-elf- make PLAT=fvp all"
diff --git a/docs/user-guide.md b/docs/user-guide.md
index 1badc0c..b1e123c 100644
--- a/docs/user-guide.md
+++ b/docs/user-guide.md
@@ -59,6 +59,9 @@ The following tools are required to use the ARM Trusted Firmware:
wget http://releases.linaro.org/14.07/components/toolchain/binaries/gcc-linaro-aarch64-none-elf-4.9-2014.07_linux.tar.xz
tar -xf gcc-linaro-aarch64-none-elf-4.9-2014.07_linux.tar.xz
+* `libssl-dev` package to build the certificate generation tool when support
+ for Trusted Board Boot is needed.
+
* (Optional) For debugging, ARM [Development Studio 5 (DS-5)][DS-5] v5.20.