dracut is an event driven initramfs infrastructure.
-[![Build Status](https://travis-ci.org/dracutdevs/dracut.svg?branch=master)](https://travis-ci.org/dracutdevs/dracut)
-[![Fedora-31](https://github.com/dracutdevs/dracut/workflows/Fedora-31/badge.svg?branch=master)](https://github.com/dracutdevs/dracut/actions?query=workflow%3AFedora-31)
-[![Fedora-32](https://github.com/dracutdevs/dracut/workflows/Fedora-32/badge.svg?branch=master)](https://github.com/dracutdevs/dracut/actions?query=workflow%3AFedora-32)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](docs/CODE_OF_CONDUCT.md)
dracut (the tool) is used to create an initramfs image by copying tools
and files from an installed system and combining it with the
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 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 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,
- and having a bashism break your user's ability to boot really sucks.
- * 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.
- * 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.
+Documentation:
+ - [Introduction](man/dracut.asc)
+ - [User Manual](man/dracut.usage.asc)
-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.
+Currently dracut is developed on [github.com](https://github.com/dracutdevs/dracut).
-Currently dracut lives on github.com and kernel.org.
+The release tarballs are [here](https://github.com/dracutdevs/dracut/releases).
-The tarballs can be found here:
- http://www.kernel.org/pub/linux/utils/boot/dracut/
- ftp://ftp.kernel.org/pub/linux/utils/boot/dracut/
+Gitter (chat):
+ - https://gitter.im/dracutdevs/Lobby
-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
+See [News](NEWS.md) for information about changes in the releases and
+the [Wiki](https://github.com/dracutdevs/dracut/wiki) to share information.
- git@github.com:dracutdevs/dracut.git
-
-Git Web:
- https://github.com/dracutdevs/dracut.git
-
- http://git.kernel.org/?p=boot/dracut/dracut.git
-
-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
+See the github issue tracker for things which still need to be done and [Hacking](docs/HACKING.md)
+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'