bcm63xx/atf/docs/process/coding-guidelines.rst, branch masterBroadcom-s Trusted Firmware Ahttps://git-03.infra.openwrt.org/project/bcm63xx/atf/atom?h=master2019-10-11T12:39:06Zdoc: Misc syntax and spelling fixes2019-10-11T12:39:06ZPaul Beesley2019-10-04T16:17:46Zurn:sha1:be653a6940b6c7bf3c0c6b7049ae829fa70863c1
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>
Fix RST rendering problem2019-07-09T17:09:03ZJohn Tsichritzis2019-07-09T17:09:03Zurn:sha1:9f0a0bbd1c1544a5a1849ba871f1a50b16ef4f79
Change-Id: Ic5aab23b549d0bf8e0f7053b46fd59243214aac1
Signed-off-by: John Tsichritzis <john.tsichritzis@arm.com>
docs: Add the list of banned/use with caution APIs2019-07-01T13:16:26ZSoby Mathew2019-06-20T11:46:11Zurn:sha1:140c8311f7cdf954d12cc18c183a37a717916a4d
Credit to sam.ellis@arm.com for the input to create the list.
Change-Id: Id70a8eddc5f2490811bebb278482c61950f10cce
Signed-off-by: Soby Mathew <soby.mathew@arm.com>
doc: Use proper note and warning annotations2019-05-22T10:28:17ZPaul Beesley2019-03-13T16:20:44Zurn:sha1:e1c5026ac7e9da1b74047bf8cb9be2a5c9564532
The documentation contains plenty of notes and warnings. Enable
special rendering of these blocks by converting the note prefix
into a .. note:: annotation.
Change-Id: I34e26ca6bf313d335672ab6c2645741900338822
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
doc: Set correct syntax highlighting style2019-05-22T10:28:17ZPaul Beesley2019-03-13T15:11:04Zurn:sha1:29c02529592fb2489edee6c92e418918e5732105
Several code blocks do not specify a language for syntax
highlighting. This results in Sphinx using a default highlighter
which is Python.
This patch adds the correct language to each code block that doesn't
already specify it.
Change-Id: Icce1949aabfdc11a334a42d49edf55fa673cddc3
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
doc: Remove per-page contents lists2019-05-22T10:23:06ZPaul Beesley2019-03-07T17:03:22Zurn:sha1:57354abb2032b4598ce513d5d1ca788fe3bcf356
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>
doc: Reword document titles2019-05-22T10:20:39ZPaul Beesley2019-03-07T15:47:15Zurn:sha1:8aa050554b996406231a66a048b56fa03ba220c8
This patch attempts to standardise the document titles as well as
adding titles to documents that were missing one. The aim is to
remove needless references to "TF-A" or "Trusted Firmware" in the
title of every document and to make sure that the title matches
with the document content.
Change-Id: I9b93ccf43b5d57e8dc793a5311b8ed7c4dd245cc
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
doc: Move documents into subdirectories2019-05-21T14:05:56ZPaul Beesley2019-02-11T17:54:45Zurn:sha1:40d553cfde38d4f68449c62967cd1ce0d6478750
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>