public inbox for isar-users@googlegroups.com
 help / color / mirror / Atom feed
From: Cedric Hombourger <Cedric_Hombourger@mentor.com>
To: <isar-users@googlegroups.com>
Cc: Cedric Hombourger <Cedric_Hombourger@mentor.com>
Subject: [PATCH 1/1] doc: clarify usage of the IMAGE_TYPE variable
Date: Wed, 22 Aug 2018 13:49:34 +0200	[thread overview]
Message-ID: <1534938574-7675-2-git-send-email-Cedric_Hombourger@mentor.com> (raw)
In-Reply-To: <1534938574-7675-1-git-send-email-Cedric_Hombourger@mentor.com>

Documentation of the IMAGE_TYPE variable was misleading since it
claimed that the variable could hold a space separated list of
image types to be generated. The current image generation code
really assumes that a single type will be specified. Also update
the documentation to list "wic-img" as a provided IMAGE_TYPE.

Signed-off-by: Cedric Hombourger <Cedric_Hombourger@mentor.com>
---
 doc/user_manual.md | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/doc/user_manual.md b/doc/user_manual.md
index 427f83d..87fd77a 100644
--- a/doc/user_manual.md
+++ b/doc/user_manual.md
@@ -361,11 +361,12 @@ Please refer to `Add a Custom Application` section for more information about wr
 
 ## Image Type Selection
 
-Isar can generate various images types for specific machine. The `IMAGE_TYPE` variable contains the list of image types to generate. Currently, the following image types are provided:
+Isar can generate various images types for specific machine. The type of the image to be generated may be specified through the `IMAGE_TYPE` variable. Currently, the following image types are provided:
 
  - `ext4` - Raw ext4 filesystem image (default option for `qemuarm` machine).
  - `rpi-sdimg` - A complete, partitioned Raspberry Pi SD card image (default option for the `rpi` machine).
- 
+ - `wic-img` - A full disk image with user-specified partitions created and populated using the wic tool.
+
 ---
 
 ## Add a New Distro
@@ -485,10 +486,11 @@ IMAGE_TYPE = "my-image"
 
 ### Reference Classes
 
-Isar contains two image type classes that can be used as reference:
+Isar contains three image type classes that can be used as reference:
 
  - `ext4-img`
  - `rpi-sdimg`
+ - `wic-img`
 
 ---
 
-- 
2.11.0


  reply	other threads:[~2018-08-22 11:49 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-08-22 11:49 [PATCH 0/1] update documentation for IMAGE_TYPE Cedric Hombourger
2018-08-22 11:49 ` Cedric Hombourger [this message]
2018-08-27 22:10 ` Maxim Yu. Osipov
2018-08-28  6:39   ` Hombourger, Cedric

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1534938574-7675-2-git-send-email-Cedric_Hombourger@mentor.com \
    --to=cedric_hombourger@mentor.com \
    --cc=isar-users@googlegroups.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox