From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from pigeon.gentoo.org ([208.92.234.80] helo=lists.gentoo.org) by finch.gentoo.org with esmtp (Exim 4.60) (envelope-from ) id 1RfCy9-0003LZ-Ku for garchives@archives.gentoo.org; Mon, 26 Dec 2011 16:00:09 +0000 Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 5B2CD21C0C7; Mon, 26 Dec 2011 16:00:02 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) by pigeon.gentoo.org (Postfix) with ESMTP id 1A42321C0C7 for ; Mon, 26 Dec 2011 16:00:02 +0000 (UTC) Received: from flycatcher.gentoo.org (flycatcher.gentoo.org [81.93.255.6]) (using TLSv1 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id 4A9711B400F for ; Mon, 26 Dec 2011 16:00:01 +0000 (UTC) Received: by flycatcher.gentoo.org (Postfix, from userid 617) id 1404420033; Mon, 26 Dec 2011 16:00:00 +0000 (UTC) From: "Sven Vermeulen (swift)" To: gentoo-doc-cvs@lists.gentoo.org Subject: [gentoo-doc-cvs] gentoo commit in xml/htdocs/doc/en: kernel-config.xml X-VCS-Repository: gentoo X-VCS-Files: kernel-config.xml X-VCS-Directories: xml/htdocs/doc/en X-VCS-Committer: swift X-VCS-Committer-Name: Sven Vermeulen Content-Type: text/plain; charset=utf8 Message-Id: <20111226160000.1404420033@flycatcher.gentoo.org> Date: Mon, 26 Dec 2011 16:00:00 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-doc-cvs@lists.gentoo.org Reply-to: docs-team@lists.gentoo.org Content-Transfer-Encoding: quoted-printable X-Archives-Salt: 8c5f77a3-e5f8-499f-8604-b79c8fb4d330 X-Archives-Hash: e1bf24297e27c2378beed985e0e377d6 swift 11/12/26 16:00:00 Modified: kernel-config.xml Log: Add information about short-hand notations, use #shorthand to refer to = it later Revision Changes Path 1.9 xml/htdocs/doc/en/kernel-config.xml file : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/doc/en/kern= el-config.xml?rev=3D1.9&view=3Dmarkup plain: http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/doc/en/kern= el-config.xml?rev=3D1.9&content-type=3Dtext/plain diff : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/doc/en/kern= el-config.xml?r1=3D1.8&r2=3D1.9 Index: kernel-config.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/kernel-config.xml,v retrieving revision 1.8 retrieving revision 1.9 diff -u -r1.8 -r1.9 --- kernel-config.xml 4 Sep 2011 17:53:40 -0000 1.8 +++ kernel-config.xml 26 Dec 2011 15:59:59 -0000 1.9 @@ -1,5 +1,5 @@ - + =20 @@ -33,8 +33,8 @@ =20 -1.4 -2010-03-21 +2 +2011-12-26 =20 Introduction @@ -508,6 +508,120 @@ =20 + +Kernel configuration shorthand notation +
+Introduction + + +

+When you read about kernel configurations, you will often see that setti= ngs are +described as CONFIG_<something>. This short-hand notation i= s what +the kernel configuration actually uses internally, and is what you will = find in +the kernel configuration file (be it /usr/src/linux/.config= or in +the auto-generated /proc/config.gz file). Of course, using +short-hand notation wouldn't do much good if you cannot translate this t= o the +real location in the kernel configuration. Luckily, the make menuconf= ig +tool allows you to do just that. +

+ + +
+
+Translating CONFIG_FOO to the real configuration location + + +

+Suppose you need to enable CONFIG_TMPFS_XATTR, launch the kernel +configuration menu (make menuconfig) and type in /. This w= ill open +the search box. In this search box, type CONFIG_TMPFS_XATTR (you = can even +drop the CONFIG_). The next code listing shows the result of this= search. +

+ +
+Symbol: TMPFS_XATTR [=3Dn]
+Type  : boolean
+Prompt: Tmpfs extended attributes
+  Defined at fs/Kconfig:138
+  Depends on: TMPFS [=3Dy]
+  Location:
+    -> File systems
+      -> Pseudo filesystems
+        -> Virtual memory file system support (former shm fs) (TMPFS [=3D=
y])
+  Selected by: TMPFS_POSIX_ACL [=3Dn] && TMPFS [=3Dy]
+
+ +

+This output yields lots of interesting information. +

+ + + + + + + + Symbol: TMPFS_XATTR [=3Dn] + + This identifies the kernel configuration entry you are looking for. = It also + already tells you that the setting is currently not enabled (= [=3Dn]). + + + + Type: boolean + + The setting you looked for is a boolean (which means you can enable = or + disable it). Some settings are numbers or strings. + + + + Prompt: Tmpfs extended attributes + + This is the text you will find in make menuconfig and as such= , is the + entry that you are looking for in a more human readable format. + + + + Depends on: TMPFS [=3Dy] + + Before you can even see this entry, you need to have CONFIG_TMPFS= + enabled. In this case, this is done (hence the [=3Dy]) but if this i= s not the + case, you will first need to look (and enable) CONFIG_TMPFS. + + + + Location: ... + + This is the location in the make menuconfig structure where y= ou can + find the setting. Remember, the setting you are looking for is Tm= pfs + extended attributes. + + + + Selected by: TMPFS_POSIX_ACL [=3Dn] && TMPFS [=3Dy] + + If the settings described here are both enabled (in our case, the fi= rst one + isn't), then CONFIG_TMPFS_XATTR will be automatically enabled= as well + and you will not be able to disable it. + + +
EntryDescription
+ +

+With this information, you should be able to translate any CONFIG_* +requirements tossed at you easily. In short, it means you +

+ +
    +
  1. need to enable the settings described in the Depends on fie= ld
  2. +
  3. navigate where Location: points you towards
  4. +
  5. toggle the value referred to by Prompt:
  6. +
+ + +
+
+ Other kernel configuration documentation