[meta-arm] arm-bsp/documentation: add BSP documentation template

Submitted by Ross Burton on Sept. 30, 2020, 3:05 p.m. | Patch ID: 176906

Details

Message ID 20200930150514.634610-1-ross.burton@arm.com
State New
Headers show

Commit Message

Ross Burton Sept. 30, 2020, 3:05 p.m.
Add a template for future BSP documentation.

Change-Id: I614d43f477f1a5dfb898b808d4c5b78a5bb163b8
Signed-off-by: Ross Burton <ross.burton@arm.com>
---
 meta-arm-bsp/documentation/template.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 meta-arm-bsp/documentation/template.md

Patch hide | download patch | download mbox

diff --git a/meta-arm-bsp/documentation/template.md b/meta-arm-bsp/documentation/template.md
new file mode 100644
index 0000000..7beeb59
--- /dev/null
+++ b/meta-arm-bsp/documentation/template.md
@@ -0,0 +1,19 @@ 
+# *Hardware Name*
+
+## Overview
+
+*Brief summary of the hardware*
+
+*Link to reference documentation*
+
+## Building
+
+*Any special steps required to build successfully beyond setting MACHINE*
+
+*For example: corstone700 needs DISTRO=poky-tiny, musca only supports TF-M*
+
+## Running
+
+*A summary of how to deploy or execute the image*
+
+*For example, an overview of the N1SDP SD structure, or FVP arguments*

Comments

Jon Mason Oct. 1, 2020, 5:37 p.m.
On Wed, Sep 30, 2020 at 04:05:14PM +0100, Ross Burton wrote:
> Add a template for future BSP documentation.
> 
> Change-Id: I614d43f477f1a5dfb898b808d4c5b78a5bb163b8
> Signed-off-by: Ross Burton <ross.burton@arm.com>

Applied to master.

Thanks,
Jon

> ---
>  meta-arm-bsp/documentation/template.md | 19 +++++++++++++++++++
>  1 file changed, 19 insertions(+)
>  create mode 100644 meta-arm-bsp/documentation/template.md
> 
> diff --git a/meta-arm-bsp/documentation/template.md b/meta-arm-bsp/documentation/template.md
> new file mode 100644
> index 0000000..7beeb59
> --- /dev/null
> +++ b/meta-arm-bsp/documentation/template.md
> @@ -0,0 +1,19 @@
> +# *Hardware Name*
> +
> +## Overview
> +
> +*Brief summary of the hardware*
> +
> +*Link to reference documentation*
> +
> +## Building
> +
> +*Any special steps required to build successfully beyond setting MACHINE*
> +
> +*For example: corstone700 needs DISTRO=poky-tiny, musca only supports TF-M*
> +
> +## Running
> +
> +*A summary of how to deploy or execute the image*
> +
> +*For example, an overview of the N1SDP SD structure, or FVP arguments*
> -- 
> 2.28.0
> 

> 
> 
>
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#1169): https://lists.yoctoproject.org/g/meta-arm/message/1169
Mute This Topic: https://lists.yoctoproject.org/mt/77219286/3617530
Group Owner: meta-arm+owner@lists.yoctoproject.org
Unsubscribe: https://lists.yoctoproject.org/g/meta-arm/unsub [oe-patchwork@oe-patch.openembedded.org]
-=-=-=-=-=-=-=-=-=-=-=-