[master/dunfell,V4,07/12] tisdk-core-bundle: Add documentation to clarify usage

Message ID 20220319123310.8546-8-nm@ti.com
State Superseded
Headers show
Series recipes-core: Add a bootstrap Linux image | expand

Commit Message

Nishanth Menon March 19, 2022, 12:33 p.m. UTC
Add documentation to the core-bundle to explain the usage and intent
of the build configuration.

Signed-off-by: Nishanth Menon <nm@ti.com>
---
Changes Since V3: None.

V3: https://lore.kernel.org/all/20220318184045.11246-8-nm@ti.com/

 meta-arago-distro/recipes-core/images/tisdk-core-bundle.bb | 7 +++++++
 1 file changed, 7 insertions(+)

Comments

Nishanth Menon March 22, 2022, 12:18 p.m. UTC | #1
On 07:33-20220319, Nishanth Menon wrote:
> Add documentation to the core-bundle to explain the usage and intent
> of the build configuration.
> 
> Signed-off-by: Nishanth Menon <nm@ti.com>
> ---
> Changes Since V3: None.
> 
> V3: https://lore.kernel.org/all/20220318184045.11246-8-nm@ti.com/
> 
>  meta-arago-distro/recipes-core/images/tisdk-core-bundle.bb | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/meta-arago-distro/recipes-core/images/tisdk-core-bundle.bb b/meta-arago-distro/recipes-core/images/tisdk-core-bundle.bb
> index 253bfbb68657..0892a8a62d57 100644
> --- a/meta-arago-distro/recipes-core/images/tisdk-core-bundle.bb
> +++ b/meta-arago-distro/recipes-core/images/tisdk-core-bundle.bb
> @@ -1,3 +1,10 @@
> +SUMMARY = "Installer package for TI SDK - NOT for direct use on target"
> +
> +DESCRIPTION = "This creates an installer including all the default images\
> + recommended including source, binaries, filesystems, etc.
> + for TI SDK. This is meant to be used on the host system.

^^ Missing \ at EoL. Sorry about that, I did some last min reformatting
:(

> +"
> +
>  require tisdk-core-bundle.inc
>  
>  DEPLOY_SPL_NAME_omapl138 = ""
> -- 
> 2.31.1
>

Patch

diff --git a/meta-arago-distro/recipes-core/images/tisdk-core-bundle.bb b/meta-arago-distro/recipes-core/images/tisdk-core-bundle.bb
index 253bfbb68657..0892a8a62d57 100644
--- a/meta-arago-distro/recipes-core/images/tisdk-core-bundle.bb
+++ b/meta-arago-distro/recipes-core/images/tisdk-core-bundle.bb
@@ -1,3 +1,10 @@ 
+SUMMARY = "Installer package for TI SDK - NOT for direct use on target"
+
+DESCRIPTION = "This creates an installer including all the default images\
+ recommended including source, binaries, filesystems, etc.
+ for TI SDK. This is meant to be used on the host system.
+"
+
 require tisdk-core-bundle.inc
 
 DEPLOY_SPL_NAME_omapl138 = ""