-Dracut
+dracut
------
+dracut is an event driven initramfs infrastructure.
-This is the simple skeleton of a new initramfs infrastructure.
-Information about our goals and aims can be found at
-https://fedoraproject.org/wiki/Initrdrewrite
+dracut (the tool) is used to create an initramfs image by copying tools
+and files from an installed system and combining it with the
+dracut framework, usually found in /usr/lib/dracut/modules.d.
Unlike existing initramfs's, this is an attempt at having as little as
possible hard-coded into the initramfs as possible. The initramfs has
the script, but it's worth trying to resist the urge as much as we can
as hooks are guaranteed to be the path to slow-down.
-Most of the initrd generation functionality in dracut is provided by a bunch
+Most of the initramfs generation functionality in dracut is provided by a bunch
of generator modules that are sourced by the main dracut script to install
-specific functionality into the initrd. They live in the modules subdirectory,
-and use functionality provided by dracut-functions to do their work.
+specific functionality into the initramfs. They live in the modules.d
+subdirectory, and use functionality provided by dracut-functions to do their
+work.
+
Some general rules for writing modules:
* Use one of the inst family of functions to actually install files
- on to the initrd. They handle mangling the pathnames and (for binaries,
+ on to the initramfs. They handle mangling the pathnames and (for binaries,
scripts, and kernel modules) installing dependencies as appropriate so
you do not have to.
- * Scripts that end up on the initrd should be POSIX compliant. dracut
- will try to use /bin/dash as /bin/sh for the initrd if it is available,
+ * Scripts that end up on the initramfs should be POSIX compliant. dracut
+ will try to use /bin/dash as /bin/sh for the initramfs if it is available,
so you should install it on your system -- dash aims for strict POSIX
compliance to the extent possible.
* Hooks MUST be POSIX compliant -- they are sourced by the init script,
* Generator modules should have a two digit numeric prefix -- they run in
ascending sort order. Anything in the 90-99 range is stuff that dracut
relies on, so try not to break those hooks.
- * Generator modules and hooks must have a .sh extension.
+ * Hooks must have a .sh extension.
+ * Generator modules are described in more detail in README.modules.
+ * We have some breakpoints for debugging your hooks. If you pass 'rdbreak'
+ as a kernel parameter, the initramfs will drop to a shell just before
+ switching to a new root. You can pass 'rdbreak=hookpoint', and the initramfs
+ will break just before hooks in that hookpoint run.
Also, there is an attempt to keep things as distribution-agnostic as
possible. Every distribution has their own tool here and it's not
something which is really interesting to have separate across them.
So contributions to help decrease the distro-dependencies are welcome.
-The git tree can be found at
-git://fedorapeople.org/~katzj/dracut.git for now. See the TODO
-file for things which still need to be done and HACKING for some
-instructions on how to get started. There is also a mailing list that
-is being used for the discussion -- initramfs@vger.kernel.org. It is
-a typical vger list, send mail to majordomo@vger.kernel.org with body
-of 'subscribe initramfs email@host.com'
+Currently dracut lives on github.com and kernel.org.
+The tarballs can be found here:
+ http://www.kernel.org/pub/linux/utils/boot/dracut/
+ ftp://ftp.kernel.org/pub/linux/utils/boot/dracut/
-Licensed under the GPLv2
+Git:
+ git://git.kernel.org/pub/scm/boot/dracut/dracut.git
+ http://git.kernel.org/pub/scm/boot/dracut/dracut.git
+ https://git.kernel.org/pub/scm/boot/dracut/dracut.git
+
+ git@github.com:dracutdevs/dracut.git
+
+Git Web:
+ https://github.com/dracutdevs/dracut.git
+
+ http://git.kernel.org/?p=boot/dracut/dracut.git
-Copyright 2008, Red Hat, Inc. -- Jeremy Katz <katzj@redhat.com>
+Project Documentation:
+ http://www.kernel.org/pub/linux/utils/boot/dracut/dracut.html
+
+Project Wiki:
+ http://dracut.wiki.kernel.org
+
+See the TODO file for things which still need to be done and HACKING for
+some instructions on how to get started. There is also a mailing list
+that is being used for the discussion -- initramfs@vger.kernel.org.
+It is a typical vger list, send mail to majordomo@vger.kernel.org with body
+of 'subscribe initramfs email@host.com'
+
+
+Licensed under the GPLv2
projects / thirdparty / dracut.git / blobdiff