Docs: Fix environment setup instructions
The example in the documentation for setting the PLANTUML_JAR_PATH
environment variable is wrong and makes cmake unable to find the tool.
As a fix, the quotation is removed.
The problem is the example has the value to be set quoted while the
path is ~ relative. As a result, the shell will not resolve
the ~ character to the home path, and the environment variable
will contain the path in the verbatim ~ relative form.
When the build-system uses the value, it gets passed to the
kernel as is, but the kernel can not resolve ~ as ~ referring
to the home directory is a shell feature.
Signed-off-by: Vikas Katariya <Vikas.Katariya@arm.com>
Change-Id: I6d4807b5855c4bb74fe9c58f99e996dea202c4e2
diff --git a/docs/user_guides/tfm_sw_requirement.rst b/docs/user_guides/tfm_sw_requirement.rst
index 4ba3a19..26d359e 100644
--- a/docs/user_guides/tfm_sw_requirement.rst
+++ b/docs/user_guides/tfm_sw_requirement.rst
@@ -228,9 +228,9 @@
.. code-block:: bash
export PATH=<DS-5_PATH>/sw/ARMCompiler6.10/bin:$PATH
- export ARM_TOOL_VARIANT="ult"
- export ARM_PRODUCT_PATH="<DS-5_PATH>/sw/mappings"
- export ARMLMD_LICENSE_FILE="<LICENSE_FILE_PATH>"
+ export ARM_TOOL_VARIANT=ult
+ export ARM_PRODUCT_PATH=<DS-5_PATH>/sw/mappings
+ export ARMLMD_LICENSE_FILE=<LICENSE_FILE_PATH>
To import CMake in your bash shell console:
@@ -285,10 +285,10 @@
.. code-block:: bash
- export PATH="/cygdrive/c/<DS-5_PATH>/sw/ARMCompiler6.10/bin":$PATH
- export ARM_PRODUCT_PATH="C:/<DS-5_PATH>/sw/mappings"
- export ARM_TOOL_VARIANT="ult"
- export ARMLMD_LICENSE_FILE="<LICENSE_FILE_PATH>"
+ export PATH=/cygdrive/c/<DS-5_PATH>/sw/ARMCompiler6.10/bin:$PATH
+ export ARM_PRODUCT_PATH=C:/<DS-5_PATH>/sw/mappings
+ export ARM_TOOL_VARIANT=ult
+ export ARMLMD_LICENSE_FILE=<LICENSE_FILE_PATH>
Armclang + Keil MDK Arm
^^^^^^^^^^^^^^^^^^^^^^^
@@ -301,7 +301,7 @@
.. code-block:: bash
- export PATH="/cygdrive/c/<uVision path>/ARM/ARMCLANG/bin":$PATH
+ export PATH=/cygdrive/c/<uVision path>/ARM/ARMCLANG/bin:$PATH
GNU Arm
^^^^^^^
@@ -397,7 +397,7 @@
::
- export PLANTUML_JAR_PATH="~/plantuml/plantuml.jar"
+ export PLANTUML_JAR_PATH=~/plantuml/plantuml.jar
Windows + Cygwin
""""""""""""""""
@@ -410,7 +410,7 @@
::
- export PLANTUML_JAR_PATH="c:/plantuml/plantuml.jar"
+ export PLANTUML_JAR_PATH=c:/plantuml/plantuml.jar
export PATH=$PATH:/cygdrive/c/<DS-5 path>/sw/java/bin
To compile the TF-M User Guide
@@ -483,7 +483,7 @@
"""""
.. code-block:: bash
- export PLANTUML_JAR_PATH="~/plantuml/plantuml.jar"
+ export PLANTUML_JAR_PATH=~/plantuml/plantuml.jar
Windows + Cygwin
""""""""""""""""
@@ -496,7 +496,7 @@
.. code-block:: bash
- export PLANTUML_JAR_PATH="c:/plantuml/plantuml.jar"
+ export PLANTUML_JAR_PATH=c:/plantuml/plantuml.jar
export PATH=$PATH:/cygdrive/c/<DS-5 path>/sw/java/bin
--------------