summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorjianzhong.fang <jz.fang@samsung.com>2015-11-04 14:01:03 +0800
committeryyh <yyh@123.com>2016-02-04 14:47:06 +0800
commitb61f1f073ad90edd1f502192f56087fe825de222 (patch)
treedff8d6f22ef5b2b06a68064bab86ff7fc8543c3d /doc
parenta5878ae2f3aa82d6b9cc59d7434c2f80e28f7471 (diff)
downloadmic-b61f1f073ad90edd1f502192f56087fe825de222.tar.gz
mic-b61f1f073ad90edd1f502192f56087fe825de222.tar.bz2
mic-b61f1f073ad90edd1f502192f56087fe825de222.zip
Update the mic doc
Change-Id: Id17882b91640f5390198c17bbf3bc2fdb8699668
Diffstat (limited to 'doc')
-rw-r--r--doc/man.rst32
-rw-r--r--doc/usage.rst72
2 files changed, 28 insertions, 76 deletions
diff --git a/doc/man.rst b/doc/man.rst
index 290af95..c58e2f6 100644
--- a/doc/man.rst
+++ b/doc/man.rst
@@ -5,15 +5,14 @@
SYNOPSIS
========
-| mic create SUBCOMMAND <ksfile> [OPTION]
-| mic chroot [OPTION] <imgfile>
-| mic convert [OPTION] <imgfile> <format>
+| mic [GLOBAL-OPTS] create SUBCOMMAND <ksfile> [OPTION]
+| mic [GLOBAL-OPTS] chroot [OPTION] <imgfile>
DESCRIPTION
===========
The tools `mic` is used to create and manipulate images for Linux distributions.
-It is composed of three subcommand: `create`, `convert`, `chroot`.
+It is composed of two subcommand: `create`, `chroot`.
USAGE
=====
@@ -23,14 +22,14 @@ create
This command is used to create various images, including loop.
Usage:
-
- | mic create(cr) SUBCOMMAND <ksfile> [OPTION]
+ | mic [GLOBAL-OPTS] create(cr) SUBCOMMAND <ksfile> [OPTION]
Subcommands:
- | help(?) give detailed help on a specific sub-command
+ | auto auto detect image type from magic header
| fs create fs image, which is also chroot directory
| loop create loop image, including multi-partitions
+ | qcow create qcow image
Options:
@@ -81,25 +80,6 @@ Options:
Examples:
| mic chroot loop.img
- | mic chroot tizen.iso
- | mic ch -s tizenfs tizen.usbimg
-
-convert
--------
-This command is used for converting an image to another format.
-
-Usage:
-
- | mic convert(cv) <imagefile> <destformat>
-
-Options:
-
- -h, --help show the help message
- -S, --shell launch interactive shell before packing the new image in the converting
-
-Examples:
-
-
Advanced Usage
==============
diff --git a/doc/usage.rst b/doc/usage.rst
index d8a10c6..aed950b 100644
--- a/doc/usage.rst
+++ b/doc/usage.rst
@@ -8,7 +8,6 @@ Overview
MIC offers three major functions:
- creating an image with different format
-- converting an image to another format
- chrooting into an image
Getting help
@@ -25,9 +24,7 @@ How to get help:
* mic --help
* mic create --help
- * mic help create
* mic create loop --help
- * mic create help loop
Image formulation support
-------------------------
@@ -38,21 +35,13 @@ Image formulation support
* For a configuration with multiple partitions, which is specified in the kickstartfile, mic will generate multiple loop images
* And multiple loop images can be packed into a single archive file
-- Raw
-
- * “raw” format means something like hard disk dumping
- * Including partition table and all the partitions
- * The image is bootable directly
-
-- Livecd
-
- * Mainly used for an ia32 build, it can be burned to CD or usbstick, which can be booted into a live system or installation UI
-
- fs
* “fs” means file-system
* mic can install all the Tizen files to the specified directory, which can be used directly as chroot env
+- qcow
+
Create
------
@@ -60,16 +49,17 @@ Create
::
- mic create(cr) SUBCOMMAND <ksfile> [OPTION]
+ mic [GLOBAL-OPTS] create(cr) SUBCOMMAND <ksfile> [OPTION]
- Sub-commands, to specify image format, include:
::
- help(?) give detailed help on a specific sub-command
+ auto auto detect image type from magic header
fs create fs image, which is also a chroot directory
loop create loop image, including multi-partitions
+ qcow create qcow image
- <ksfile>:
@@ -104,27 +94,35 @@ In Tizen, the released image will have a ks file along with image. For example,
--pack-to=PACK_TO Pack the images together into the specified achive,
extension supported: .zip, .tar, .tar.gz, .tar.bz2,
etc. by default, .tar will be used
+ --runtime=RUNTIME_MODE
+ Sets runtime mode, the default is bootstrap mode, valid
+ values: "bootstrap". "bootstrap" means mic uses one
+ tizen chroot environment to create image.
--copy-kernel Copy kernel files from image /boot directory to the
image output directory.
-
+ --install-pkgs INSTALL_PKGS Specify what type of packages to be
+ installed, valid: source, debuginfo, debugsource
+ --check-pkgs=CHECK_PKGS
+ Check if given packages would be installed,
+ packages should be separated by comma
+ --tmpfs Setup tmpdir as tmpfs to accelerate, experimental feature,
+ use it if you have more than 4G memory
+ --strict-mode Abort creation of image, if there are some errors
+ during rpm installation
+
- Other options:
::
- --runtime=RUNTIME_MODE
- Sets runtime mode, the default is bootstrap mode, valid
- values: "bootstrap". "bootstrap" means mic uses one
- tizen chroot environment to create image.
- --compress-image=COMPRESS_IMAGE (for loop & raw)
+ --compress-image=COMPRESS_IMAGE (for loop)
Sets the disk image compression. Note: The available
values might depend on the used filesystem type.
--compress-disk-image=COMPRESS_IMAGE
Same with --compress-image
--shrink (for loop)
Whether to shrink loop images to minimal size
- --generate-bmap (for raw)
- Generate the block map file
-
+ --include-src (for fs)
+ Generate a image with source rpms included
- Examples:
::
@@ -154,32 +152,6 @@ This command is used to chroot inside the image. It's a great enhancement of the
::
mic ch loop.img
- mic ch tizen.iso
- mic ch -s tizenfs tizen.usbimg
-
-Convert
--------
-This command is used for converting an image to another format.
-
-
-- Usage:
-
-::
-
- mic convert(cv) <imagefile> <destformat>
-
-- Options:
-
-::
-
- -h, --help Show this help message and exit
- -S, --shell Launch shell before packaging the converted image
-
-- Examples:
-
-::
-
- mic cv tizen.usbimg livecd
Getting Start
-------------