Author: locilka Date: Thu Apr 16 16:58:31 2009 New Revision: 56821 URL: http://svn.opensuse.org/viewcvs/yast?rev=56821&view=rev Log: - Added documentation for installation images. Added: trunk/installation/doc/inst_images/Makefile.am trunk/installation/doc/inst_images/examples/ trunk/installation/doc/inst_images/examples/details.xml trunk/installation/doc/inst_images/examples/images.xml trunk/installation/doc/inst_images/inst_images.xml Modified: trunk/installation/doc/Makefile.am trunk/installation/doc/inst_images/details.xml.example trunk/installation/doc/inst_images/images.xml.example trunk/installation/package/yast2-installation.changes Modified: trunk/installation/doc/Makefile.am URL: http://svn.opensuse.org/viewcvs/yast/trunk/installation/doc/Makefile.am?rev=56821&r1=56820&r2=56821&view=diff ============================================================================== --- trunk/installation/doc/Makefile.am (original) +++ trunk/installation/doc/Makefile.am Thu Apr 16 16:58:31 2009 @@ -1,4 +1,4 @@ -SUBDIRS = autodocs proposal features +SUBDIRS = autodocs proposal features inst_images doc_DATA = *.html Added: trunk/installation/doc/inst_images/Makefile.am URL: http://svn.opensuse.org/viewcvs/yast/trunk/installation/doc/inst_images/Makefile.am?rev=56821&view=auto ============================================================================== --- trunk/installation/doc/inst_images/Makefile.am (added) +++ trunk/installation/doc/inst_images/Makefile.am Thu Apr 16 16:58:31 2009 @@ -0,0 +1,27 @@ +SUBDIRS = + +xml_files = $(wildcard *.xml) + +html_DATA = $(wildcard html/*.html) \ + html/index.html \ + html/yast2docs.css + +html/index.html: inst_images.xml + XML_CATALOG_FILES=@XML_CATALOG@ \ + @XSLTPROC@ @XSLTPROC_FLAGS@ --xinclude \ + @STYLESHEET_HTML@ $< + +html/yast2docs.css: html/index.html + cp @STYLESHEET_CSS@ html + cp -a `pkg-config --variable=yast2dir yast2-devtools`/data/docbook/images html + +EXTRA_DIST = $(xml_files) + +CLEANFILES = $(html_DATA) + +clean-local: + rm -rf html + +install-data-local: + mkdir -p $(DESTDIR)$(htmldir) + cp -a $(srcdir)/html/images $(DESTDIR)$(htmldir) Modified: trunk/installation/doc/inst_images/details.xml.example URL: http://svn.opensuse.org/viewcvs/yast/trunk/installation/doc/inst_images/details.xml.example?rev=56821&r1=56820&r2=56821&view=diff ============================================================================== --- trunk/installation/doc/inst_images/details.xml.example (original) +++ trunk/installation/doc/inst_images/details.xml.example Thu Apr 16 16:58:31 2009 @@ -4,36 +4,40 @@ <details config:type="list"> <image> <file>common-base-root.tar.lzma</file> + <!-- optional --> <files>28004</files> + <!-- optional --> + <rpms config:type="list"> + <rpm>ConsoleKit</rpm> + <rpm>DirectFB</rpm> + <rpm>DirectFB</rpm> + <rpm>PolicyKit</rpm> + <rpm>...</rpm> + </rpms> <!-- Read checkpoint 49500 --> <size>509624320</size> </image> <image> <file>common-xorg-root.tar.lzma</file> - <files>10437</files> <!-- Read checkpoint 21500 --> <size>220549120</size> </image> <image> <file>common-qt.tar.lzma</file> - <files>6</files> <size>10240</size> </image> <image> <file>common-desktop-root.tar.lzma</file> - <files>6742</files> <!-- Read checkpoint 7500 --> <size>79964160</size> </image> <image> <file>kde_cd-root.tar.lzma</file> - <files>32010</files> <!-- Read checkpoint 39000 --> <size>403128320</size> </image> <image> <file>kde_cd-root-meta.tar.lzma</file> - <files>30</files> <!-- Read checkpoint 2000 --> <size>21442560</size> </image> Added: trunk/installation/doc/inst_images/examples/details.xml URL: http://svn.opensuse.org/viewcvs/yast/trunk/installation/doc/inst_images/examples/details.xml?rev=56821&view=auto ============================================================================== --- trunk/installation/doc/inst_images/examples/details.xml (added) +++ trunk/installation/doc/inst_images/examples/details.xml Thu Apr 16 16:58:31 2009 @@ -0,0 +1,31 @@ +<?xml version="1.0"?> +<!DOCTYPE details> +http://www.suse.com/1.0/yast2ns" + xmlns:config="http://www.suse.com/1.0/configns"> + <details config:type="list"> + <image> + <file>common-base-root.tar.lzma</file> + <!-- optional: number of files in archive --> + <files>28004</files> + <!-- optional: list of RPMs in archive --> + <rpms config:type="list"> + <rpm>ConsoleKit</rpm> + <rpm>DirectFB</rpm> + <rpm>DirectFB</rpm> + <rpm>PolicyKit</rpm> + <rpm>...</rpm> + </rpms> + <size>509624320</size> + </image> + <image> + <file>common-xorg-root.tar.lzma</file> + <size>220549120</size> + </image> + <image> + <file>common-qt.tar.lzma</file> + <size>10240</size> + </image> + <!-- one description for one image --> + </details> + Added: trunk/installation/doc/inst_images/examples/images.xml URL: http://svn.opensuse.org/viewcvs/yast/trunk/installation/doc/inst_images/examples/images.xml?rev=56821&view=auto ============================================================================== --- trunk/installation/doc/inst_images/examples/images.xml (added) +++ trunk/installation/doc/inst_images/examples/images.xml Thu Apr 16 16:58:31 2009 @@ -0,0 +1,48 @@ +<?xml version="1.0"?> +<!DOCTYPE images> +http://www.suse.com/1.0/yast2ns" xmlns:config="http://www.suse.com/1.0/configns"> + + + + <!-- + Comma-separated list of patterns included in + a particular imageset + --> + <patterns>kde,x11,enhanced_base</patterns> + <archs>i386,ixxx,iyyy</archs> + <!-- + Matches the image->file of image that contains + a particular imageset metadata + --> + kde-meta.tar.lzma + + <!-- + Each imageset can contain one or more images that + can be combined among all imagesets... + --> + <images config:type="list"> + <image> + <name>KDE [base]</name> + <type>tar</type> + <file>common-base-root.tar.xz</file> + </image> + <image> + <name>KDE [xorg]</name> + <type>tar</type> + <file>common-xorg-root.tar.bzip2</file> + </image> + + <!-- More 'image' items can be added here --> + + <image> + <name>KDE [meta]</name> + <type>tar</type> + <file>kde-meta.tar.lzma</file> + </image> + </images> + + + <!-- More 'image_set' items are usually added here --> + + + Modified: trunk/installation/doc/inst_images/images.xml.example URL: http://svn.opensuse.org/viewcvs/yast/trunk/installation/doc/inst_images/images.xml.example?rev=56821&r1=56820&r2=56821&view=diff ============================================================================== --- trunk/installation/doc/inst_images/images.xml.example (original) +++ trunk/installation/doc/inst_images/images.xml.example Thu Apr 16 16:58:31 2009 @@ -6,6 +6,10 @@ <!DOCTYPE images> http://www.suse.com/1.0/yast2ns" xmlns:config="http://www.suse.com/1.0/configns"> + <!-- + Each imageset can contain one or more images that can be combined + among all imagesets... + --> <patterns>kde,x11,enhanced_base</patterns> <archs>i386,ixxx,iyyy</archs> @@ -43,6 +47,7 @@ </image> </images> + <patterns>gnome,x11,enhanced_base</patterns> <archs>i386,ixxx,iyyy</archs> @@ -80,6 +85,7 @@ </image> </images> + <patterns>enhanced_base</patterns> <archs>i386,ixxx,iyyy</archs> Added: trunk/installation/doc/inst_images/inst_images.xml URL: http://svn.opensuse.org/viewcvs/yast/trunk/installation/doc/inst_images/inst_images.xml?rev=56821&view=auto ============================================================================== --- trunk/installation/doc/inst_images/inst_images.xml (added) +++ trunk/installation/doc/inst_images/inst_images.xml Thu Apr 16 16:58:31 2009 @@ -0,0 +1,91 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section id="i_images"> + <title>Installation Images</title> + + <para>Installation images are used to speed installation up. Each separate + image contains a compact part of a filesystem. Several images can be combined + together to finally create several different complete systems - the only + unique image for each such system is a separate image containing RPM + (plus other metadata) database for a particular system.</para> + + <para>Example of images on media:</para> + <programlisting> +Available Images: + * Base_System + * Xorg + * Additional_Tools + * Metadata_image_*, one for each imageset +</programlisting> + +<para>Example of imagesets (combinations of images):</para> +<programlisting> +Base System: + + Base_System + + Metadata_image_1 (Base_System.meta) + +Advanced System: + + Base_System + + Xorg + + Metadata_image_2 (Base_System.meta + Xorg.meta) + +Superadvanced System + + Base_System + + Xorg + + Additional_Tools + + Metadata_image_3 (Base_System.meta + Xorg.meta + Additional_Tools.meta) +</programlisting> + + <section id="i_images_types"> + <title>Supported Types of Images</title> + + <itemizedlist> + <listitem><para><emphasis>*.lzma</emphasis> (((files)tar)lzma) + - TAR* archive additionally compressed with LZMA</para></listitem> + <!-- http://tukaani.org/xz/xz-file-format.txt --> + <listitem><para><emphasis>*.xz</emphasis> - (((files)tar)lzma) + - TAR* archive additionally compressed with newer LZMA</para></listitem> + <listitem><para><emphasis>*.tar.bzip2, *.tar.gz</emphasis> (((files)tar)bzip2/gzip) + - TAR*/Bzip2; resp. TAR*/Gzip archive</para></listitem> + </itemizedlist> + <para>* Each TAR archive is created with: + <emphasis>--numeric-owner --checkpoint=400 --record-size=10240</emphasis> + </para> + </section> + + <section id="i_images_idescription"> + <title>Imagesets Description</title> + + <para>If we want to use installation images, we have to describe them first. + See the example of <emphasis>/images/images.xml</emphasis> file stored on + the first installation media:</para> + + <programlisting>http://www.w3.org/2001/XInclude"/></programlisting> + + <para>This XML file describes sets of images from which an installation + chooses the best-matching one according to + <patterns>...</patterns> item defined in each + <emphasis>imageset</emphasis>.</para> + </section> + + <section id="i_images_idetails"> + <title>Images Details</title> + + <para>Each imageset contains one or more images. To provide a useful + feedback when deploying the images, they have to be described in + <emphasis>/images/details-${ARCH}.xml</emphasis>, respectively in file + <emphasis>/images/details.xml</emphasis> stored on the first installation + media:</para> + + <programlisting>http://www.w3.org/2001/XInclude"/></programlisting> + + <para><emphasis>${ARCH}</emphasis> is one of: <emphasis>i386</emphasis>, + <emphasis>sparc</emphasis>, <emphasis>mips</emphasis>, <emphasis>ppc</emphasis>, + <emphasis>alpha</emphasis>, <emphasis>s390</emphasis>, <emphasis>ia64</emphasis>, + and <emphasis>x86_64</emphasis>.</para> + + <para>Mandatary items for each <emphasis>image</emphasis> (file name) are + <emphasis>file</emphasis> and <emphasis>size</emphasis> (in bytes).</para> + </section> +</section> Modified: trunk/installation/package/yast2-installation.changes URL: http://svn.opensuse.org/viewcvs/yast/trunk/installation/package/yast2-installation.changes?rev=56821&r1=56820&r2=56821&view=diff ============================================================================== --- trunk/installation/package/yast2-installation.changes (original) +++ trunk/installation/package/yast2-installation.changes Thu Apr 16 16:58:31 2009 @@ -1,4 +1,9 @@ ------------------------------------------------------------------- +Thu Apr 16 16:58:07 CEST 2009 - locilka@suse.cz + +- Added documentation for installation images. + +------------------------------------------------------------------- Fri Apr 10 14:11:46 CEST 2009 - locilka@suse.cz - KDE 3.x dropped from openSUSE control file (bnc #493547). -- To unsubscribe, e-mail: yast-commit+unsubscribe@opensuse.org For additional commands, e-mail: yast-commit+help@opensuse.org