From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1758906AbYBSOxt (ORCPT ); Tue, 19 Feb 2008 09:53:49 -0500 Received: (majordomo@vger.kernel.org) by vger.kernel.org id S1753471AbYBSOxl (ORCPT ); Tue, 19 Feb 2008 09:53:41 -0500 Received: from yoi5.greathalifaxhome.com ([66.180.172.116]:53304 "HELO vps1.tull.net" rhost-flags-OK-FAIL-OK-OK) by vger.kernel.org with SMTP id S1752728AbYBSOxj (ORCPT ); Tue, 19 Feb 2008 09:53:39 -0500 X-Spam-Check-By: mail.local.tull.net Date: Wed, 20 Feb 2008 01:53:09 +1100 From: Nick Andrew To: trivial@kernel.org Cc: linux-kernel@vger.kernel.org Subject: Improve init/Kconfig help descriptions [PATCH 5/9] Message-ID: <20080219145309.GC27352@tull.net> References: <20080219140609.GA26619@tull.net> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20080219140609.GA26619@tull.net> User-Agent: Mutt/1.5.17+20080114 (2008-01-14) X-SMTPD: qpsmtpd/0.26, http://develooper.com/code/qpsmtpd/ Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Wed, Feb 20, 2008 at 01:06:09AM +1100, Nick Andrew wrote: > Here is a series of 9 patches to init/Kconfig intended to improve the > usefulness and consistency of the help descriptions. The patches are > against linux-2.6.24.2. > [...] > Patch 5 > IKCONFIG > IKCONFIG_PROC > LOG_BUF_SHIFT > SYSFS_DEPRECATED > RELAY > BLK_DEV_INITRD Changelog: Improve usefulness and consistency of kernel configuration help messages. Signed-off-by: Nick Andrew --- a/init/Kconfig 2008-02-20 00:45:07.000000000 +1100 +++ b/init/Kconfig 2008-02-20 00:52:07.000000000 +1100 @@ -254,20 +254,30 @@ config IKCONFIG tristate "Kernel .config support" ---help--- This option enables the complete Linux kernel ".config" file - contents to be saved in the kernel. It provides documentation - of which kernel options are used in a running kernel or in an - on-disk kernel. This information can be extracted from the kernel - image file with the script scripts/extract-ikconfig and used as - input to rebuild the current kernel or to build another kernel. - It can also be extracted from a running kernel by reading - /proc/config.gz if enabled (below). + contents to be saved in the kernel. + + It provides documentation of which kernel options are used in + a running kernel or in an on-disk kernel. This information + can be extracted from the kernel image file with the script + "scripts/extract-ikconfig" and used as input to rebuild the + current kernel or to build another kernel. + + It can also be extracted from a running kernel with + "zcat /proc/config.gz" if CONFIG_IKCONFIG_PROC is enabled + below. + + Your kernel size will increase by around 14k. + + If unsure, say N. config IKCONFIG_PROC bool "Enable access to .config through /proc/config.gz" depends on IKCONFIG && PROC_FS ---help--- - This option enables access to the kernel configuration file - through /proc/config.gz. + This option enables access to the configuration of the running + kernel through /proc/config.gz. + + If unsure, say Y. config LOG_BUF_SHIFT int "Kernel log buffer size (16 => 64KB, 17 => 128KB)" @@ -277,14 +287,15 @@ config LOG_BUF_SHIFT default 15 if SMP default 14 help - Select kernel log buffer size as a power of 2. - Defaults and Examples: + Select the kernel log buffer size as a power of 2. + + Defaults and examples: 17 => 128 KB for S/390 - 16 => 64 KB for x86 NUMAQ or IA-64 - 15 => 32 KB for SMP - 14 => 16 KB for uniprocessor - 13 => 8 KB - 12 => 4 KB + 16 => 64 KB for x86 NUMAQ or IA-64 + 15 => 32 KB for SMP + 14 => 16 KB for uniprocessor + 13 => 8 KB + 12 => 4 KB config CGROUPS bool "Control Group support" @@ -389,11 +400,14 @@ config PROC_PID_CPUSET config RELAY bool "Kernel->user space relay support (formerly relayfs)" help - This option enables support for relay interface support in + This option enables support for the relay interface in certain file systems (such as debugfs). + It is designed to provide an efficient mechanism for tools and facilities to relay large amounts of data from kernel space to - user space. + userspace. + + See for more information. If unsure, say N. @@ -401,17 +415,24 @@ config BLK_DEV_INITRD bool "Initial RAM filesystem and RAM disk (initramfs/initrd) support" depends on BROKEN || !FRV help + Enable use of an initial RAM filesystem or RAM disk at boot + time. + The initial RAM filesystem is a ramfs which is loaded by the - boot loader (loadlin or lilo) and that is mounted as root + boot loader (loadlin, lilo, grub) and is mounted as root before the normal boot procedure. It is typically used to load modules needed to mount the "real" root file system, - etc. See for details. + etc. + + For more information, see: + + If RAM disk support (BLK_DEV_RAM) is also included, this also enables initial RAM disk (initrd) support and adds 15 Kbytes (more on some other architectures) to the kernel size. - If unsure say Y. + If unsure, say Y. if BLK_DEV_INITRD