]> git.ipfire.org Git - thirdparty/dracut.git/blobdiff - README
move setting the "systemdutildir" variable before it's used
[thirdparty/dracut.git] / README
diff --git a/README b/README
index c8a648db03abb80f27b8ae833ca5bbecddb824b6..ff374af864d2d3eeb331446daf711c074e8e7485 100644 (file)
--- a/README
+++ b/README
@@ -1,9 +1,10 @@
-Dracut
+dracut
 ------
-Dracut is a new initramfs infrastructure.
+dracut is an event driven initramfs infrastructure.
 
-Information about the initial 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
@@ -19,17 +20,19 @@ we'll grow some hooks for running arbitrary commands in the flow of
 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,
@@ -39,40 +42,45 @@ Some general rules for writing modules:
    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 'break'
+ * 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 'break=hookpoint', and the initramfs
-   will break just before hooks in that hookpoint run. 
+   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.
 
-Currently dracut lives on sourceforge.
+Currently dracut lives on github.com and kernel.org.
 
-Project Page:
-https://sourceforge.net/projects/dracut/
+The tarballs can be found here:
+       http://www.kernel.org/pub/linux/utils/boot/dracut/
+       ftp://ftp.kernel.org/pub/linux/utils/boot/dracut/
 
-Drop Harald Hoyer <harald@redhat.com> a mail, if you want to help with 
-the documentation, git access, etc.
+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 Repository:
-http://dracut.git.sourceforge.net/
-git://dracut.git.sourceforge.net/gitroot/dracut
+       git@github.com:dracutdevs/dracut.git
 
-Trac Instance:
-http://apps.sourceforge.net/trac/dracut/ 
+Git Web:
+       https://github.com/dracutdevs/dracut.git
 
-The git tree can be found at
-git://dracut.git.sourceforge.net/gitroot/dracut  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' 
+        http://git.kernel.org/?p=boot/dracut/dracut.git
 
+Project Documentation:
+       http://www.kernel.org/pub/linux/utils/boot/dracut/dracut.html
 
-Licensed under the GPLv2
+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'
 
-Copyright 2008,2009, Red Hat, Inc. -- Jeremy Katz <katzj@redhat.com>
+
+Licensed under the GPLv2