Skip to contentSkip to conversation

docs: Correct a typo in platform_guide.md

PATCH New Bin Meng 3 participants 6 messages Jul 8, 2021 – Jul 11, 2021

lore
Share & tools
lore

Bin Meng

author
#0 lore raw

PATCH 1/2 docs: Correct a typo in platform_guide.md

It's riscv-pk, not riskv-pk.

---

 docs/platform_guide.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
docs/platform_guide.md +1 -1
index 7920fac..df90c6b 100644
@@ -17,7 +17,7 @@ the supported platforms. These firmwares are linked against *libplatsbi.a*.
 Firmware binaries are installed in
 *<install_directory>/platform/<platform_subdir>/bin*. These firmwares can be
 used as executable runtime firmwares on the supported platforms as a replacement
-for the legacy *riskv-pk* boot loader (BBL).
+for the legacy *riscv-pk* boot loader (BBL).
 
 A complete doxygen-style documentation of *struct sbi_platform* and related
 APIs is available in the file *include/sbi/sbi_platform.h*.
Signature · 1 line
2.25.1
author
#1 lore raw

PATCH 2/2 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.

---

 docs/platform_guide.md | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)
docs/platform_guide.md +8 -8
index df90c6b..b6c2c2e 100644
@@ -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.
Signature · 1 line
2.25.1
#2 lore raw

PATCH 2/2 docs: Make <xyz> visible in the rendered platform guide

? 2021-07-08???? 19:07 +0800?Bin Meng???

Quoted 4 lines

At present in the rendered platform guide, all instances of <xyz> are missing. Use &lt; and &gt; to replace <> to make them visible.

Quoted 49 lines

---

?docs/platform_guide.md | 16 ++++++++--------
?1 file changed, 8 insertions(+), 8 deletions(-)

docs/platform_guide.md +0 -0
index df90c6b..b6c2c2e 100644
@@ -25,18 +25,18 @@ APIs is available in the file
 *include/sbi/sbi_platform.h*.

?Adding support for a new platform
?---------------------------------
?

docs/platform_guide.md +1 -1
-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

docs/platform_guide.md +1 -1
-above.
+*&lt;xyz&gt;* under the *platform/* directory will create all the

files
+mentioned above.

Signature · 1 line
2.25.1
Applied
#3 lore raw

PATCH 2/2 docs: Make <xyz> visible in the rendered platform guide

Quoted 7 lines · Xiang W

? 2021-07-08???? 19:07 +0800?Bin Meng???

Quoted 4 lines

At present in the rendered platform guide, all instances of <xyz> are missing. Use &lt; and &gt; to replace <> to make them visible.

Applied this patch to the riscv/opensbi repo.

Thanks,
Anup

Quoted 56 lines
Quoted 43 lines

---

 docs/platform_guide.md | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)
docs/platform_guide.md +1 -1
index df90c6b..b6c2c2e 100644
@@ -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

docs/platform_guide.md +1 -1
-   *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*

docs/platform_guide.md +2 -1
-   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

docs/platform_guide.md +1 -1
-above.
+*&lt;xyz&gt;* under the *platform/* directory will create all the
Quoted 6 lines

files
+mentioned above.
--
2.25.1

--
opensbi mailing list
opensbi at lists.infradead.org
http://lists.infradead.org/mailman/listinfo/opensbi

#4 lore raw

PATCH 1/2 docs: Correct a typo in platform_guide.md

In reply to Bin Meng

? 2021-07-08???? 19:07 +0800?Bin Meng???

Quoted 3 lines

It's riscv-pk, not riskv-pk.

Quoted 26 lines

---

?docs/platform_guide.md | 2 +-
?1 file changed, 1 insertion(+), 1 deletion(-)

docs/platform_guide.md +0 -0
index 7920fac..df90c6b 100644
@@ -17,7 +17,7 @@ the supported platforms. These firmwares are linked

against *libplatsbi.a*.
?Firmware binaries are installed in ?*<install_directory>/platform/<platform_subdir>/bin*. These firmwares can be
?used as executable runtime firmwares on the supported platforms as a replacement

docs/platform_guide.md +1 -1
-for the legacy *riskv-pk* boot loader (BBL).
+for the legacy *riscv-pk* boot loader (BBL).

?
?A complete doxygen-style documentation of *struct sbi_platform* and related
?APIs is available in the file *include/sbi/sbi_platform.h*.

Signature · 1 line
2.25.1
Applied
#5 lore raw

PATCH 1/2 docs: Correct a typo in platform_guide.md

Quoted 6 lines · Xiang W

? 2021-07-08???? 19:07 +0800?Bin Meng???

Quoted 3 lines

It's riscv-pk, not riskv-pk.

Applied this patch to the riscv/opensbi repo.

Thanks,
Anup

Quoted 33 lines
Quoted 20 lines

---

 docs/platform_guide.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
docs/platform_guide.md +0 -0
index 7920fac..df90c6b 100644
@@ -17,7 +17,7 @@ the supported platforms. These firmwares are linked

against *libplatsbi.a*.
Firmware binaries are installed in *<install_directory>/platform/<platform_subdir>/bin*. These
firmwares can be
used as executable runtime firmwares on the supported platforms as a
replacement

docs/platform_guide.md +1 -1
-for the legacy *riskv-pk* boot loader (BBL).
+for the legacy *riscv-pk* boot loader (BBL).
 
 A complete doxygen-style documentation of *struct sbi_platform* and
Quoted 6 lines

related
APIs is available in the file *include/sbi/sbi_platform.h*.
--
2.25.1

--
opensbi mailing list
opensbi at lists.infradead.org
http://lists.infradead.org/mailman/listinfo/opensbi