]> git.ipfire.org Git - thirdparty/dracut.git/blame - README.md
ci: automate release generation
[thirdparty/dracut.git] / README.md
CommitLineData
ce0344d3
CW
1dracut
2====
7e8f8ddb 3
ce0344d3 4dracut is an event driven initramfs infrastructure.
1363167d 5
3adbcc0b 6[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](docs/CODE_OF_CONDUCT.md)
1363167d 7
ce0344d3
CW
8dracut (the tool) is used to create an initramfs image by copying tools
9and files from an installed system and combining it with the
10dracut framework, usually found in /usr/lib/dracut/modules.d.
11
871d63c3
HH
12Unlike other implementations, dracut hard-codes as little
13as possible into the initramfs. The initramfs has
ce0344d3
CW
14(basically) one purpose in life -- getting the rootfs mounted so that
15we can transition to the real rootfs. This is all driven off of
16device availability. Therefore, instead of scripts hard-coded to do
17various things, we depend on udev to create device nodes for us and
18then when we have the rootfs's device node, we mount and carry on.
19This helps to keep the time required in the initramfs as little as
20possible so that things like a 5 second boot aren't made impossible as
871d63c3 21a result of the very existence of an initramfs.
ce0344d3
CW
22
23Most of the initramfs generation functionality in dracut is provided by a bunch
24of generator modules that are sourced by the main dracut script to install
25specific functionality into the initramfs. They live in the modules.d
26subdirectory, and use functionality provided by dracut-functions to do their
27work.
28
3adbcc0b
LG
29Documentation:
30 - [Introduction](man/dracut.asc)
31 - [User Manual](man/dracut.usage.asc)
ce0344d3 32
3adbcc0b 33Currently dracut is developed on [github.com](https://github.com/dracutdevs/dracut).
ce0344d3 34
3adbcc0b 35The release tarballs are [here](https://github.com/dracutdevs/dracut/releases).
ce0344d3 36
3adbcc0b
LG
37Gitter (chat):
38 - https://gitter.im/dracutdevs/Lobby
ce0344d3 39
3adbcc0b
LG
40See [News](NEWS.md) for information about changes in the releases and
41the [Wiki](https://github.com/dracutdevs/dracut/wiki) to share information.
ce0344d3 42
3adbcc0b 43See the github issue tracker for things which still need to be done and [Hacking](docs/HACKING.md)
1ed4b9f1 44for some instructions on how to get started. There is also a mailing list
ce0344d3
CW
45that is being used for the discussion -- initramfs@vger.kernel.org.
46It is a typical vger list, send mail to majordomo@vger.kernel.org with body
47of 'subscribe initramfs email@host.com'
48
49
50Licensed under the GPLv2