Corrections to doc/en/genkernel.xml
 

Hey there,


the current genkernel docs refer to variables and parameters that do not
exist any more. Please consider applying the attached patch for me.

This table summarizes my changes:

OLD NEW
=============================================
--no-initrdmodules --no-ramdisk-modules
--all-ramdisk-modules

--debuglevel --loglevel
--debugfile --logfile

DEBUGLEVEL LOGLEVEL

Best,



Sebastian

Index: genkernel.xml
================================================== =================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/genkernel.xml,v
retrieving revision 1.31
diff -u -r1.31 genkernel.xml
--- genkernel.xml 23 Jun 2008 05:07:13 -0000 1.31
+++ genkernel.xml 6 Dec 2010 07:56:05 -0000
@@ -16,6 +16,9 @@
<author title="NFS Support">
Thomas Seiler
</author>
+<author title="Contributor">
+ <mail link="sping"/>
+</author>
<author title="Editor">
<mail link="nightmorph"/>
</author>
@@ -27,8 +30,8 @@

<license/>

-<version>1.6</version>
-<date>2008-06-22</date>
+<version>1.7</version>
+<date>2010-12-06</date>

<chapter>
<title>Introduction</title>
@@ -259,12 +262,16 @@
compiled modules will be installed as well.
</li>
<li>
- <b>--<c>no-</c>initrdmodules</b>: Refrains from copying any modules to the
+ <b>--no-ramdisk-modules</b>: Refrains from copying any modules to the
genkernel-created initrd image. This flag is an exception to the rule about
the <c>no-</c> prefix; omission of this prefix creates an invalid genkernel
flag.
</li>
<li>
+ <b>--all-ramdisk-modules</b>: Copies all available modules to the
+ genkernel-created initrd image.
+ </li>
+ <li>
<b>--genzimage</b>: Creates the initrd image, prior to the kernel image.
(This hack currently applies only to PPC Pegasos systems.)
</li>
@@ -348,15 +355,15 @@

<ul>
<li>
- <b>--debuglevel=<c>verblevel</c></b>: Controls the level of verbosity for
+ <b>--loglevel=<c>verblevel</c></b>: Controls the level of verbosity for
information provided by genkernel. The variable <c>verblevel</c> is an
integer between 0 and 5. The level '0' represents minimal output, while '5'
provides as much information as possible about genkernel's activities
during the kernel compilation process.
</li>
<li>
- <b>--debugfile=<path>/path/to/outputfile</path></b>: Ignores the value set
- by the <c>--debuglevel</c> argument, and sends <b>all</b> debugging data
+ <b>--logfile=<path>/path/to/outputfile</path></b>: Ignores the value set
+ by the <c>--loglevel</c> argument, and sends <b>all</b> debugging data
produced by genkernel to the specified output file, which is located at
<path>/var/log/genkernel.log</path> by default.
</li>
@@ -561,7 +568,7 @@
</p>

<pre caption="Running genkernel (overloaded with flags)">
-# <i>genkernel --debuglevel=5 --no-color --no-mrproper --clean --splash
+# <i>genkernel --loglevel=5 --no-color --no-mrproper --clean --splash
--kerneldir=/path/to/alternate/kernel/sources --install --menuconfig
--kernel-config=/path/to/preferred/configfile --save-config --mountboot all</i>
</pre>
@@ -619,10 +626,10 @@
debugging (when needed.)
</li>
<li>
- <b>DEBUGLEVEL=<c>[0|1|2|3|4|5]</c></b>: This option is for adjusting the
+ <b>LOGLEVEL=<c>[0|1|2|3|4|5]</c></b>: This option is for adjusting the
verbosity of the output produced by genkernel &mdash; setting this option to
- '0' with <c>--debuglevel=0</c> will suppress all output produced by
- genkernel; setting this option to '5' with <c>--debuglevel=5</c> provides
+ '0' with <c>--loglevel=0</c> will suppress all output produced by
+ genkernel; setting this option to '5' with <c>--loglevel=5</c> provides
the user with all output produced by genkernel.
</li>
</ul>

