summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBin Meng <bmeng.cn@gmail.com>2021-07-08 14:07:29 +0300
committerAnup Patel <anup@brainfault.org>2021-07-11 09:28:31 +0300
commitabfce9b25c7ec12a214bf3e9f85b5a3c8fb91b67 (patch)
tree51f47ac361346ce31cbabdcffec495694dcce406
parentdafaa0f54b8a2781f97150ecff5e087f208e788c (diff)
downloadopensbi-abfce9b25c7ec12a214bf3e9f85b5a3c8fb91b67.tar.xz
docs: Make <xyz> visible in the rendered platform guide
At present in the rendered platform guide, all instances of <xyz> are missing. Use &lt; and &gt; to replace <> to make them visible. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Xiang W <wxjstz@126.com> Reviewed-by: Anup Patel <anup.patel@wdc.com>
-rw-r--r--docs/platform_guide.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/platform_guide.md b/docs/platform_guide.md
index df90c6b..b6c2c2e 100644
--- a/docs/platform_guide.md
+++ b/docs/platform_guide.md
@@ -25,18 +25,18 @@ APIs is available in the file *include/sbi/sbi_platform.h*.
Adding support for a new platform
---------------------------------
-Support for a new platform named *<xyz>* can be added as follows:
+Support for a new platform named *&lt;xyz&gt;* can be added as follows:
-1. Create a directory named *<xyz>* under the *platform/* directory.
+1. Create a directory named *&lt;xyz&gt;* under the *platform/* directory.
2. Create a platform configuration file named *config.mk* under the
- *platform/<xyz>/* directory. This configuration file will provide
+ *platform/&lt;xyz&gt;/* directory. This configuration file will provide
compiler flags, and select firmware options.
-3. Create a *platform/<xyz>/objects.mk* file for listing the
+3. Create a *platform/&lt;xyz&gt;/objects.mk* file for listing the
platform-specific object files to be compiled.
-4. Create a *platform/<xyz>/platform.c* file providing a *struct sbi_platform*
- instance.
+4. Create a *platform/&lt;xyz&gt;/platform.c* file providing a
+ *struct sbi_platform* instance.
A platform support code template is available under the *platform/template*
directory. Copying this directory and its content as a new directory named
-*<xyz>* under the *platform/* directory will create all the files mentioned
-above.
+*&lt;xyz&gt;* under the *platform/* directory will create all the files
+mentioned above.