From d5afacb10fd863a763ba397dfa4fa4fe396245d7 Mon Sep 17 00:00:00 2001 From: JF Ding Date: Tue, 19 Nov 2013 10:09:06 +0800 Subject: [PATCH] clean up and refine all the docs in git Break the long lines, remove the deprecated content, etc. BTW, other minor changes include: * move the cmdln completion scripts to more proper places * file permission checking Change-Id: I063d99119156b45279a387c24280723ae70f4eb2 Signed-off-by: Jianfeng Ding --- AUTHORS | 38 +++++++++----------- README.rst | 33 +++++++++++------ debian/rules | 4 +-- doc/FAQ.rst | 58 ++++++++++++++++++++++++++++++ doc/KNOWN_ISSUES | 12 ++++--- doc/RELEASE_NOTES | 4 +-- doc/faq.rst | 36 ------------------- etc/{mic.bash => bash_completion.d/mic.sh} | 0 etc/{ => zsh_completion.d}/_mic | 0 packaging/mic.dsc | 2 +- packaging/mic.spec | 4 +-- plugins/backend/zypppkgmgr.py | 0 12 files changed, 112 insertions(+), 79 deletions(-) create mode 100644 doc/FAQ.rst delete mode 100644 doc/faq.rst rename etc/{mic.bash => bash_completion.d/mic.sh} (100%) rename etc/{ => zsh_completion.d}/_mic (100%) mode change 100755 => 100644 plugins/backend/zypppkgmgr.py diff --git a/AUTHORS b/AUTHORS index 50ade97..d05b5f1 100644 --- a/AUTHORS +++ b/AUTHORS @@ -1,23 +1,19 @@ +# Contributors of MIC -PRIMARY AUTHORS are: - - * Anas Nashif - * Gui Chen - * Jian-feng Ding - * Zhang Qiang - -ADDITIONAL CONTRIBUTORS include: - - * Artem Bityutskiy - * Ed Bartosh - * Huanhuan Li - * Huaxu Wan - * Huang Hao - * Marko Saukko - * Markus Lehtonen - * Patrick McCarty - * Shuangquan Zhou - * jobol - * yanqingx.li - * Yeongil Jang + * Anas Nashif + * Gui Chen + * Jian-feng Ding + * Zhang Qiang + * Artem Bityutskiy + * Ed Bartosh + * Huanhuan Li + * Huaxu Wan + * Huang Hao + * Marko Saukko + * Markus Lehtonen + * Patrick McCarty + * Shuangquan Zhou + * jobol + * yanqingx.li + * Yeongil Jang diff --git a/README.rst b/README.rst index 8d780a7..c3ff7bb 100644 --- a/README.rst +++ b/README.rst @@ -1,32 +1,45 @@ - mic - Mic Image Creator -======================== +MIC - Mic the Image Creator +=========================== Overview -------- -MIC means Image Creator and it's used to create images for Tizen. The tool offers three major functions: +MIC means "Mic the Image Creator" and it's used to create images for Tizen. +The tool offers three major functions: - image creation -- image conversion +- image conversion bwtween two different formats - chrooting into an image -The tool is derived mainly from MIC2, which is used to create MeeGo images. With great improvements on many features, it has become clear, friendly, and flexible. It provides a python plugin mechanism for developers, to expand image type or image options, and even to hook. +With the MIC tool, users can create different types of images for different +verticals, including live CD images, live USB images, raw images for KVM, +loop images for IVI platforms, and fs images for chrooting. Also, users can +work in a chroot environment, based on an existing live image using MIC's +enhanced chrooting. Besides, MIC enables transforming an image to another +image format, a very useful function for those sensitive to image format. + +It can also provide plugin mechanism for developers to expand image type or +image options, and even to hook. -With the MIC tool, users can create different types of images for different verticals, including live CD images, live USB images, raw images for KVM, loop images for IVI platforms, and fs images for chrooting. Also, users can work in a chroot environment, based on an existing live image using MIC's enhanced chrooting. Besides, MIC enables transforming an image to another image format, a very useful function for those sensitive to image format. Resource -------- - * SITE: https://www.tizen.org/ * REPO: https://download.tizen.org/tools/ * DOCS: https://source.tizen.org/documentation/reference/mic-image-creator - * CODE: https://github.com/01org/mic + * CODE: https://review.tizen.org/gerrit/tools/mic + https://github.com/01org/mic * BUGS: https://bugs.tizen.org/jira * HELP: general@lists.tizen.org + License ------- -MIC is Open Source and is distributed under the GPLv2 License. Please see the COPYING file included with this software +MIC is Open Source and is distributed under the GPLv2 License. +Please see the COPYING file included with this software + Contacts -------- -Contact with us at JIRA: https://bugs.tizen.org/jira, or directly at github.com: https://github.com/01org/mic +When you found a bug, you can file this bug in our official bug tracker: +https://bugs.tizen.org/jira + diff --git a/debian/rules b/debian/rules index 86e1275..d3d030a 100755 --- a/debian/rules +++ b/debian/rules @@ -37,8 +37,8 @@ install: build mkdir -p $(CURDIR)/debian/tmp/etc/bash_completion.d mkdir -p $(CURDIR)/debian/tmp/etc/zsh_completion.d install -m644 doc/mic.1 $(CURDIR)/debian/tmp/usr/share/man/man1 - install -m755 etc/mic.bash $(CURDIR)/debian/tmp/etc/bash_completion.d/mic.sh - install -m755 etc/_mic $(CURDIR)/debian/tmp/etc/zsh_completion.d/_mic + install -m755 etc/bash_completion.d/mic.sh $(CURDIR)/debian/tmp/etc/bash_completion.d/ + install -m755 etc/zsh_completion.d/_mic $(CURDIR)/debian/tmp/etc/zsh_completion.d/_mic install -m755 tools/mic $(CURDIR)/debian/tmp/usr/bin/mic-native python setup.py install --root=$(CURDIR)/debian/tmp --prefix=/usr diff --git a/doc/FAQ.rst b/doc/FAQ.rst new file mode 100644 index 0000000..e52baa3 --- /dev/null +++ b/doc/FAQ.rst @@ -0,0 +1,58 @@ +FAQ +=== + +Q: When creating an image, MIC shows: + "Error : URLGrabber error: http://.../.../repos/oss/ia32/packages/repodata/repomd.xml" + +A: Perhaps your network has some issues, or your proxy doesn't work. + Try another proxy or find out the network issue. + +Q: MIC complains "ERROR: found 1 resolver problem, abort!" + +A: This is not an issue of MIC, it's caused by the repo you used. + Make sure the packages in the repo you used have proper dependencies. + +Q: I used '-A i586' to create an i586 image, but it showed + "nothing provided ....". What's wrong with it? + +A: Use '-A i686'. i586 is lower than i686, so many packages will be missing + from the installation. + +Q: Error shows: "uninstallable providers: somepackageA" + +A: It's caused by the missing package in the repo. To find it out, modify the + "%packages" section with only one item 'somepackageA' in kickstart file, + then you can root cause what's the missing dependency. + +Q: MIC shows in the log: + "file /usr/share/whatever conflicts between attempted installs of somepackageA and somepackageB" + +A: There are conflicts between some packages in the repo you used, but this + is not an issue with MIC. Please make sure you are using a proper repo. + +Q: Error shows: Command 'modprobe' is not available. + +A: In some distributions, when you use sudo, the PATH variable will be changed + and you will lose some important paths. Run 'export PATH=/sbin:$PATH' + before running MIC. + +Q: MIC lost some packages which are specified in '--includepkgs'/'--excludepkgs' + +A: Assume you want to include/exclude some packages in one repo, you will use + '--includepkgs'/'--excludepkgs' option in the according repo command line, + but you should list these packages to %packages section too, otherwise they + will not take any effect. + +Q: How does mic select packages? And how to set the priority of a repo? + +A: In general, mic will select a higher version if two or more available in + all repos, if the version is the same, a higher release number is + prefferred. But if you assign a priority to one repo, mic will prefer to + select packages from the repo with higher priority, even in case a higher + version is available in the repo with a lower priority. Actually the + default priority for a repo is 99, the range of a repo priority is 1~99, + the larger number has the lower priority. + An example is given: + "repo --name=base --baseurl=http://whateverurl --prioirity=1" + + diff --git a/doc/KNOWN_ISSUES b/doc/KNOWN_ISSUES index 72e8b24..cf53eac 100644 --- a/doc/KNOWN_ISSUES +++ b/doc/KNOWN_ISSUES @@ -3,9 +3,11 @@ Known Issues ARM64 support ------------- -Currently mic only supports aarch64 (aka arm64) in native mode. To support -aarch64 in mic, you should upgrade following packages manually: -libzypp -python-zypp -qemu-arm-static +Currently mic only supports aarch64 (ARM64) in native running mode because +of current enabling status in Tizen repository. And the following packages +need to be upgraded by using Tizen-tools repository: + +* libzypp +* python-zypp +* qemu-arm-static diff --git a/doc/RELEASE_NOTES b/doc/RELEASE_NOTES index 14b4b5f..f9d849a 100644 --- a/doc/RELEASE_NOTES +++ b/doc/RELEASE_NOTES @@ -1,5 +1,5 @@ - MIC Image Creator 0.21 Release Notes -=========================================================== +MIC Image Creator 0.21 Release Notes +==================================== Released August 28 2013 This release note documents the changes included in the new release. And diff --git a/doc/faq.rst b/doc/faq.rst deleted file mode 100644 index 314b4e4..0000000 --- a/doc/faq.rst +++ /dev/null @@ -1,36 +0,0 @@ -FAQ -=== - -Q: When creating an image, MIC shows "Error : URLGrabber error: http://www.example.com/latest/repos/oss/ia32/packages/repodata/repomd.xml" - -A: Perhaps your network has some issues, or your proxy doesn't work. Try another proxy or find out the network issue. - -Q: MIC complains "ERROR: found 1 resolver problem, abort!" - -A: This is not an issue of MIC, it's caused by the repo you used. Make sure the packages in the repo you used have proper dependencies. - -Q: I used '-A i586' to create an i586 image, but it showed "nothing provided ....". What's wrong with it? - -A: Use '-A i686'. i586 is lower than i686, so many packages will be missing from the installation. - -Q: Error shows: "uninstallable providers: somepackageA" - -A: It's caused by the missing package in the repo. To find it out, modify the %packages section with only one item 'somepackageA' in kickstart file, then you can root cause what's the missing dependency. - -Q: MIC shows in the log: "file /usr/share/whatever conflicts between attempted installs of somepackageA and somepackageB" - -A: There are conflicts between some packages in the repo you used, but this is not an issue with MIC. Please make sure you are using a proper repo. - -Q: Error shows: Command 'modprobe' is not available. - -A: In some distributions, when you use sudo, the PATH variable will be changed and you will lose some important paths. Run 'export PATH=/sbin:$PATH' before running MIC. - -Q: MIC lost some packages which are specified in '--includepkgs'/'--excludepkgs' - -A: Assume you want to include/exclude some packages in one repo, you will use '--includepkgs'/'--excludepkgs' option in the according repo command line, but you should list these packages to %packages section too, otherwise they will not take any effect. - -Q: How does mic select packages? And how to set the priority of a repo? - -A: In general, mic will select a higher version if two or more available in all repos, if the version is the same, a higher release number is prefferred. But if you assign a priority to one repo, mic will prefer to select packages from the repo with higher priority, even in case a higher version is available in the repo with a lower priority. Actually the default priority for a repo is 99, the range of a repo priority is 1~99, the larger number has the lower priority. An example is given: 'repo --name=base --baseurl=http://whateverurl --prioirity=1'. - - diff --git a/etc/mic.bash b/etc/bash_completion.d/mic.sh similarity index 100% rename from etc/mic.bash rename to etc/bash_completion.d/mic.sh diff --git a/etc/_mic b/etc/zsh_completion.d/_mic similarity index 100% rename from etc/_mic rename to etc/zsh_completion.d/_mic diff --git a/packaging/mic.dsc b/packaging/mic.dsc index f511cd3..7d8fe70 100644 --- a/packaging/mic.dsc +++ b/packaging/mic.dsc @@ -4,7 +4,7 @@ Binary: mic, mic-native Architecture: all Version: 0.22 Maintainer: Gui Chen -Homepage: http://www.tizen.org +Homepage: https://review.tizen.org/gerrit/tools/mic Standards-Version: 3.8.0 Build-Depends: debhelper (>= 7.0.15), dpatch, cdbs, python-dev, python-support, python-docutils Files: diff --git a/packaging/mic.spec b/packaging/mic.spec index cf33400..30783fb 100644 --- a/packaging/mic.spec +++ b/packaging/mic.spec @@ -113,11 +113,11 @@ install -m644 doc/mic.1 %{buildroot}/%{_prefix}/share/man/man1 # install bash completion install -d -m0755 %{buildroot}/%{_sysconfdir}/bash_completion.d/ -install -Dp -m0755 etc/%{name}.bash %{buildroot}/%{_sysconfdir}/bash_completion.d/%{name}.sh +install -Dp -m0755 etc/bash_completion.d/%{name}.sh %{buildroot}/%{_sysconfdir}/bash_completion.d/ # install zsh completion install -d -m0755 %{buildroot}/%{_sysconfdir}/zsh_completion.d/ -install -Dp -m0755 etc/_%{name} %{buildroot}/%{_sysconfdir}/zsh_completion.d/_%{name} +install -Dp -m0755 etc/zsh_completion.d/_%{name} %{buildroot}/%{_sysconfdir}/zsh_completion.d/ install -Dp -m0755 tools/mic %{buildroot}/%{_bindir}/mic-native diff --git a/plugins/backend/zypppkgmgr.py b/plugins/backend/zypppkgmgr.py old mode 100755 new mode 100644 -- 2.7.4