[PATCH 2/2] docs: Make <xyz> visible in the rendered platform guide
Bin Meng
bmeng.cn at gmail.com
Thu Jul 8 04:07:29 PDT 2021
At present in the rendered platform guide, all instances of <xyz>
are missing. Use < and > to replace <> to make them visible.
Signed-off-by: Bin Meng <bmeng.cn at gmail.com>
---
docs/platform_guide.md | 16 ++++++++--------
1 file 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 *<xyz>* can be added as follows:
-1. Create a directory named *<xyz>* under the *platform/* directory.
+1. Create a directory named *<xyz>* under the *platform/* directory.
2. Create a platform configuration file named *config.mk* under the
- *platform/<xyz>/* directory. This configuration file will provide
+ *platform/<xyz>/* 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/<xyz>/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/<xyz>/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.
+*<xyz>* under the *platform/* directory will create all the files
+mentioned above.
--
2.25.1
More information about the opensbi
mailing list