diff options
author | Manish V Badarkhe <manish.badarkhe@arm.com> | 2022-11-16 16:18:54 +0100 |
---|---|---|
committer | TrustedFirmware Code Review <review@review.trustedfirmware.org> | 2022-11-16 16:18:54 +0100 |
commit | 71061819aaf1b69c8600e1b7d9c9388b8f51b680 (patch) | |
tree | 5d93acb0511c408c77351fe366424f06899e97fe /docs | |
parent | 54c52bcb7694b8503b29bda312d2b4a10ef1bf14 (diff) | |
parent | c65bf2d134dc1a278a3582df738c31b3acdb2d10 (diff) | |
download | arm-trusted-firmware-71061819aaf1b69c8600e1b7d9c9388b8f51b680.tar.gz |
Merge changes If90a18ee,I02e88f8c,Iea447fb5,Ie0570481,Ieeb14cfc into integration
* changes:
docs: add top level section numbering
docs(build): clarify getting started section
docs(build): clarify docs building instructions
fix(docs): prevent a sphinx warning
fix(docs): prevent a virtual environment from failing a build
Diffstat (limited to 'docs')
-rw-r--r-- | docs/about/index.rst | 1 | ||||
-rw-r--r-- | docs/components/index.rst | 1 | ||||
-rw-r--r-- | docs/conf.py | 5 | ||||
-rw-r--r-- | docs/design/index.rst | 1 | ||||
-rw-r--r-- | docs/design_documents/index.rst | 1 | ||||
-rw-r--r-- | docs/getting_started/docs-build.rst | 31 | ||||
-rw-r--r-- | docs/getting_started/image-terminology.rst | 13 | ||||
-rw-r--r-- | docs/getting_started/index.rst | 3 | ||||
-rw-r--r-- | docs/getting_started/initial-build.rst | 2 | ||||
-rw-r--r-- | docs/getting_started/prerequisites.rst | 4 | ||||
-rw-r--r-- | docs/getting_started/tools-build.rst | 14 | ||||
-rw-r--r-- | docs/index.rst | 2 | ||||
-rw-r--r-- | docs/perf/index.rst | 1 | ||||
-rw-r--r-- | docs/plat/index.rst | 1 | ||||
-rw-r--r-- | docs/process/index.rst | 1 | ||||
-rw-r--r-- | docs/security_advisories/index.rst | 1 | ||||
-rw-r--r-- | docs/threat_model/index.rst | 1 |
17 files changed, 43 insertions, 40 deletions
diff --git a/docs/about/index.rst b/docs/about/index.rst index 3a102668c..06973ef16 100644 --- a/docs/about/index.rst +++ b/docs/about/index.rst @@ -4,7 +4,6 @@ About .. toctree:: :maxdepth: 1 :caption: Contents - :numbered: features release-information diff --git a/docs/components/index.rst b/docs/components/index.rst index 0972a68e0..30d80fcdd 100644 --- a/docs/components/index.rst +++ b/docs/components/index.rst @@ -4,7 +4,6 @@ Components .. toctree:: :maxdepth: 1 :caption: Contents - :numbered: spd/index activity-monitors diff --git a/docs/conf.py b/docs/conf.py index ef77f6bfe..371632a56 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -36,12 +36,13 @@ master_doc = 'index' # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path . -exclude_patterns = [] +# Don't try to build the venv in case it's placed with the sources +exclude_patterns = [".env", "env", ".venv", "venv"] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' diff --git a/docs/design/index.rst b/docs/design/index.rst index e3b8f7429..17ef75611 100644 --- a/docs/design/index.rst +++ b/docs/design/index.rst @@ -4,7 +4,6 @@ System Design .. toctree:: :maxdepth: 1 :caption: Contents - :numbered: alt-boot-flows auth-framework diff --git a/docs/design_documents/index.rst b/docs/design_documents/index.rst index 765efe6c3..3e20c07ca 100644 --- a/docs/design_documents/index.rst +++ b/docs/design_documents/index.rst @@ -4,7 +4,6 @@ Design Documents .. toctree:: :maxdepth: 1 :caption: Contents - :numbered: cmake_framework context_mgmt_rework diff --git a/docs/getting_started/docs-build.rst b/docs/getting_started/docs-build.rst index 1762558a5..4a480590b 100644 --- a/docs/getting_started/docs-build.rst +++ b/docs/getting_started/docs-build.rst @@ -17,19 +17,25 @@ check that you have the required software packages, as described in the Prerequisites ------------- -For building a local copy of the |TF-A| documentation you will need, at minimum: +For building a local copy of the |TF-A| documentation you will need: - Python 3 (3.5 or later) - PlantUML (1.2017.15 or later) +- Python modules specified in ``docs/requirements.txt`` -Optionally, the `Dia`_ application can be installed if you need to edit -existing ``.dia`` diagram files, or create new ones. + You can install these with ``pip3`` (the Python Package Installer) by + passing it the requirements file above (with ``-r``). An optional ``--user`` + argument will install them locally, but you have to add their location to + $PATH (pip will emit a warning). Alternatively, they can be installed + globally (but will probably require root privileges). -You must also install the Python modules that are specified in the -``requirements.txt`` file in the root of the ``docs`` directory. These modules -can be installed using ``pip3`` (the Python Package Installer). Passing this -requirements file as an argument to ``pip3`` automatically installs the specific -module versions required by |TF-A|. + .. note:: + Although not necessary, it is recommended you use a virtual environment. + More advanced usage instructions for *pip* are beyond the scope of this + document but you can refer to the `pip homepage`_ for detailed guides. + +- Optionally, the `Dia`_ application can be installed if you need to edit + existing ``.dia`` diagram files, or create new ones. An example set of installation commands for Ubuntu follows, assuming that the working directory is ``docs``: @@ -44,15 +50,6 @@ working directory is ``docs``: the list to ensure that there will be no conflicts with other modules already installed in your environment. -Passing the optional ``--user`` argument to ``pip3`` will install the Python -packages only for the current user. Omitting this argument will attempt to -install the packages globally and this will likely require the command to be run -as root or using ``sudo``. - -.. note:: - More advanced usage instructions for *pip* are beyond the scope of this - document but you can refer to the `pip homepage`_ for detailed guides. - Building rendered documentation ------------------------------- diff --git a/docs/getting_started/image-terminology.rst b/docs/getting_started/image-terminology.rst index a90ec0b3f..66f47e8ac 100644 --- a/docs/getting_started/image-terminology.rst +++ b/docs/getting_started/image-terminology.rst @@ -4,8 +4,8 @@ Image Terminology This page contains the current name, abbreviated name and purpose of the various images referred to in the Trusted Firmware project. -General Notes -------------- +Common Image Features +--------------------- - Some of the names and abbreviated names have changed to accommodate new requirements. The changed names are as backward compatible as possible to @@ -40,6 +40,15 @@ General Notes Trusted Firmware Images ----------------------- +Firmware Image Package: ``FIP`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This is a packaging format used by TF-A to package firmware images in a single +binary. The number and type of images that should be packed in a FIP is +platform-specific and may include TF-A images and other firmware images +required by the platform. For example, most platforms require a BL33 image +which corresponds to the normal world bootloader (e.g. UEFI or U-Boot). + AP Boot ROM: ``AP_BL1`` ~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/getting_started/index.rst b/docs/getting_started/index.rst index 817beaf8e..3fbf48dca 100644 --- a/docs/getting_started/index.rst +++ b/docs/getting_started/index.rst @@ -4,12 +4,11 @@ Getting Started .. toctree:: :maxdepth: 1 :caption: Contents - :numbered: prerequisites docs-build - tools-build initial-build + tools-build build-options image-terminology porting-guide diff --git a/docs/getting_started/initial-build.rst b/docs/getting_started/initial-build.rst index 62f1941b1..4f41be413 100644 --- a/docs/getting_started/initial-build.rst +++ b/docs/getting_started/initial-build.rst @@ -2,7 +2,7 @@ Performing an Initial Build =========================== - Before building TF-A, the environment variable ``CROSS_COMPILE`` must point - to the Linaro cross compiler. + to your cross compiler. For AArch64: diff --git a/docs/getting_started/prerequisites.rst b/docs/getting_started/prerequisites.rst index d8d3b7aeb..37232942b 100644 --- a/docs/getting_started/prerequisites.rst +++ b/docs/getting_started/prerequisites.rst @@ -27,6 +27,10 @@ Toolchain target the Armv7-A or Armv8-A architectures: - GCC >= 11.3.Rel1 (from the `Arm Developer website`_) + + You will need the targets ``arm-none-eabi`` and ``aarch64-none-elf`` for + AArch32 and AArch64 builds respectively. + - Clang >= 14.0.0 - Arm Compiler >= 6.18 diff --git a/docs/getting_started/tools-build.rst b/docs/getting_started/tools-build.rst index daf7e06a9..166b527d4 100644 --- a/docs/getting_started/tools-build.rst +++ b/docs/getting_started/tools-build.rst @@ -14,12 +14,11 @@ Building Supporting Tools Building and using the FIP tool ------------------------------- -Firmware Image Package (FIP) is a packaging format used by TF-A to package -firmware images in a single binary. The number and type of images that should -be packed in a FIP is platform specific and may include TF-A images and other -firmware images required by the platform. For example, most platforms require -a BL33 image which corresponds to the normal world bootloader (e.g. UEFI or -U-Boot). +The following snippets build a :ref:`FIP<Image Terminology>` for the FVP +platform. While it is not an intrinsic part of the FIP format, a BL33 image is +required for these examples. For the purposes of experimentation, `Trusted +Firmware-A Tests`_ (`tftf.bin``) may be used. Refer to to the `TFTF +documentation`_ for instructions on building a TFTF binary. The TF-A build system provides the make target ``fip`` to create a FIP file for the specified platform using the FIP creation tool included in the TF-A @@ -175,3 +174,6 @@ via using ``cat <filename>`` instead of a hex string. -------------- *Copyright (c) 2019-2022, Arm Limited. All rights reserved.* + +.. _Trusted Firmware-A Tests: https://git.trustedfirmware.org/TF-A/tf-a-tests.git/ +.. _TFTF documentation: https://trustedfirmware-a-tests.readthedocs.io/en/latest/ diff --git a/docs/index.rst b/docs/index.rst index edc2535a4..386019943 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,7 +3,7 @@ Trusted Firmware-A Documentation .. toctree:: :maxdepth: 1 - :hidden: + :numbered: Home<self> about/index diff --git a/docs/perf/index.rst b/docs/perf/index.rst index 1482b80f6..bccad006c 100644 --- a/docs/perf/index.rst +++ b/docs/perf/index.rst @@ -4,7 +4,6 @@ Performance & Testing .. toctree:: :maxdepth: 1 :caption: Contents - :numbered: psci-performance-juno tsp diff --git a/docs/plat/index.rst b/docs/plat/index.rst index 3eac6f7a5..a4e206780 100644 --- a/docs/plat/index.rst +++ b/docs/plat/index.rst @@ -4,7 +4,6 @@ Platform Ports .. toctree:: :maxdepth: 1 :caption: Contents - :numbered: :hidden: allwinner diff --git a/docs/process/index.rst b/docs/process/index.rst index 422ab2869..7914a4e27 100644 --- a/docs/process/index.rst +++ b/docs/process/index.rst @@ -4,7 +4,6 @@ Processes & Policies .. toctree:: :maxdepth: 1 :caption: Contents - :numbered: security platform-ports-policy diff --git a/docs/security_advisories/index.rst b/docs/security_advisories/index.rst index 887b06a55..b80ba34d3 100644 --- a/docs/security_advisories/index.rst +++ b/docs/security_advisories/index.rst @@ -4,7 +4,6 @@ Security Advisories .. toctree:: :maxdepth: 1 :caption: Contents - :numbered: security-advisory-tfv-1.rst security-advisory-tfv-2.rst diff --git a/docs/threat_model/index.rst b/docs/threat_model/index.rst index 9d84f5b92..ad8b82ac0 100644 --- a/docs/threat_model/index.rst +++ b/docs/threat_model/index.rst @@ -11,7 +11,6 @@ based on the data flow diagram and potential threat mitigations. .. toctree:: :maxdepth: 1 :caption: Contents - :numbered: threat_model threat_model_spm |