diff options
| author | Paul Beesley <paul.beesley@arm.com> | 2019-03-13 16:20:44 +0000 |
|---|---|---|
| committer | Paul Beesley <paul.beesley@arm.com> | 2019-05-22 11:28:17 +0100 |
| commit | e1c5026ac7e9da1b74047bf8cb9be2a5c9564532 (patch) | |
| tree | 3bb1ef189bb925077dc61581521cf4f3ffa979dc /docs/process | |
| parent | f94102ba965709aa6110e60b03a6d9f89923e3d2 (diff) | |
doc: Use proper note and warning annotations
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>
Diffstat (limited to 'docs/process')
| -rw-r--r-- | docs/process/coding-guidelines.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/process/coding-guidelines.rst b/docs/process/coding-guidelines.rst index 930f76c8..d524d733 100644 --- a/docs/process/coding-guidelines.rst +++ b/docs/process/coding-guidelines.rst @@ -7,8 +7,9 @@ and provide feedback. Some of the guidelines may also apply to other codebases. -**Note:** the existing TF codebase does not necessarily comply with all the -below guidelines but the intent is for it to do so eventually. +.. note:: + The existing TF codebase does not necessarily comply with all the + below guidelines but the intent is for it to do so eventually. Checkpatch overrides -------------------- |