diff --git a/doc/Makefile.am b/doc/Makefile.am index 3b76e87f2..1ef5601ee 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,4 @@ -SUBDIRS = autodocs proposal inst_images +SUBDIRS = autodocs proposal doc_DATA = *.html diff --git a/doc/inst-images.md b/doc/inst-images.md new file mode 100644 index 000000000..6ff44a5bf --- /dev/null +++ b/doc/inst-images.md @@ -0,0 +1,73 @@ +Installation Images +=================== + +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. + +Example of images on media: + + Available Images: + * Base_System + * Xorg + * Additional_Tools + * Metadata_image_*, one for each imageset + +Example of imagesets (combinations of images): + + 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) + +Supported Types of Images +------------------------- + +- *\*.lzma* (((files)tar)lzma) - TAR\* archive additionally compressed + with LZMA + +- *\*.xz* - (((files)tar)lzma) - TAR\* archive additionally compressed + with newer LZMA + +- *\*.tar.bzip2, \*.tar.gz* (((files)tar)bzip2/gzip) - TAR\*/Bzip2; + resp. TAR\*/Gzip archive + +\* Each TAR archive is created with: *--numeric-owner --checkpoint=400 +--record-size=10240* + +Imagesets Description +--------------------- + +If we want to use installation images, we have to describe them first. +See the [example of file](inst_images/images.xml.example) stored on the first +installation media: + +This XML file describes sets of images from which an installation +chooses the best-matching one according to \...\ +item defined in each *imageset*. + +Images Details +-------------- + +Each imageset contains one or more images. To provide a useful feedback +when deploying the images, they have to be described in +*/images/details-$ARCH.xml*, respectively in file +*/images/details.xml* stored on the first installation media: + +*$ARCH* is one of: *i386*, *sparc*, *mips*, *ppc*, *alpha*, *s390*, +*ia64*, and *x86\_64*. + +Mandatary items for each *image* (file name) are *file* and *size* (in +bytes). diff --git a/doc/inst_images/Makefile.am b/doc/inst_images/Makefile.am deleted file mode 100644 index 97d687d23..000000000 --- a/doc/inst_images/Makefile.am +++ /dev/null @@ -1,28 +0,0 @@ -SUBDIRS = - -xml_files = $(wildcard *.xml) $(wildcard examples/*.xml) - -html_DATA = $(wildcard html/*.html) \ - html/yast2docs.css - -all-local: html/index.html - -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) diff --git a/doc/inst_images/inst_images.xml b/doc/inst_images/inst_images.xml deleted file mode 100644 index 37ea94a5c..000000000 --- a/doc/inst_images/inst_images.xml +++ /dev/null @@ -1,91 +0,0 @@ - -
- Installation Images - - 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. - - Example of images on media: - -Available Images: - * Base_System - * Xorg - * Additional_Tools - * Metadata_image_*, one for each imageset - - -Example of imagesets (combinations of images): - -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) - - -
- Supported Types of Images - - - *.lzma (((files)tar)lzma) - - TAR* archive additionally compressed with LZMA - - *.xz - (((files)tar)lzma) - - TAR* archive additionally compressed with newer LZMA - *.tar.bzip2, *.tar.gz (((files)tar)bzip2/gzip) - - TAR*/Bzip2; resp. TAR*/Gzip archive - - * Each TAR archive is created with: - --numeric-owner --checkpoint=400 --record-size=10240 - -
- -
- Imagesets Description - - If we want to use installation images, we have to describe them first. - See the example of /images/images.xml file stored on - the first installation media: - - - - This XML file describes sets of images from which an installation - chooses the best-matching one according to - <patterns>...</patterns> item defined in each - imageset. -
- -
- Images Details - - Each imageset contains one or more images. To provide a useful - feedback when deploying the images, they have to be described in - /images/details-${ARCH}.xml, respectively in file - /images/details.xml stored on the first installation - media: - - - - ${ARCH} is one of: i386, - sparc, mips, ppc, - alpha, s390, ia64, - and x86_64. - - Mandatary items for each image (file name) are - file and size (in bytes). -
-