README

   1 dracut
   2 ------
   3 dracut is a new initramfs infrastructure.
   4
   5 Information about the initial goals and aims can be found at
   6 https://fedoraproject.org/wiki/Initrdrewrite
   7
   8 Unlike existing initramfs's, this is an attempt at having as little as
   9 possible hard-coded into the initramfs as possible.  The initramfs has
  10 (basically) one purpose in life -- getting the rootfs mounted so that
  11 we can transition to the real rootfs.  This is all driven off of
  12 device availability.  Therefore, instead of scripts hard-coded to do
  13 various things, we depend on udev to create device nodes for us and
  14 then when we have the rootfs's device node, we mount and carry on.
  15 This helps to keep the time required in the initramfs as little as
  16 possible so that things like a 5 second boot aren't made impossible as
  17 a result of the very existence of an initramfs.  It's likely that
  18 we'll grow some hooks for running arbitrary commands in the flow of
  19 the script, but it's worth trying to resist the urge as much as we can
  20 as hooks are guaranteed to be the path to slow-down.
  21
  22 Most of the initramfs generation functionality in dracut is provided by a bunch
  23 of generator modules that are sourced by the main dracut script to install
  24 specific functionality into the initramfs.  They live in the modules.d
  25 subdirectory, and use functionality provided by dracut-functions to do their
  26 work.
  27
  28 Some general rules for writing modules:
  29  * Use one of the inst family of functions to actually install files
  30    on to the initramfs.  They handle mangling the pathnames and (for binaries,
  31    scripts, and kernel modules) installing dependencies as appropriate so
  32    you do not have to.
  33  * Scripts that end up on the initramfs should be POSIX compliant. dracut
  34    will try to use /bin/dash as /bin/sh for the initramfs if it is available,
  35    so you should install it on your system -- dash aims for strict POSIX
  36    compliance to the extent possible.
  37  * Hooks MUST be POSIX compliant -- they are sourced by the init script,
  38    and having a bashism break your user's ability to boot really sucks.
  39  * Generator modules should have a two digit numeric prefix -- they run in
  40    ascending sort order. Anything in the 90-99 range is stuff that dracut
  41    relies on, so try not to break those hooks.
  42  * Hooks must have a .sh extension.
  43  * Generator modules are described in more detail in README.modules.
  44  * We have some breakpoints for debugging your hooks.  If you pass 'rdbreak'
  45    as a kernel parameter, the initramfs will drop to a shell just before
  46    switching to a new root. You can pass 'rdbreak=hookpoint', and the initramfs
  47    will break just before hooks in that hookpoint run.
  48
  49 Also, there is an attempt to keep things as distribution-agnostic as
  50 possible.  Every distribution has their own tool here and it's not
  51 something which is really interesting to have separate across them.
  52 So contributions to help decrease the distro-dependencies are welcome.
  53
  54 Currently dracut lives on kernel.org.
  55
  56 The tarballs can be found here:
  57         http://www.kernel.org/pub/linux/utils/boot/dracut/
  58         ftp://ftp.kernel.org/pub/linux/utils/boot/dracut/
  59
  60 Git:
  61         git://git.kernel.org/pub/scm/boot/dracut/dracut.git
  62         http://git.kernel.org/pub/scm/boot/dracut/dracut.git
  63         https://git.kernel.org/pub/scm/boot/dracut/dracut.git
  64
  65         git://github.com/haraldh/dracut.git
  66
  67         git://dracut.git.sourceforge.net/gitroot/dracut/dracut
  68
  69 Git Web:
  70         http://git.kernel.org/?p=boot/dracut/dracut.git
  71
  72         https://haraldh@github.com/haraldh/dracut.git
  73
  74         http://dracut.git.sourceforge.net/git/gitweb.cgi?p=dracut/dracut
  75
  76 Git Web RSS Feed:
  77         http://git.kernel.org/?p=boot/dracut/dracut.git;a=rss
  78
  79 Project Page:
  80         http://www.kernel.org/pub/linux/utils/boot/dracut/dracut.html
  81
  82 Project Wiki:
  83         http://dracut.wiki.kernel.org
  84
  85 See the TODO file for things which still need to be done and HACKING for
  86 some instructions on how to get started.  There is also a mailing list
  87 that is being used for the discussion -- initramfs@vger.kernel.org.
  88 It is a typical vger list, send mail to majordomo@vger.kernel.org with body
  89 of 'subscribe initramfs email@host.com'
  90
  91
  92 Licensed under the GPLv2