docs: build the Hafnium Hypervisor documentation
The Hafnium Hypervisor documentation is kept as a legacy provided this
component is still used for test purposes within the Hafnium CI.
As the original files are .md files as opposed to .rst files for the
remaining of the project, adjust tags to permit building with sphinx.
Signed-off-by: Olivier Deprez <olivier.deprez@arm.com>
Change-Id: I5fc138cf7bc2de1276823c0739cbca6d136f26dd
diff --git a/docs/hypervisor/StyleGuide.md b/docs/hypervisor/StyleGuide.md
index 1619971..50215a1 100644
--- a/docs/hypervisor/StyleGuide.md
+++ b/docs/hypervisor/StyleGuide.md
@@ -15,8 +15,6 @@
tooling conflicts with what is in this document we accept what the tooling
requires, and try to improve it if possible.
-[TOC]
-
## Clarifications
* Yes, it does mean all variables are declared, C90-style, at the top of
@@ -66,11 +64,11 @@
## Coding practices
* Function macros should be functions instead, that way you get types.
-* Lock ordering is described at the top of [`api.c`](../src/api.c).
+* Lock ordering is described at the top of [`api.c`](../../src/api.c).
* Use opaque types to avoid implicit casts when it will help avoid mistakes.
- e.g. [`addr.h`](../inc/hf/addr.h)
+ e.g. [`addr.h`](../../inc/hf/addr.h)
* Avoid inline casting. C doesn't give much protection so be formal about the
- transformations. e.g. [`addr.h`](../inc/hf/addr.h)
+ transformations. e.g. [`addr.h`](../../inc/hf/addr.h)
* If a function acquires a resource, there must be a single exit path to free
the resource. Tracking down multiple exit points is hard and requires
duplicated code which is harder. This may require splitting functions into
@@ -119,7 +117,7 @@
printf-style format strings and arguments.
The log level of a build is controlled by the `log_level` argument defined in
-[`BUILDCONFIG.gn`](../build/BUILDCONFIG.gn). This defaults to `INFO` for debug
+[`BUILDCONFIG.gn`](../../build/BUILDCONFIG.gn). This defaults to `INFO` for debug
builds and tests, meaning that all levels except `VERBOSE` will be logged. It is
recommended to set the log level to `NOTICE` for production builds, to reduce
binary size and log spam.