| #
71061819 |
| 16-Nov-2022 |
Manish V Badarkhe <manish.badarkhe@arm.com> |
Merge changes If90a18ee,I02e88f8c,Iea447fb5,Ie0570481,Ieeb14cfc into integration
* changes: docs: add top level section numbering docs(build): clarify getting started section docs(build): clar
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
show more ...
|
| #
b50838ba |
| 27-Oct-2022 |
Boyan Karatotev <boyan.karatotev@arm.com> |
docs(build): clarify getting started section
The Getting started section is very difficult to follow. Building the fip comes before building the files it needs, the BL33 requirement is given in a so
docs(build): clarify getting started section
The Getting started section is very difficult to follow. Building the fip comes before building the files it needs, the BL33 requirement is given in a somewhat hand wavy way, and the Arm Developer website download provides a lot of targets and the guide is not clear which ones are needed on download.
Swapping the initial build and supporting tools sections makes the flow more natural and the supporting tools section then becomes clear. Explicitly mentioning the GCC targets avoids confusion for people less familiar with the project (eg. new starters).
Signed-off-by: Boyan Karatotev <boyan.karatotev@arm.com> Change-Id: I02e88f8c279db6d8eda68f634e8473c02b733963
show more ...
|
| #
55b2e6f0 |
| 16-Nov-2021 |
Manish Pandey <manish.pandey2@arm.com> |
Merge changes I9e6feeee,If1cd7962 into integration
* changes: docs(rme): add description of TF-A changes for RME docs(gpt): add documentation page for GPT library
|
| #
7446c266 |
| 21-Oct-2021 |
Zelalem Aweke <zelalem.aweke@arm.com> |
docs(rme): add description of TF-A changes for RME
This patch expands the RME documentation with description of TF-A changes for RME. It also modifies some other parts of TF-A documentation to accou
docs(rme): add description of TF-A changes for RME
This patch expands the RME documentation with description of TF-A changes for RME. It also modifies some other parts of TF-A documentation to account for RME changes.
Signed-off-by: Zelalem Aweke <zelalem.aweke@arm.com> Change-Id: I9e6feeee235f0ba4b767d239f15840f1e0c540bb
show more ...
|
| #
7921fe6a |
| 11-Oct-2019 |
Paul Beesley <paul.beesley@arm.com> |
Merge "doc: Misc syntax and spelling fixes" into integration
|
| #
be653a69 |
| 04-Oct-2019 |
Paul Beesley <paul.beesley@arm.com> |
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 spelli
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>
show more ...
|
| #
ced17112 |
| 23-May-2019 |
Sandrine Bailleux <sandrine.bailleux@arm.com> |
Merge changes from topic "pb/sphinx-doc" into integration
* changes: doc: Use proper note and warning annotations doc: Refactor contributor acknowledgements doc: Reorganise images and update l
Merge changes from topic "pb/sphinx-doc" into integration
* changes: doc: Use proper note and warning annotations doc: Refactor contributor acknowledgements doc: Reorganise images and update links doc: Set correct syntax highlighting style doc: Add minimal glossary doc: Remove per-page contents lists doc: Make checkpatch ignore rst files doc: Format security advisory titles and headings doc: Reformat platform port documents doc: Normalise section numbering and headings doc: Reword document titles
show more ...
|
| #
57354abb |
| 07-Mar-2019 |
Paul Beesley <paul.beesley@arm.com> |
doc: Remove per-page contents lists
These are no longer needed as there will always be a table of contents rendered to the left of every page.
Some of these lists can be quite long and, when openin
doc: Remove per-page contents lists
These are no longer needed as there will always be a table of contents rendered to the left of every page.
Some of these lists can be quite long and, when opening a page, the reader sees nothing but a huge list of contents! After this patch, the document contents are front-and-centre and the contents are nicely rendered in the sidebar without duplication.
Change-Id: I444754d548ec91d00f2b04e861de8dde8856aa62 Signed-off-by: Paul Beesley <paul.beesley@arm.com>
show more ...
|
| #
83993177 |
| 07-Mar-2019 |
Paul Beesley <paul.beesley@arm.com> |
doc: Normalise section numbering and headings
Required work to make all documents sit at the correct levels within the document tree and any derived content like the table of contents and the catego
doc: Normalise section numbering and headings
Required work to make all documents sit at the correct levels within the document tree and any derived content like the table of contents and the categories in the sidebar.
Change-Id: I4885fbe30864a87c8822ee67482b71fb46a8fbc6 Signed-off-by: Paul Beesley <paul.beesley@arm.com>
show more ...
|
| #
6d95ccda |
| 21-May-2019 |
Sandrine Bailleux <sandrine.bailleux@arm.com> |
Merge "doc: Move documents into subdirectories" into integration
|
| #
40d553cf |
| 11-Feb-2019 |
Paul Beesley <paul.beesley@arm.com> |
doc: Move documents into subdirectories
This change creates the following directories under docs/ in order to provide a grouping for the content:
- components - design - getting_started - perf - pr
doc: Move documents into subdirectories
This change creates the following directories under docs/ in order to provide a grouping for the content:
- components - design - getting_started - perf - process
In each of these directories an index.rst file is created and this serves as an index / landing page for each of the groups when the pages are compiled. Proper layout of the top-level table of contents relies on this directory/index structure.
Without this patch it is possible to build the documents correctly with Sphinx but the output looks messy because there is no overall hierarchy.
Change-Id: I3c9f4443ec98571a56a6edf775f2c8d74d7f429f Signed-off-by: Paul Beesley <paul.beesley@arm.com>
show more ...
|