Corrections to doc/en/genkernel.xml
 

On Mon, 06 Dec 2010 09:05:32 +0100
Sebastian Pipping <sping@gentoo.org> wrote:

> Hey there,
>
>
> the current genkernel docs refer to variables and parameters that
> do not exist any more. Please consider applying the attached patch
> for me.

Hi, thanks for your patch.

Does it bring the entire doc up-to-date with the latest stable
genkernel version, or do we need to keep the "obsolete" disclaimer in
there?

Corrections to doc/en/genkernel.xml
 

On 12/06/10 12:49, Joshua Saddler wrote:
> Hi, thanks for your patch.

Thanks for applying.


> Does it bring the entire doc up-to-date with the latest stable
> genkernel version, or do we need to keep the "obsolete" disclaimer in
> there?

No, there is so much more work to do, I would rather not mark it as
maintained yet.

The two lists below show what commandline options and config variables
still need mentioning, if we go for completion.
Please not these lists may contain errors, as they are made from a
script of mine.


Options missing:
- arch-override
- bootdir
- bootloader
- busybox-config
- config
- disklabel
- evms
- firmware
- firmware-dir
- firmware-files
- gensplash
- gensplash-res
- initramfs-overlay
- integrated-initramfs
- iscsi
- kerncache
- kernel-cross-compile
- lvm
- mdadm
- minkernpackage
- modulespackage
- multipath
- netboot
- no-busybox
- no-kernel-sources
- no-keymap
- no-mountboot
- no-symlink
- nomenuconfig
- postclear
- real-root
- slowusb
- static
- symlink
- utils-arch
- utils-cross-compile
- version


Variables missing:
- ALLRAMDISKMODULES
- ARCH_OVERRIDE
- BLKID_BINCACHE
- BOOTDIR
- BOOTLOADER
- BUILD_KERNEL
- BUILD_MODULES
- BUILD_RAMDISK
- BUILD_STATIC
- BUSYBOX
- BUSYBOX_BINCACHE
- BUSYBOX_CONFIG
- BUSYBOX_DIR
- BUSYBOX_SRCTAR
- BUSYBOX_VER
- CACHE_DIR
- CLEAR_CACHE_DIR
- DEBUGFILE
- DEFAULT_KERNEL_CONFIG
- DEFAULT_KERNEL_SOURCE
- DEVICE_MAPPER_BINCACHE
- DEVICE_MAPPER_DIR
- DEVICE_MAPPER_SRCTAR
- DEVICE_MAPPER_VER
- DISKLABEL
- DISTDIR
- DMRAID_BINCACHE
- DMRAID_DIR
- DMRAID_SRCTAR
- DMRAID_VER
- DOKEYMAPAUTO
- FIRMWARE
- FIRMWARE_DIR
- FIRMWARE_FILES
- FUSE_BINCACHE
- FUSE_DIR
- FUSE_SRCTAR
- FUSE_VER
- GENZIMAGE
- GK_SHARE
- INITRAMFS_OVERLAY
- INSTALL_MOD_PATH
- INTEGRATED_INITRAMFS
- ISCSI
- ISCSI_BINCACHE
- ISCSI_DIR
- ISCSI_SRCTAR
- ISCSI_VER
- KERNCACHE
- KERNEL_AS
- KERNEL_CC
- KERNEL_CROSS_COMPILE
- KERNEL_DIR
- KERNEL_LD
- KERNEL_MAKE
- KEYMAP
- KNAME
- LOGFILE
- LVM_BINCACHE
- LVM_DIR
- LVM_SRCTAR
- LVM_VER
- MAKEOPTS
- MDADM
- MINKERNPACKAGE
- MODULESPACKAGE
- MULTIPATH
- NETBOOT
- NORAMDISKMODULES
- NO_KERNEL_SOURCES
- OLDCONFIG
- POSTCLEAR
- REAL_ROOT
- SPLASH
- SPLASH_RES
- SPLASH_THEME
- SYMLINK
- TEMP
- TERM_COLUMNS
- TERM_LINES
- TMPDIR
- UNIONFS
- UNIONFS_FUSE_BINCACHE
- UNIONFS_FUSE_DIR
- UNIONFS_FUSE_SRCTAR
- UNIONFS_FUSE_VER
- UTILS_AS
- UTILS_CC
- UTILS_CROSS_COMPILE
- UTILS_LD
- UTILS_MAKE


Best,



Sebastian

Corrections to doc/en/genkernel.xml
 

Here's a patch to update genkernel's actions, as well as fixing a "--no
install" typo.

Please apply.




Sebastian
Index: genkernel.xml
================================================== =================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/genkernel.xml,v
retrieving revision 1.32
diff -u -r1.32 genkernel.xml
--- genkernel.xml 6 Dec 2010 12:00:32 -0000 1.32
+++ genkernel.xml 6 Dec 2010 13:54:47 -0000
@@ -32,7 +32,7 @@
<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>

-<version>2</version>
+<version>3</version>
<date>2010-12-06</date>

<chapter>
@@ -125,7 +125,7 @@

<p>
There are other flags which alter the result provided by genkernel. For
-instance, replacing <c>--no install</c> with the <c>--install</c> flag allows
+instance, replacing <c>--no-install</c> with the <c>--install</c> flag allows
genkernel to automatically install the new kernel in the <path>/boot</path>
directory. Using the <c>--mountboot</c> flag allows genkernel to mount your
<path>/boot</path> partition automatically, if necessary.
@@ -504,12 +504,13 @@
</p>

<ul>
- <li><c>initrd</c>: Only builds the initrd image</li>
- <li><c>bzImage</c>: Only builds the kernel image</li>
- <li><c>kernel</c>: Only builds the kernel image and modules</li>
<li>
<c>all</c>: Builds all stages &mdash; the initrd, kernel image and modules.
</li>
+ <li><c>bzImage</c>: Only builds the kernel image</li>
+ <li><c>initramfs</c>: Only builds the initramfs/ramdisk image</li>
+ <li><c>kernel</c>: Only builds the kernel image and modules</li>
+ <li><c>ramdisk</c>: Only builds the initramfs/ramdisk image</li>
</ul>

<p>

Corrections to doc/en/genkernel.xml
 

On Mon, 06 Dec 2010 14:57:31 +0100
Sebastian Pipping <sping@gentoo.org> wrote:

> + <li><c>initramfs</c>: Only builds the initramfs/ramdisk image</li>
> + <li><c>ramdisk</c>: Only builds the initramfs/ramdisk image</li>

Wait, this makes no sense. Are both options in genkernel? Do they do
the same thing? If so, shouldn't one of them be removed?

Thanks for the rest of your patch; it's applied. I'll wait for your
reply before committing.

Corrections to doc/en/genkernel.xml
 

On 12/06/10 22:23, Joshua Saddler wrote:
> On Mon, 06 Dec 2010 14:57:31 +0100
> Sebastian Pipping <sping@gentoo.org> wrote:
>
>> + <li><c>initramfs</c>: Only builds the initramfs/ramdisk image</li>
>> + <li><c>ramdisk</c>: Only builds the initramfs/ramdisk image</li>
>
> Wait, this makes no sense.

Not so fast :-)


> Are both options in genkernel? Do they do
> the same thing? If so, shouldn't one of them be removed?
>
> Thanks for the rest of your patch; it's applied. I'll wait for your
> reply before committing.

Yes, both are supported in the latest stable release.
You can consider one an alias, see here:
https://bugs.gentoo.org/show_bug.cgi?id=251702#c3

I just noticed you have applied the full patch already. Thanks.

Best,



Sebastian