Re: Improve init/Kconfig help descriptions [PATCH 5/9]

From: Randy Dunlap
Date: Tue Feb 19 2008 - 15:19:26 EST


On Wed, 20 Feb 2008 01:53:09 +1100 Nick Andrew wrote:

> 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

Those parts are fine. Acked-by: Randy Dunlap <randy.dunlap@xxxxxxxxxx>


Please read http://www.zip.com.au/~akpm/linux/patches/stuff/tpp.txt,
esp. section 2, Subject.


> Changelog:
>
> Improve usefulness and consistency of kernel configuration help messages.
>
> Signed-off-by: Nick Andrew <nick@xxxxxxxxxxxxxxx>
>
>
> --- 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"


---
~Randy
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/