* [gentoo-doc-cvs] gentoo commit in xml/htdocs/doc/en: kernel-config.xml
@ 2011-12-26 16:00 Sven Vermeulen (swift)
0 siblings, 0 replies; 3+ messages in thread
From: Sven Vermeulen (swift) @ 2011-12-26 16:00 UTC (permalink / raw
To: gentoo-doc-cvs
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/kernel-config.xml?rev=1.9&view=markup
plain: http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/doc/en/kernel-config.xml?rev=1.9&content-type=text/plain
diff : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/doc/en/kernel-config.xml?r1=1.8&r2=1.9
Index: kernel-config.xml
===================================================================
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 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/kernel-config.xml,v 1.8 2011/09/04 17:53:40 swift Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/kernel-config.xml,v 1.9 2011/12/26 15:59:59 swift Exp $ -->
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<guide>
@@ -33,8 +33,8 @@
<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>
-<version>1.4</version>
-<date>2010-03-21</date>
+<version>2</version>
+<date>2011-12-26</date>
<chapter>
<title>Introduction</title>
@@ -508,6 +508,120 @@
</section>
</chapter>
+<chapter id="shorthand">
+<title>Kernel configuration shorthand notation</title>
+<section>
+<title>Introduction</title>
+<body>
+
+<p>
+When you read about kernel configurations, you will often see that settings are
+described as <c>CONFIG_<something></c>. This short-hand notation is what
+the kernel configuration actually uses internally, and is what you will find in
+the kernel configuration file (be it <path>/usr/src/linux/.config</path> or in
+the auto-generated <path>/proc/config.gz</path> file). Of course, using
+short-hand notation wouldn't do much good if you cannot translate this to the
+real location in the kernel configuration. Luckily, the <c>make menuconfig</c>
+tool allows you to do just that.
+</p>
+
+</body>
+</section>
+<section>
+<title>Translating CONFIG_FOO to the real configuration location</title>
+<body>
+
+<p>
+Suppose you need to enable <c>CONFIG_TMPFS_XATTR</c>, launch the kernel
+configuration menu (<c>make menuconfig</c>) and type in <c>/</c>. This will open
+the search box. In this search box, type <c>CONFIG_TMPFS_XATTR</c> (you can even
+drop the <c>CONFIG_</c>). The next code listing shows the result of this search.
+</p>
+
+<pre caption="Result of looking for CONFIG_TMPFS_XATTR">
+Symbol: TMPFS_XATTR [=n]
+Type : boolean
+Prompt: Tmpfs extended attributes
+ Defined at fs/Kconfig:138
+ Depends on: TMPFS [=y]
+ Location:
+ -> File systems
+ -> Pseudo filesystems
+ -> Virtual memory file system support (former shm fs) (TMPFS [=y])
+ Selected by: TMPFS_POSIX_ACL [=n] && TMPFS [=y]
+</pre>
+
+<p>
+This output yields lots of interesting information.
+</p>
+
+<table>
+<tr>
+ <th>Entry</th>
+ <th>Description</th>
+</tr>
+<tr>
+ <ti>Symbol: TMPFS_XATTR [=n]</ti>
+ <ti>
+ This identifies the kernel configuration entry you are looking for. It also
+ already tells you that the setting is currently <e>not enabled</e> ([=n]).
+ </ti>
+</tr>
+<tr>
+ <ti>Type: boolean</ti>
+ <ti>
+ The setting you looked for is a boolean (which means you can enable or
+ disable it). Some settings are numbers or strings.
+ </ti>
+</tr>
+<tr>
+ <ti>Prompt: Tmpfs extended attributes</ti>
+ <ti>
+ This is the text you will find in <c>make menuconfig</c> and as such, is the
+ entry that you are looking for in a more human readable format.
+ </ti>
+</tr>
+<tr>
+ <ti>Depends on: TMPFS [=y]</ti>
+ <ti>
+ Before you can even see this entry, you need to have <c>CONFIG_TMPFS</c>
+ enabled. In this case, this is done (hence the [=y]) but if this is not the
+ case, you will first need to look (and enable) <c>CONFIG_TMPFS</c>.
+ </ti>
+</tr>
+<tr>
+ <ti>Location: ...</ti>
+ <ti>
+ This is the location in the <c>make menuconfig</c> structure where you can
+ find the setting. Remember, the setting you are looking for is <e>Tmpfs
+ extended attributes</e>.
+ </ti>
+</tr>
+<tr>
+ <ti>Selected by: TMPFS_POSIX_ACL [=n] && TMPFS [=y]</ti>
+ <ti>
+ If the settings described here are both enabled (in our case, the first one
+ isn't), then <c>CONFIG_TMPFS_XATTR</c> will be automatically enabled as well
+ and you will not be able to disable it.
+ </ti>
+</tr>
+</table>
+
+<p>
+With this information, you should be able to translate any <c>CONFIG_*</c>
+requirements tossed at you easily. In short, it means you
+</p>
+
+<ol>
+ <li>need to enable the settings described in the <e>Depends on</e> field</li>
+ <li>navigate where <e>Location:</e> points you towards</li>
+ <li>toggle the value referred to by <e>Prompt:</e></li>
+</ol>
+
+</body>
+</section>
+</chapter>
+
<chapter>
<title>Other kernel configuration documentation</title>
<section>
^ permalink raw reply [flat|nested] 3+ messages in thread
* [gentoo-doc-cvs] gentoo commit in xml/htdocs/doc/en: kernel-config.xml
@ 2012-12-16 20:48 Sven Vermeulen (swift)
0 siblings, 0 replies; 3+ messages in thread
From: Sven Vermeulen (swift) @ 2012-12-16 20:48 UTC (permalink / raw
To: gentoo-doc-cvs
swift 12/12/16 20:48:45
Modified: kernel-config.xml
Log:
Fix bug #445356 - Use multicore instead of dualcore, and refer to bluetooth wiki article directly. Thanks to Francesco Turco for reporting.
Revision Changes Path
1.10 xml/htdocs/doc/en/kernel-config.xml
file : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/doc/en/kernel-config.xml?rev=1.10&view=markup
plain: http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/doc/en/kernel-config.xml?rev=1.10&content-type=text/plain
diff : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/doc/en/kernel-config.xml?r1=1.9&r2=1.10
Index: kernel-config.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/kernel-config.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- kernel-config.xml 26 Dec 2011 15:59:59 -0000 1.9
+++ kernel-config.xml 16 Dec 2012 20:48:45 -0000 1.10
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/kernel-config.xml,v 1.9 2011/12/26 15:59:59 swift Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/kernel-config.xml,v 1.10 2012/12/16 20:48:45 swift Exp $ -->
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<guide>
@@ -33,8 +33,8 @@
<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>
-<version>2</version>
-<date>2011-12-26</date>
+<version>3</version>
+<date>2012-12-16</date>
<chapter>
<title>Introduction</title>
@@ -424,7 +424,7 @@
</body>
</section>
<section>
-<title>Multiprocessor, Hyper-Threading and Dual Core systems</title>
+<title>Multiprocessor, Hyper-Threading and Multi-Core systems</title>
<body>
<p>
@@ -440,9 +440,10 @@
<e>logical</e> processors.
</li>
<li>
- Some of the most recent Intel/AMD CPUs actually consist of multiple
- physical processors inside a single package, these are known as <uri
- link="http://en.wikipedia.org/wiki/Dual_core">dual core</uri> processors.
+ Most Intel/AMD CPUs actually consist of multiple physical processors
+ inside a single package, these are known as <uri
+ link="http://en.wikipedia.org/wiki/Multi-core_processor">multi-core</uri>
+ processors.
</li>
<li>
Some high-end computer systems actually have multiple physical processors
@@ -464,7 +465,7 @@
[*] SMT (Hyperthreading) scheduler support
<comment>Select the above option if you are on an Intel Hyper-Threading CPU</comment>
[*] Multi-core scheduler support (NEW)
- <comment>Select the above option if your CPU is dual core</comment>
+ <comment>Select the above option if your CPU is multi-core</comment>
Power management and ACPI options --->
[*] ACPI (Advanced Configuration and Power Interface) Support
<comment>The above option not only enables power management features, but might
@@ -649,8 +650,9 @@
ALSA is actually much easier to configure when the components are modular.
</li>
<li>
- The <uri link="/doc/en/bluetooth-guide.xml">Bluetooth Guide</uri> details
- the options you need in order to use bluetooth devices on your system.
+ The <uri link="https://wiki.gentoo.org/wiki/Bluetooth">Bluetooth</uri> wiki
+ article details the options you need in order to use bluetooth devices on
+ your system.
</li>
<li>
The <uri link="/doc/en/ipv6.xml">IPv6 Router Guide</uri> describes how to
^ permalink raw reply [flat|nested] 3+ messages in thread* [gentoo-doc-cvs] gentoo commit in xml/htdocs/doc/en: kernel-config.xml
@ 2010-03-21 11:47 Jan Kundrat (jkt)
0 siblings, 0 replies; 3+ messages in thread
From: Jan Kundrat (jkt) @ 2010-03-21 11:47 UTC (permalink / raw
To: gentoo-doc-cvs
jkt 10/03/21 11:47:52
Modified: kernel-config.xml
Log:
#310313, ACPI support is required for SMP on certain Atom CPUs
Enabling power management features is a good option nevertheless.
Revision Changes Path
1.7 xml/htdocs/doc/en/kernel-config.xml
file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/kernel-config.xml?rev=1.7&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/kernel-config.xml?rev=1.7&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/kernel-config.xml?r1=1.6&r2=1.7
Index: kernel-config.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/kernel-config.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- kernel-config.xml 22 Jun 2008 01:57:09 -0000 1.6
+++ kernel-config.xml 21 Mar 2010 11:47:52 -0000 1.7
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/kernel-config.xml,v 1.6 2008/06/22 01:57:09 nightmorph Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/kernel-config.xml,v 1.7 2010/03/21 11:47:52 jkt Exp $ -->
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<guide link="/doc/en/kernel-config.xml">
@@ -33,8 +33,8 @@
<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>
-<version>1.3</version>
-<date>2008-06-21</date>
+<version>1.4</version>
+<date>2010-03-21</date>
<chapter>
<title>Introduction</title>
@@ -465,6 +465,10 @@
<comment>Select the above option if you are on an Intel Hyper-Threading CPU</comment>
[*] Multi-core scheduler support (NEW)
<comment>Select the above option if your CPU is dual core</comment>
+Power management and ACPI options --->
+ [*] ACPI (Advanced Configuration and Power Interface) Support
+ <comment>The above option not only enables power management features, but might
+ also be a requirement for making all CPUs available to your system</comment>
</pre>
</body>
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2012-12-16 21:02 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2011-12-26 16:00 [gentoo-doc-cvs] gentoo commit in xml/htdocs/doc/en: kernel-config.xml Sven Vermeulen (swift)
-- strict thread matches above, loose matches on Subject: below --
2012-12-16 20:48 Sven Vermeulen (swift)
2010-03-21 11:47 Jan Kundrat (jkt)
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox