Update the documentation to reflect current status

We only support creating initramfs nowdays, so RAM disk support is not needed.
Since initramfs does not need root=/dev/ram0 (and we actually ignore it if it is set),
we should not tell people to use it.
We should also stop tell people to use real_root.

Conflicts:
	genkernel

Signed-off-by: Robin H. Johnson <robbat2@gentoo.org>

diff --git a/ChangeLog b/ChangeLog
index 10680dad546c004fee067e95949cdf29703a5d39..dfe39e2914244e50748b422724f0750161429789 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -5,6 +5,10 @@
 # Distributed under the GPL v2
 # $Id$
 
+  15 Oct 2012; Peter Hjalmarsson <xake@rymdraket.net> README,
+  doc/genkernel.8.txt, gen_bootloader.sh, genkernel:
+  Update the documentation to reflect current status re real_root/init.
+
   15 Oct 2012; Robin H. Johnson <robbat2@gentoo.org> genkernel:
   Bump to 3.4.44.2 with depmod corner cases by xake.
 

diff --git a/README b/README
index 196e956b9e6aa94e4d70b7ccc39c241273405303..c202a54c66606f0c079b6499fec19ef2868c7912 100644 (file)
--- a/README
+++ b/README
@@ -21,18 +21,13 @@ PORTING:
 
 IMPORTANT KERNEL NOTES:
   - You MUST have /dev/pts turned on.
-    "Block devices->Loopback device support"  
-    "Block devices->RAM disk support"
   - To boot genkernel properly, the kernel config must have
-    RAM disk support and Initial RAM disk support. You should
-    also set your "Default RAM disk size to 8192"
+    Initial RAM disk support.
 
 BOOTING A KERNEL WITH INITRD:
 
   GRUB:
-    real_root= needs to point to your root partition
-    root=      needs to point to the ramdisk (should stay at /dev/ram0)
-    init=      needs to point to the linuxrc file to execute on the ramdisk
+    root=      needs to point to your root partition
     vga=       should be the resolution you want your screen. 0x317 is
                1024x768 - 16bpp and you'll get a pretty splash if
                configured properly
@@ -40,5 +35,5 @@ BOOTING A KERNEL WITH INITRD:
   GRUB EXAMPLE ENTRY:
     title=2.6.0 [ Genkernel ]
     root (hd0,0)
-    kernel (hd0,0)/boot/kernel-2.6.0-gentoo root=/dev/ram0 init=/linuxrc real_root=/dev/hda3 vga=0x317
+    kernel (hd0,0)/boot/kernel-2.6.0-gentoo root=/dev/hda3 vga=0x317
     initrd (hd0,0)/boot/initrd-2.6.0-gentoo

diff --git a/doc/genkernel.8.txt b/doc/genkernel.8.txt
index 0f88334a013e8df03659af29b96d6ef25383558e..dc0424088ae64dfe92da564dc70ab2f4241d8186 100644 (file)
--- a/doc/genkernel.8.txt
+++ b/doc/genkernel.8.txt
@@ -384,9 +384,13 @@ RAMDISK OPTIONS
 The following options can be passed as kernel parameters from the bootloader,
 which the ramdisk scripts would recognize.
 
-*real_root*=<...>::
+*root*=<...>::
     Specifies the device node of the root filesystem to mount.
 
+*real_root*=<...>::
+    Legacy kernel parameter from kernel-2.4 initrd.
+    Does the same as *root*=, which should be used in its place.
+
 *crypt_root*=<...>::
     This specifies the device encrypted by Luks, which contains the
     root filesystem to mount.
@@ -423,9 +427,13 @@ which the ramdisk scripts would recognize.
 *dodmraid*[=<...>]::
     Activate Device-Mapper RAID and (optionally) pass arguments to it.
 
-*real_init*=<...>::
+*init*=<...>::
     Override location of init script, default is "/sbin/init".
 
+*real_init*=<...>::
+    Legacy kernel parameter from kernel-2.4 initrd.
+    Does the same as *init*=, which should be used in its place.
+
 *init_opts*=<...>::
     Passes arguments to init on bootup.
 
@@ -486,10 +494,6 @@ which the ramdisk scripts would recognize.
 *nocache*::
     Enables/disables caching of CD contents in RAM.
 
