Virtualization
/
opensbi
mirror of https://gitlab.com/qemu-project/opensbi.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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>
This commit is contained in:
Bin Meng 2021-07-08 19:07:29 +08:00 committed by Anup Patel
parent dafaa0f54b
commit abfce9b25c
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/platform_guide.md
View File

@ -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.