1 |
swift 11/12/26 16:00:00 |
2 |
|
3 |
Modified: kernel-config.xml |
4 |
Log: |
5 |
Add information about short-hand notations, use #shorthand to refer to it later |
6 |
|
7 |
Revision Changes Path |
8 |
1.9 xml/htdocs/doc/en/kernel-config.xml |
9 |
|
10 |
file : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/doc/en/kernel-config.xml?rev=1.9&view=markup |
11 |
plain: http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/doc/en/kernel-config.xml?rev=1.9&content-type=text/plain |
12 |
diff : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/doc/en/kernel-config.xml?r1=1.8&r2=1.9 |
13 |
|
14 |
Index: kernel-config.xml |
15 |
=================================================================== |
16 |
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/kernel-config.xml,v |
17 |
retrieving revision 1.8 |
18 |
retrieving revision 1.9 |
19 |
diff -u -r1.8 -r1.9 |
20 |
--- kernel-config.xml 4 Sep 2011 17:53:40 -0000 1.8 |
21 |
+++ kernel-config.xml 26 Dec 2011 15:59:59 -0000 1.9 |
22 |
@@ -1,5 +1,5 @@ |
23 |
<?xml version="1.0" encoding="UTF-8"?> |
24 |
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/kernel-config.xml,v 1.8 2011/09/04 17:53:40 swift Exp $ --> |
25 |
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/kernel-config.xml,v 1.9 2011/12/26 15:59:59 swift Exp $ --> |
26 |
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> |
27 |
|
28 |
<guide> |
29 |
@@ -33,8 +33,8 @@ |
30 |
<!-- See http://creativecommons.org/licenses/by-sa/2.5 --> |
31 |
<license/> |
32 |
|
33 |
-<version>1.4</version> |
34 |
-<date>2010-03-21</date> |
35 |
+<version>2</version> |
36 |
+<date>2011-12-26</date> |
37 |
|
38 |
<chapter> |
39 |
<title>Introduction</title> |
40 |
@@ -508,6 +508,120 @@ |
41 |
</section> |
42 |
</chapter> |
43 |
|
44 |
+<chapter id="shorthand"> |
45 |
+<title>Kernel configuration shorthand notation</title> |
46 |
+<section> |
47 |
+<title>Introduction</title> |
48 |
+<body> |
49 |
+ |
50 |
+<p> |
51 |
+When you read about kernel configurations, you will often see that settings are |
52 |
+described as <c>CONFIG_<something></c>. This short-hand notation is what |
53 |
+the kernel configuration actually uses internally, and is what you will find in |
54 |
+the kernel configuration file (be it <path>/usr/src/linux/.config</path> or in |
55 |
+the auto-generated <path>/proc/config.gz</path> file). Of course, using |
56 |
+short-hand notation wouldn't do much good if you cannot translate this to the |
57 |
+real location in the kernel configuration. Luckily, the <c>make menuconfig</c> |
58 |
+tool allows you to do just that. |
59 |
+</p> |
60 |
+ |
61 |
+</body> |
62 |
+</section> |
63 |
+<section> |
64 |
+<title>Translating CONFIG_FOO to the real configuration location</title> |
65 |
+<body> |
66 |
+ |
67 |
+<p> |
68 |
+Suppose you need to enable <c>CONFIG_TMPFS_XATTR</c>, launch the kernel |
69 |
+configuration menu (<c>make menuconfig</c>) and type in <c>/</c>. This will open |
70 |
+the search box. In this search box, type <c>CONFIG_TMPFS_XATTR</c> (you can even |
71 |
+drop the <c>CONFIG_</c>). The next code listing shows the result of this search. |
72 |
+</p> |
73 |
+ |
74 |
+<pre caption="Result of looking for CONFIG_TMPFS_XATTR"> |
75 |
+Symbol: TMPFS_XATTR [=n] |
76 |
+Type : boolean |
77 |
+Prompt: Tmpfs extended attributes |
78 |
+ Defined at fs/Kconfig:138 |
79 |
+ Depends on: TMPFS [=y] |
80 |
+ Location: |
81 |
+ -> File systems |
82 |
+ -> Pseudo filesystems |
83 |
+ -> Virtual memory file system support (former shm fs) (TMPFS [=y]) |
84 |
+ Selected by: TMPFS_POSIX_ACL [=n] && TMPFS [=y] |
85 |
+</pre> |
86 |
+ |
87 |
+<p> |
88 |
+This output yields lots of interesting information. |
89 |
+</p> |
90 |
+ |
91 |
+<table> |
92 |
+<tr> |
93 |
+ <th>Entry</th> |
94 |
+ <th>Description</th> |
95 |
+</tr> |
96 |
+<tr> |
97 |
+ <ti>Symbol: TMPFS_XATTR [=n]</ti> |
98 |
+ <ti> |
99 |
+ This identifies the kernel configuration entry you are looking for. It also |
100 |
+ already tells you that the setting is currently <e>not enabled</e> ([=n]). |
101 |
+ </ti> |
102 |
+</tr> |
103 |
+<tr> |
104 |
+ <ti>Type: boolean</ti> |
105 |
+ <ti> |
106 |
+ The setting you looked for is a boolean (which means you can enable or |
107 |
+ disable it). Some settings are numbers or strings. |
108 |
+ </ti> |
109 |
+</tr> |
110 |
+<tr> |
111 |
+ <ti>Prompt: Tmpfs extended attributes</ti> |
112 |
+ <ti> |
113 |
+ This is the text you will find in <c>make menuconfig</c> and as such, is the |
114 |
+ entry that you are looking for in a more human readable format. |
115 |
+ </ti> |
116 |
+</tr> |
117 |
+<tr> |
118 |
+ <ti>Depends on: TMPFS [=y]</ti> |
119 |
+ <ti> |
120 |
+ Before you can even see this entry, you need to have <c>CONFIG_TMPFS</c> |
121 |
+ enabled. In this case, this is done (hence the [=y]) but if this is not the |
122 |
+ case, you will first need to look (and enable) <c>CONFIG_TMPFS</c>. |
123 |
+ </ti> |
124 |
+</tr> |
125 |
+<tr> |
126 |
+ <ti>Location: ...</ti> |
127 |
+ <ti> |
128 |
+ This is the location in the <c>make menuconfig</c> structure where you can |
129 |
+ find the setting. Remember, the setting you are looking for is <e>Tmpfs |
130 |
+ extended attributes</e>. |
131 |
+ </ti> |
132 |
+</tr> |
133 |
+<tr> |
134 |
+ <ti>Selected by: TMPFS_POSIX_ACL [=n] && TMPFS [=y]</ti> |
135 |
+ <ti> |
136 |
+ If the settings described here are both enabled (in our case, the first one |
137 |
+ isn't), then <c>CONFIG_TMPFS_XATTR</c> will be automatically enabled as well |
138 |
+ and you will not be able to disable it. |
139 |
+ </ti> |
140 |
+</tr> |
141 |
+</table> |
142 |
+ |
143 |
+<p> |
144 |
+With this information, you should be able to translate any <c>CONFIG_*</c> |
145 |
+requirements tossed at you easily. In short, it means you |
146 |
+</p> |
147 |
+ |
148 |
+<ol> |
149 |
+ <li>need to enable the settings described in the <e>Depends on</e> field</li> |
150 |
+ <li>navigate where <e>Location:</e> points you towards</li> |
151 |
+ <li>toggle the value referred to by <e>Prompt:</e></li> |
152 |
+</ol> |
153 |
+ |
154 |
+</body> |
155 |
+</section> |
156 |
+</chapter> |
157 |
+ |
158 |
<chapter> |
159 |
<title>Other kernel configuration documentation</title> |
160 |
<section> |