Docs: Fix spelling errors and rendering
* Fix spelling errors in the ADI platform readme.rst
* Fix grammar error in coding_style.rst
* Fix rendering of .h / .c in coding_style.rst
Signed-off-by: Antonio de Angelis <antonio.deangelis@arm.com>
Change-Id: Idca929dbcbce74884924faed2012e3604f3b7229
diff --git a/docs/contributing/coding_guide.rst b/docs/contributing/coding_guide.rst
index 8886008..d678cdf 100644
--- a/docs/contributing/coding_guide.rst
+++ b/docs/contributing/coding_guide.rst
@@ -62,11 +62,11 @@
- Use enumeration for error codes to keep the code readable.
- Use descriptive variable and functions names.
- Put the correct license header at the beginning of the file.
-- Keep the files (.h/.c) self-contained, i.e. put include dependencies in the
+- Keep the files (``.h``/``.c``) self-contained, i.e. put include dependencies in the
file.
-- Put appropriate header define guard in .h files: ``__HEADER_NAME__``.
+- Put appropriate header define guard in ``.h`` files: ``__HEADER_NAME__``.
Any divergence from this rules should be clearly documented.
-- In a .c file, #include it's own header file first.
+- In a ``.c`` file, #include its own header file first.
- Document all the public functions in the header file only.
- Document all the private functions in the source file only.
- Add "extern C " definition for C++ support in the header files.
diff --git a/docs/platform/adi/max32657/README.rst b/docs/platform/adi/max32657/README.rst
index 93024ad..44b670f 100644
--- a/docs/platform/adi/max32657/README.rst
+++ b/docs/platform/adi/max32657/README.rst
@@ -69,7 +69,7 @@
After secure boot has been enabled BL2 image must be signed with user certificate
otherwise Secure Boot ROM will not validate BL2 image and will not execute it.
The sign process will be done automatically if BL1 be ON ``-DBL1=ON``
-The sign key can be sepecified over command line option -DTFM_BL2_SIGNING_KEY_PATH=<MY_KEY_FILE>
+The sign key can be specified over command line option -DTFM_BL2_SIGNING_KEY_PATH=<MY_KEY_FILE>
or by setting the flag in <TF-M base folder>/platform/ext/target/adi/max32657/config.cmake
Development purpose test certificate is here:
<CMAKE_BINARY_DIR>/lib/ext/tesa-toolkit-src/devices/max32657/keys/bl1_dummy.pem