From 440eab8fcad723aa7de21eca6411b59b94db0fa0 Mon Sep 17 00:00:00 2001 From: Sebastian Pipping Date: Sat, 4 Jun 2011 02:44:17 +0200 Subject: [PATCH] Document remaining options inside genkernel.conf, e.g. DOKEYMAPAUTO (bug #367233) --- ChangeLog | 4 ++ genkernel.conf | 108 ++++++++++++++++++++++++++++++++++++++ maintenance/docmatcher.py | 6 +++ 3 files changed, 118 insertions(+) diff --git a/ChangeLog b/ChangeLog index b8dcc35..b5aba8d 100644 --- a/ChangeLog +++ b/ChangeLog @@ -5,6 +5,10 @@ # Distributed under the GPL v2 # $Id$ + 04 Jun 2011; Sebastian Pipping genkernel.conf, + maintenance/docmatcher.py: + Document remaining options inside genkiernel.conf (bug #367233) + 01 Jun 2011; Sebastian Pipping defaults/linuxrc, doc/genkernel.8.txt: Document option lvmraid= and make it imply dolvm (bug #153502) diff --git a/genkernel.conf b/genkernel.conf index a5988da..420eb93 100644 --- a/genkernel.conf +++ b/genkernel.conf @@ -42,6 +42,9 @@ USECOLOR="yes" # Clear build cache dir # CLEAR_CACHE_DIR="yes" +# Clear all tmp files and caches after genkernel has run +#POSTCLEAR="1" + # Genkernel uses an independent configuration for MAKEOPTS, and does not source # /etc/make.conf . You can override the default setting by uncommenting and # tweaking the following line. Default setting is set up by @@ -85,6 +88,9 @@ USECOLOR="yes" # Add iSCSI support. # ISCSI="no" +# Include support for unionfs +#UNIONFS="1" + # Enable copying of firmware into initramfs # FIRMWARE="no" # Specify directory to pull from @@ -106,6 +112,17 @@ DISKLABEL="yes" # This supersedes the "SPLASH_THEME" option of /etc/conf.d/splash (in early space). # SPLASH_THEME="gentoo" + +# =========Keymap Settings========= +# +# Force keymap selection at boot +#DOKEYMAPAUTO="yes" + + +# Disables keymap selection support +#KEYMAP="0" + + # =========Low Level Compile Settings========= # # GNU Make to use for kernel. See also the --kernel-make command line option. @@ -138,6 +155,16 @@ DISKLABEL="yes" # option. # UTILS_LD="ld" + +# Common prefix of cros compile commands +#UTILS_CROSS_COMPILE="x86_64-pc-linux-gnu" + + +# Value of CROSS_COMPILE utils variable +# during kernel compilation +#KERNEL_CROSS_COMPILE="x86_64-pc-linux-gnu" + + # =========GENKERNEL LOCATION CONFIGURATION============ # Variables: # %%ARCH%% - Final determined architecture @@ -161,12 +188,17 @@ LOGFILE="/var/log/genkernel.log" # Debug Level LOGLEVEL=1 +# =========COMPILED UTILS CONFIGURATION============ +# # Default location of kernel source DEFAULT_KERNEL_SOURCE="/usr/src/linux" # Default kernel config (only use to override using # arch/%%ARCH%%/kernel-config-${VER}.${PAT} !) # DEFAULT_KERNEL_CONFIG="${GK_SHARE}/arch/%%ARCH%%/kernel-config" +# Specifies a user created busybox config +#BUSYBOX_CONFIG="/path/to/file" + BUSYBOX_VER="VERSION_BUSYBOX" BUSYBOX_SRCTAR="${DISTDIR}/busybox-${BUSYBOX_VER}.tar.bz2" BUSYBOX_DIR="busybox-${BUSYBOX_VER}" @@ -217,3 +249,79 @@ GPG_VER="VERSION_GPG" GPG_DIR="gnupg-${GPG_VER}" GPG_SRCTAR="${DISTDIR}/gnupg-${GPG_VER}.tar.bz2" GPG_BINCACHE="%%CACHE%%/gnupg-${GPG_VER}-%%ARCH%%.bz2" + + +# =========MISC KERNEL CONFIGURATION============ +# +# Tag the kernel and ramdisk with a name: +# If not defined the option defaults to +# 'genkernel' +#KNAME="genkernel" + + +# This option is only valid if kerncache is +# defined. If there is a valid kerncache no checks +# will be made against a kernel source tree +#NO_KERNEL_SOURCES="1" + + +# Build a static (monolithic kernel) +#BUILD_STATIC="1" + + +# Make and install kernelz image (PowerPC) +#GENZIMAGE="1" + + +# File to output a .tar.bz2'd kernel contents +# of /lib/modules/ and the kernel config +# NOTE: This is created before the callbacks +# are run! +#KERNCACHE="/path/to/file" + + +# Prefix to kernel module destination, modules +# will be installed in /lib/modules +# (.conf equivalent of --module-prefix=) +#INSTALL_MOD_PATH="" + + +# =========MISC INITRD CONFIGURATION============ +# +# Copy all kernel modules to the ramdisk +#ALLRAMDISKMODULES="1" + + +# Don't copy any modules to the ramdisk +#NORAMDISKMODULES="1" + + +# File to output a .tar.bz2'd kernel and ramdisk: +# No modules outside of the ramdisk will be +# included... +#MINKERNPACKAGE="/path/to/file.bz2" + + +# File to output a .tar.bz2'd modules after the +# callbacks have run +#MODULESPACKAGE="/path/to/file.bz2" + + +# Directory structure to include in the initramfs, +# only available on >=2.6 kernels +#INITRAMFS_OVERLAY="" + + +# Build the generated initramfs into the kernel instead of +# keeping it as a separate file +#INTEGRATED_INITRAMFS="1" + + +# Create a self-contained env in the initramfs +#NETBOOT="1" + + +# =========MISC BOOT CONFIGURATION============ +# +# Specify a default for real_root= +#REAL_ROOT="/dev/one/two/gentoo" diff --git a/maintenance/docmatcher.py b/maintenance/docmatcher.py index f215c5a..848774a 100644 --- a/maintenance/docmatcher.py +++ b/maintenance/docmatcher.py @@ -14,6 +14,10 @@ NON_VARIABLES = ('UTF', 'USE', 'TCP', 'SMP', 'PXE', 'PPC', 'MAC', 'TFTP', 'SYSTEM', 'SPARC', 'RAID', 'LABEL', 'PROMPT', 'KERNEL', 'GRP', 'DOCTYPE', 'DHCP', 'DEFAULT', 'ATARAID', 'APPEND') +NON_CONFIG_VARIABLES = ('BUILD_KERNEL', 'BUILD_MODULES', 'BUILD_RAMDISK', + 'TERM_COLUMNS', 'TERM_LINES', 'SPLASH_RES', 'TEMP') + + EXTRA_VARIABLES = ['ARCH_OVERRIDE', 'BOOTLOADER', 'CLEAR_CACHE_DIR', 'DEFAULT_KERNEL_SOURCE', 'DISTDIR', 'GK_SHARE', 'BUSYBOX_APPLETS'] for app in ('DEVICE_MAPPER', 'UNIONFS_FUSE', 'BUSYBOX', 'DMRAID', 'LVM', 'ISCSI', 'FUSE', 'GPG', 'MDADM'): for prop in ('DIR', 'SRCTAR', 'VER'): @@ -67,6 +71,8 @@ def exract_gen_cmdline_sh(): var_name = match.group(1) if var_name.startswith('CMD_'): continue + if var_name in NON_CONFIG_VARIABLES: + continue gen_cmdline_sh_variables.add(var_name) del parsing_code -- 2.26.2