doc: Update page content after re-arrangement
This patch modifies the content of existing documents now that
it has been moved around. Some of the content requires updating
to make sense in its new location, for example. Other content may
simply be out of date.
Change-Id: I8dfa527e1d1f1520cefd21066802451352b573d2
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
Signed-off-by: Jimmy Brisson <jimmy.brisson@arm.com>
diff --git a/docs/implementing-tests.rst b/docs/implementing-tests.rst
index 3810c14..decdc68 100644
--- a/docs/implementing-tests.rst
+++ b/docs/implementing-tests.rst
@@ -4,14 +4,14 @@
This document aims at providing some pointers to help implementing new tests in
the TFTF image.
-Structure of a test
--------------------
+Test Structure
+--------------
A test might be divided into 3 logical parts, detailed in the following
sections.
Prologue
-''''''''
+^^^^^^^^
A test has a main entry point function, whose type is:
@@ -31,7 +31,7 @@
help test code verify that their requirements are met.
Core
-''''
+^^^^
This is completely dependent on the purpose of the test. The paragraphs below
just provide some useful, general information.
@@ -54,7 +54,7 @@
all involved CPUs reported a success status code.
Epilogue
-''''''''
+^^^^^^^^
Each test is responsible for releasing any allocated resources and putting the
system back in a clean state when it finishes. Any change to the system
@@ -66,15 +66,15 @@
powered down. As already stated above, as soon as a CPU enters the test, the
framework expects it to return from the test.
-Template test code
+Template Test Code
------------------
Some template test code is provided in `tftf/tests/template_tests`_. It can be
used as a starting point for developing new tests. Template code for both
single-core and multi-core tests is provided.
-Plugging the test into the build system
----------------------------------------
+Build System Integration
+------------------------
All test code is located under the `tftf/tests`_ directory. Tests are usually
divided into categories represented as sub-directories under ``tftf/tests/``.