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

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

Commit Message

Nishanth Menon March 18, 2022, 6:40 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 v2: Update to use SUMMARY and DESCRIPTION
moved up in sequence to keep the documentation patches together.

V2: https://lore.kernel.org/all/20220318143735.17642-12-nm@ti.com/

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

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 = ""