diff mbox series

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

Message ID 20210708110729.7136-2-bmeng.cn@gmail.com
State Accepted
Headers show
Series [1/2] docs: Correct a typo in platform_guide.md | expand

Commit Message

Bin Meng July 8, 2021, 11:07 a.m. UTC 
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>
---

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

Comments

Xiang W July 8, 2021, 12:06 p.m. UTC | #1 
在 2021-07-08星期四的 19:07 +0800，Bin Meng写道：
> 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>
> ---
> 
>  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 *&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.
> -- 
> 2.25.1
> 
>
Anup Patel July 11, 2021, 6:33 a.m. UTC | #2 
On Thu, Jul 8, 2021 at 5:36 PM Xiang W <wxjstz@126.com> wrote:
>
> 在 2021-07-08星期四的 19:07 +0800，Bin Meng写道：
> > 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>

Applied this patch to the riscv/opensbi repo.

Thanks,
Anup

> > ---
> >
> >  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 *&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.
> > --
> > 2.25.1
> >
> >
>
>
>
> --
> opensbi mailing list
> opensbi@lists.infradead.org
> http://lists.infradead.org/mailman/listinfo/opensbi
diff mbox series

Patch

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.