-*root*=<...>::
-    Omit or specify as "/dev/ram0".
-    For other values be sure to know what you're doing.
-
 *subdir*=<...>::
     switch_root into "<CHROOT>/<SUBDIR>" instead of "<CHROOT>/".
     <CHROOT> is "/newroot" (or "/union") usually.

diff --git a/gen_bootloader.sh b/gen_bootloader.sh
index 5b73d97ef0cbd0f0cd4e2341edce0343ac913a23..7a4f485dce1638dfc719046cedec8a5fe540adc0 100755 (executable)
--- a/gen_bootloader.sh
+++ b/gen_bootloader.sh
@@ -89,11 +89,8 @@ set_bootloader_grub() {
                        # Add grub configuration to grub.conf
                        echo "# Genkernel generated entry, see GRUB documentation for details" >> ${GRUB_CONF}
                        echo "title=Gentoo Linux ($KV)" >> ${GRUB_CONF}
-                       if [ "${BUILD_INITRD}" = '0' ]
-                       then
-                               echo -e "\tkernel /kernel-${KNAME}-${ARCH}-${KV} root=${GRUB_ROOTFS}" >> ${GRUB_CONF}
-                       else
-                               echo -e "\tkernel /kernel-${KNAME}-${ARCH}-${KV} root=/dev/ram0 init=/linuxrc real_root=${GRUB_ROOTFS}" >> ${GRUB_CONF}
+                       echo -e "\tkernel /kernel-${KNAME}-${ARCH}-${KV} root=${GRUB_ROOTFS}" >> ${GRUB_CONF}
+                       if [ "${BUILD_INITRD}" = '1' ]
                                if [ "${PAT}" -gt '4' ]
                                then
                                    echo -e "\tinitrd /initramfs-${KNAME}-${ARCH}-${KV}" >> ${GRUB_CONF}

diff --git a/genkernel b/genkernel
index e84e089a47dc7c4fdfdb1101382aaa25d82af90e..ca634d467c716dd9a22176aa50e1cdbac12d5ff5 100755 (executable)
--- a/genkernel
+++ b/genkernel
@@ -331,23 +331,20 @@ then
        print_info 1 "Kernel compiled successfully!"
        print_info 1 ''
        print_info 1 'Required Kernel Parameters:'
+       print_info 1 '    root=/dev/$ROOT'
        if [ "${BUILD_RAMDISK}" = '0' ]
        then
-               print_info 1 '    root=/dev/$ROOT'
                print_info 1 '    [ And "vga=0x317 splash=verbose" if you use a framebuffer ]'
                print_info 1 ''
                print_info 1 '    Where $ROOT is the device node for your root partition as the'
                print_info 1 '    one specified in /etc/fstab'
        else
-               print_info 1 '    real_root=/dev/$ROOT'
                print_info 1 ''
                print_info 1 '    Where $ROOT is the device node for your root partition as the'
                print_info 1 '    one specified in /etc/fstab'
                print_info 1 ''
                print_info 1 "If you require Genkernel's hardware detection features; you MUST"
-               print_info 1 'tell your bootloader to use the provided INITRAMFS file. Otherwise;'
-               print_info 1 'substitute the root argument for the real_root argument if you are'
-               print_info 1 'not planning to use the initramfs...'
+               print_info 1 'tell your bootloader to use the provided INITRAMFS file.'
        fi
 fi
 
@@ -362,7 +359,7 @@ then
        [ "${MDADM}" = '1' ] && print_warning 1 'add "domdadm" for RAID support'
        [ "${DMRAID}" = '1' ] && print_warning 1 '      or "dodmraid=<additional options>"'
        [ "${ZFS}" = '1' ] && print_warning 1 'add "dozfs" for ZFS volume management support'
-       [ "${ZFS}" = '1' ] && print_warning 1 'add either "real_root=ZFS" (bootfs autodetection) or "real_root=ZFS=<dataset>" to boot from a ZFS dataset'
+       [ "${ZFS}" = '1' ] && print_warning 1 ' and either "root=ZFS" to use bootfs autodetection or "root=ZFS=<dataset>" to force booting from a specific dataset'
        [ "${ISCSI}" = '1' ] && print_warning 1 'add at least "iscsi_initiatorname=<initiator name> iscsi_target=<target name> and iscsi_address=<target ip>" for iscsi support'
 
        if [[ "$(file --brief --mime-type "${KERNEL_CONFIG}")" == application/x-gzip ]]; then