diff options
author | Paul Beesley <paul.beesley@arm.com> | 2019-10-04 16:17:46 +0000 |
---|---|---|
committer | Paul Beesley <paul.beesley@arm.com> | 2019-10-11 12:39:06 +0000 |
commit | be653a6940b6c7bf3c0c6b7049ae829fa70863c1 (patch) | |
tree | e0f14828750f595ee14a7ad836b8a56deea252f4 /docs/getting_started | |
parent | 6f0c77f0c7c224b0e4be2aaf3cfedcbdcba9a144 (diff) |
doc: Misc syntax and spelling fixes
Tidying up a few Sphinx warnings that had built-up over time.
None of these are critical but it cleans up the Sphinx output.
At the same time, fixing some spelling errors that were detected.
Change-Id: I38209e235481eed287f8008c6de9dedd6b12ab2e
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
Diffstat (limited to 'docs/getting_started')
-rw-r--r-- | docs/getting_started/image-terminology.rst | 8 | ||||
-rw-r--r-- | docs/getting_started/porting-guide.rst | 6 |
2 files changed, 7 insertions, 7 deletions
diff --git a/docs/getting_started/image-terminology.rst b/docs/getting_started/image-terminology.rst index d9e08f76..5993d6e7 100644 --- a/docs/getting_started/image-terminology.rst +++ b/docs/getting_started/image-terminology.rst @@ -7,7 +7,7 @@ images referred to in the Trusted Firmware project. General Notes ------------- -- Some of the names and abbreviated names have changed to accomodate new +- Some of the names and abbreviated names have changed to accommodate new requirements. The changed names are as backward compatible as possible to minimize confusion. Where applicable, the previous names are indicated. Some code, documentation and build artefacts may still refer to the previous names; @@ -44,7 +44,7 @@ AP Boot ROM: ``AP_BL1`` ~~~~~~~~~~~~~~~~~~~~~~~ Typically, this is the first code to execute on the AP and cannot be modified. -Its primary purpose is to perform the minimum intialization necessary to load +Its primary purpose is to perform the minimum initialization necessary to load and authenticate an updateable AP firmware image into an executable RAM location, then hand-off control to that image. @@ -96,7 +96,7 @@ SCP Boot ROM: ``SCP_BL1`` (previously ``BL0``) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Typically, this is the first code to execute on the SCP and cannot be modified. -Its primary purpose is to perform the minimum intialization necessary to load +Its primary purpose is to perform the minimum initialization necessary to load and authenticate an updateable SCP firmware image into an executable RAM location, then hand-off control to that image. This may be performed in conjunction with other processor firmware (for example, ``AP_BL1`` and @@ -129,7 +129,7 @@ AP Firmware Update Boot ROM: ``AP_NS_BL1U`` Typically, this is the first normal world code to execute on the AP during a firmware update operation, and cannot be modified. Its primary purpose is to -load subequent firmware update images from an external interface and communicate +load subsequent firmware update images from an external interface and communicate with ``AP_BL1`` to authenticate those images. During firmware update, there are (potentially) multiple transitions between the diff --git a/docs/getting_started/porting-guide.rst b/docs/getting_started/porting-guide.rst index d7157690..9cca75e9 100644 --- a/docs/getting_started/porting-guide.rst +++ b/docs/getting_started/porting-guide.rst @@ -549,7 +549,7 @@ optionally be defined: - **PLAT_PARTITION_BLOCK_SIZE** The size of partition block. It could be either 512 bytes or 4096 bytes. The default value is 512. - `For example, define the build flag in platform.mk`_: + For example, define the build flag in ``platform.mk``: PLAT_PARTITION_BLOCK_SIZE := 4096 $(eval $(call add_define,PLAT_PARTITION_BLOCK_SIZE)) @@ -954,7 +954,7 @@ Function : plat_reset_handler() Return : void A platform may need to do additional initialization after reset. This function -allows the platform to do the platform specific intializations. Platform +allows the platform to do the platform specific initializations. Platform specific errata workarounds could also be implemented here. The API should preserve the values of callee saved registers x19 to x29. @@ -2777,7 +2777,7 @@ more functionality is required, the needed library functions will need to be added to the local implementation. Some C headers have been obtained from `FreeBSD`_ and `SCC`_, while others have -been written specifically for TF-A. Fome implementation files have been obtained +been written specifically for TF-A. Some implementation files have been obtained from `FreeBSD`_, others have been written specifically for TF-A as well. The files can be found in ``include/lib/libc`` and ``lib/libc``. |