summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGyeoungmin.kim <g5.kim@samsung.com>2014-11-06 14:41:01 +0900
committerLihong Sun <lihongx.sun@intel.com>2014-12-05 02:40:38 -0500
commita2d5f49f1b65ea00ebb199a4a2fa3d5277b9a0b5 (patch)
tree8fd7a6389a6ea3af58a74de67df749888484093f /doc
parentdb6879e22a6d9c4fe8048743d1ffd75f9ae1c169 (diff)
downloadmic-a2d5f49f1b65ea00ebb199a4a2fa3d5277b9a0b5.tar.gz
mic-a2d5f49f1b65ea00ebb199a4a2fa3d5277b9a0b5.tar.bz2
mic-a2d5f49f1b65ea00ebb199a4a2fa3d5277b9a0b5.zip
Updata manual page in /doc
Change-Id: I7144355d94a6c4b02a6d9fe47178c8bdd38d6691 Signed-off-by: Gyeoungmin.kim <g5.kim@samsung.com> Signed-off-by: Lihong Sun <lihongx.sun@intel.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/install.rst1
-rw-r--r--doc/man.rst25
2 files changed, 18 insertions, 8 deletions
diff --git a/doc/install.rst b/doc/install.rst
index fef0fb7..bc5d668 100644
--- a/doc/install.rst
+++ b/doc/install.rst
@@ -10,6 +10,7 @@ Many mainstream Linux distributions are supported in Tizen Tools repository, inc
- Ubuntu (12.10, 12.04, 11.10)
- openSUSE (12.2, 12.1)
- Feodra (17, 16)
+- Debian (7.0)
Ubuntu Installation
-------------------
diff --git a/doc/man.rst b/doc/man.rst
index 00d208e..c0a1330 100644
--- a/doc/man.rst
+++ b/doc/man.rst
@@ -13,14 +13,14 @@ 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 three subcommand: `create`, `convert`, `chroot`.
USAGE
=====
create
------
-This command is used to create various images, including live CD, live USB,
+This command is used to create various images, including live CD, live USB,
loop, raw.
Usage:
@@ -50,17 +50,22 @@ Options:
--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
--release=RID generate a release of RID with all necessary files, when @BUILD_ID@ is contained in kickstart file, it will be replaced by RID. sample values: "latest", "tizen_20120101.1"
--copy-kernel copy kernel files from image /boot directory to the image output directory
+ --runtime=RUNTIME Specify runtime mode, avaiable: bootstrap, native
+ --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
Options for fs image:
--include-src generate a image with source rpms included; to enable it, user should specify the source repo in the ks file
Options for loop image:
--shrink whether to shrink loop images to minimal size
- --compress-image=COMPRESS_IMAGE compress all loop images with 'gz' or 'bz2'
+ --compress-image=COMPRESS_IMAGE compress all loop images with 'gz' or 'bz2' or 'lzo'
--compress-disk-image=COMPRESS_DISK_IMAGE same with --compress-image
Options for raw image:
- --compress-image=COMPRESS_IMAGE compress all raw images with 'gz' or 'bz2'
+ --compress-image=COMPRESS_IMAGE compress all raw images with 'gz' or 'bz2' or 'lzo'
--compress-disk-image=COMPRESS_DISK_IMAGE same with --compress-image
Examples:
@@ -112,7 +117,7 @@ Advanced Usage
The advanced usage is just for bootstrap, please skip it if you don't care about it.
The major purpose to use bootstrap is that some important packages (like rpm) are customized
-a lot in the repo which you want to create image, and mic must use the customized rpm to
+a lot in the repo which you want to create image, and mic must use the customized rpm to
create images, or the images can't be boot. So mic will create a bootstrap using the repo
in the ks file at first, then create the image via chrooting, which can make mic using the
chroot environment with the customized rpm.
@@ -147,13 +152,17 @@ tools repos, until the official released one being fixed.
Failed to create btrfs image in openSUSE
----------------------------------------
-When creating btrfs image in openSUSE, it would hang up with showing image kernel
-panic. This issue impact all openSUSE distributions: 12.1, 11.4, 11.3, etc
+When creating btrfs image in openSUSE, it would hang up with showing image kernel
+panic. This issue impact all openSUSE distributions: 12.1, 11.4, 11.3, etc
REPORTING BUGS
==============
The source code is tracked in github.com:
- https://github.com/jfding/mic
+ https://github.com/01org/mic
+
+The bug is registered in tizen.org:
+
+ https://bugs.tizen.org/jira
Please report issues for bugs or feature requests.