From 52bf8037422239528fbf90ca0479af07aaa406cf Mon Sep 17 00:00:00 2001 From: Ivan Davidov Date: Thu, 28 Dec 2017 04:57:49 +0200 Subject: [PATCH] The files are displayed nicely on 80-column screens. --- src/.config | 74 ++++++++++++++++++++++++++--------------------------- src/README | 45 ++++++++++++++++---------------- 2 files changed, 59 insertions(+), 60 deletions(-) diff --git a/src/.config b/src/.config index 31548ec57..701c74fd5 100644 --- a/src/.config +++ b/src/.config @@ -67,35 +67,36 @@ FIRMWARE_TYPE=bios # USE_PREDEFINED_KERNEL_CONFIG=false -# Use predefined '.config' file when building BusyBox. This overrides the config -# generation in 'xx_build_busybox.sh' and the build process uses the config file -# provided in this parameter. Place the configuration file here: +# Use predefined '.config' file when building BusyBox. This overrides the +# config generation in 'xx_build_busybox.sh' and the build process uses the +# config file provided in this parameter. Place the configuration file here: # # minimal_config/busybox.config # USE_PREDEFINED_BUSYBOX_CONFIG=false -# Define the overlay type to use. Possible values are 'sparse' and 'folder'. You -# can use any other value, no value, or comment the property in order to disable -# it. Put your overlay content in the folder 'minimal_overlay/rootfs' and it will -# be automatically merged with the root file system on boot. The build process -# creates either '/minimal.img/rootfs' or '/minimal/rootfs' (read below) and -# this folder contains all overlay content in it. The build process also creates -# '/minimal.img/work' or '/minimal/work'. This folder is used by the overlay -# driver to store modifications related to the read only storage. If the overlay -# media is writeable, then all changes on the root filesystem are automatically -# persisted and preserved on reboot. +# Define the overlay type to use. Possible values are 'sparse' and 'folder'. +# You can use any other value, no value, or comment the property in order to +# disable it. Put your overlay content in the folder 'minimal_overlay/rootfs' +# and it will be automatically merged with the root file system on boot. The +# build process creates either '/minimal.img/rootfs' or '/minimal/rootfs' (read +# below) and this folder contains all overlay content in it. The build process +# also creates '/minimal.img/work' or '/minimal/work'. This folder is used by +# the overlay driver to store modifications related to the read only storage. +# If the overlay media is writeable, then all changes on the root filesystem +# are automatically persisted and preserved on reboot. # -# sparse - use sparse file 'minimal.img' with hardcoded maximal size of 3MB (see -# xx_generate_overlay.sh). The generated ISO image is larger because -# the sparse file is treated as regular file. This option requires root -# permissions or otherwise sparse file generation is silently skipped. -# Sparse file is treated as separate disk image and works fine on FAT. +# sparse - use sparse file 'minimal.img' with hardcoded maximal size of 3MB +# (see 'xx_generate_overlay.sh'). The generated ISO image is larger, +# because the sparse file is treated as regular file. This option +# requires root permissions or otherwise sparse file generation is +# silently skipped. Sparse file is treated as separate disk image and +# works fine on FAT. # # folder - use normal folder structure (/minimal/). Note that this doesn't work -# if the file system is FAT because FAT requires special handling, e.g. -# POSIX overlay (http://sf.net/p/posixovl). This is the default option -# because it doesn't require root permissions. +# if the file system is FAT because FAT requires special handling, +# e.g. POSIX overlay (http://sf.net/p/posixovl). This is the default +# option because it doesn't require root permissions. # OVERLAY_TYPE=folder @@ -115,11 +116,11 @@ OVERLAY_TYPE=folder # and all development host dependencies should be eliminated. However, for now # it is up to you to maintain your host build environment. # -# Note that if you build any overlay software and you are using sparse image file -# for the overlay structure then most probably something will go wrong because -# the overlay software requires more than 3MB free space. The solution is to use -# folder overlay or to edit the script 'xx_generate_overlay.sh' and modify it to -# create sparse image file with bigger size. +# Note that if you build any overlay software and you are using sparse image +# file for the overlay structure then most probably something will go wrong, +# because the overlay software requires more than 3MB free space. The solution +# is to use folder overlay or to edit the script 'xx_generate_overlay.sh' and +# modify it to create sparse image file with bigger size. # # Currently available overlay software: # @@ -182,24 +183,23 @@ OVERLAY_BUNDLES=dhcp,mll_logo,mll_source # OVERLAY_LOCATION=iso -# Use already downloaded source bundles instead of downloading them from -# internet. This is useful when you have already downloaded the sources and have -# no internet connection, or if you want to share your version of 'Minimal Linux -# Live' with predefined sources. +# Always use local source bundles. This is useful when you have downloaded the +# sources and have no internet connection, or if you want to share your version +# of 'Minimal Linux Live' with predefined sources. # USE_LOCAL_SOURCE=false # This property enables the standard penguin boot logo in the upper left corner -# of the screen. The property is used in 'xx_build_kernel.sh'. The default value -# is 'true' for demonstration purposes. +# of the screen. The property is used in 'xx_build_kernel.sh'. The default +# value is 'true' for demonstration purposes. # USE_BOOT_LOGO=true -# This property is the multiplicator which is used during the build process. The -# total number of each 'make' jobs will be equal to the number of detected CPU -# cores mutiplied by this property. For example, if you set this property with -# value '2' and if your CPU has 4 cores, then the number of 'make' jobs will be -# 4 * 2 = 8. Don't change this property unless you know what 'make' jobs are. +# This property is the multiplicator which is used during the build process. +# The total number of each 'make' jobs will be equal to the number of detected +# CPU cores mutiplied by this property. For example, if you set this property +# with value '2' and if your CPU has 4 cores, then the number of 'make' jobs +# will be 4 * 2 = 8. # JOB_FACTOR=1 diff --git a/src/README b/src/README index c479ed6c6..94a95139e 100644 --- a/src/README +++ b/src/README @@ -25,46 +25,45 @@ Currently available overlay bundles: bosh_cli - BOSH command line tool. It can be used as landscape manager for virtual network and server infrastructures in cloud - environment, e.g. AWS, Google Cloud, etc. The most common use - case for this tool is to create and manage Cloud Foundry - infrastructures. + environments, e.g. AWS, Google Cloud, etc. Common use case + for this tool is to manage Cloud Foundry infrastructures. c2048 - console version of the game 2048. - cf_cli - Cloud Foundry command line tool. It can be used to manage all - aspects of already existing Cloud Foundry installation, + cf_cli - Cloud Foundry command line tool. It can be used to manage + all aspects of already existing Cloud Foundry installation, including the full software development lifecycle in cloud - environment. + based environment. - cf_tools - this is metapackage which installs all BOSH and Cloud Foundry - tools. Note that in MLL context these tools are mostly useful - as remote managers for existing BOSH and Cloud Foundry cloud + cf_tools - metapackage which installs all BOSH and Cloud Foundry tools. + Note that in MLL context these tools are mostly useful as + remote managers for existing BOSH and Cloud Foundry cloud infrastructures. coreutils - set of commonly used GNU executable utilities. - dhcp - DHCP and DNS functionality to connect to the Internet. + dhcp - DHCP and DNS functionality. dialog - shell scripting library for 'ncurses'. This overlay bundle requires 'ncurses'. Dropbear - SSH server/client. This overlay bundle requires some GLIBC - libraries.The build process creates user 'root' with password - 'toor'. These are sample commands which demonstrate how to - use Dropbear: + libraries.The build process generates new 'root' user with + password 'toor'. These are sample commands which demonstrate + how to use Dropbear: SSH server (Alt + F1): dropbear -E -F SSH client (Alt + F2): dbclient 10.0.2.15 -l root - Felix OSGi - Apache Felix OSGi framework. Use the 'felix-start' command to - run the Apache Felix OSGi framework. This overlay bundle + Felix OSGi - Apache Felix OSGi framework. Use the 'felix-start' command + to run the Apache Felix OSGi framework. This overlay bundle requires JRE or JDK. fio - I/O load generator that can simulate a wide variety of workloads on RAM or disks. 'fio' is essential for - troubleshootingdata I/O bottlenecks. + troubleshooting data I/O bottlenecks. - JRE / JDK - Oracle's JRE or JDK. This overlay bundle requires some manual + JRE / JDK - Oracle JRE/JDK. This overlay bundle requires some manual preparation steps. Refer to the 'JAVA_ARCHIVE' property in the '.config' file for more information. This overlay bundle requires GLIBC and ZLIB. @@ -74,7 +73,7 @@ Currently available overlay bundles: loadkeys de - kernel_modules - kernel modules and 'mdev' hotplug manager. + kernel_modules - kernel modules and 'mdev' hotplug manager. kexec_tools - these tools can be used to boot another kernel and initramfs from userspace. @@ -119,7 +118,7 @@ Currently available overlay bundles: CPU, memory, I/O, and disk stress on the system. stress is useful for troubleshooting CPU and RAM issues. - util_linux - set of executable utilities distributed by the Linux Kernel, + util_linux - set of executable utilities distributed by the Linux kernel, similar to busybox or GNU Core Utils. Some packages in this overlay bundle require 'ncurses'. @@ -146,17 +145,17 @@ highly recommended to build MLL before you use the overlay build system. You can build all bundles declared in the main '.config' file like this: cd minimal_overlay - ./overlay_build + ./overlay_build.sh You can build individual overlay bundle like this: cd minimal_overlay - ./overlay_build bundle_name + ./overlay_build.sh bundle_name You can build more two or more bundles if you separate them with comma: cd minimal_overlay - ./overlay_build bundle_name_a,bundle_name_b,bundle_name_c + ./overlay_build.sh bundle_name_a,bundle_name_b,bundle_name_c The simplest way to add something to MLL is to put whatever you want in the following folder: @@ -183,4 +182,4 @@ you need. The build proces is slow, so be prepared to wait. In the end you should have the ISO image file 'minimal_linux_live.iso' in the same folder where you started the build process. You can burn the ISO image on CD/DVD or (better) run -it with PC emulator like QEMU or VirtualBox. +it with PC emulator like QEMU, VirtualBox or VMware Workstation Player.