release-notes/FC4 kernel.xml,1.5,1.6

Patrick Barnes nman64 at n-man.com
Tue Jun 7 19:47:02 UTC 2005


Karsten Wade (kwade) wrote:

>Author: kwade
>
>Update of /cvs/docs/release-notes/FC4
>In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv6186
>
>Modified Files:
>	kernel.xml
>Log Message:
>Fixes broken tags during my minor refactoring, indents content.
>
>
>Index: kernel.xml
>===================================================================
>RCS file: /cvs/docs/release-notes/FC4/kernel.xml,v
>retrieving revision 1.5
>retrieving revision 1.6
>diff -u -r1.5 -r1.6
>--- kernel.xml	7 Jun 2005 19:23:54 -0000	1.5
>+++ kernel.xml	7 Jun 2005 19:35:16 -0000	1.6
>@@ -18,9 +18,13 @@
>   <section id="sn-kernel-lotsa">
>     <title>Version</title>
>     <para>
>-      The &DISTRO; is based on a 2.6.11 kernel.
>-      &FC; may include additional patches for improvements, bug fixes, or additional features.
>-      For this reason, the &FC; kernel may not be line-for-line equivalent to the so-called vanilla kernel from the <ulink url="http://ww.kernel.org"><filename>kernel.org</filename></ulink> web site.
>+      The &DISTRO; is based on a 2.6.11 kernel. &FC; may include
>+      additional patches for improvements, bug fixes, or additional
>+      features. For this reason, the &FC; kernel may not be
>+      line-for-line equivalent to the so-called vanilla kernel from the
>+      <ulink
>+	url="http://ww.kernel.org"><filename>kernel.org</filename></ulink>
>
>
ww.kernel.org -> Typo?

>+      web site.
>     </para>
>     <para>
>       You may obtain a list of any such patches by using the command on the &FC; package:
>@@ -37,10 +41,13 @@
>     <itemizedlist>
>       <listitem>
>         <para>
>-          Native kernel, in both uniprocessor and <abbrev>SMP</abbrev> varieties.
>+          Native kernel, in both uniprocessor and <abbrev>SMP</abbrev>
>+	  varieties.
>         </para>
>         <para>
>-          Configured sources are available in the <filename>kernel-devel-<replaceable><version></replaceable>.<replaceable><arch></replaceable>.rpm</filename> package.
>+          Configured sources are available in the
>+	  <filename>kernel-devel-<replaceable><version></replaceable>.<replaceable><arch></replaceable>.rpm</filename>
>+	  package.
>         </para>
>       </listitem>
>       <listitem>
>@@ -48,17 +55,20 @@
>           Virtual kernel for use with the <wordasword>Xen</wordasword> emulator package.
>         </para>
>         <para>
>-          Configured sources are available in the <filename>kernel-xen0-devel-<replaceable><version></replaceable>.<replaceable><arch></replaceable><filename>.rpm</filename> package.
>+          Configured sources are available in the
>+	  <filename>kernel-xen0-devel-<replaceable><version></replaceable>.<replaceable><arch></replaceable>.rpm</filename>
>+	    package.
>         </para>
>       </listitem>
>     </itemizedlist>
>     <para>
>       Sources for both kernel flavors may be installed at the same time.
>-      The files will be installed into the <filename>/usr/src/kernels/<replaceable><version></replaceable>[-xen0]-<replaceable><arch></replaceable>/</filename> tree.
>-      Use the command:
>+      The files will be installed into the
>+      <filename>/usr/src/kernels/<replaceable><version></replaceable>[-xen0]-<replaceable><arch></replaceable>/</filename>
>+      tree. Use the command:
>     </para>
> <screen width="56">
>-<command>rpm</command> <parameter class="option">-Uvh</parameter> <filename>kernel-devel[-xen0]-<replaceable><version></replaceable>.<replaceable><arch></replaceable><filename>.rpm</filename>
>+<command>rpm</command> <parameter class="option">-Uvh</parameter> <filename>kernel-devel[-xen0]-<replaceable><version></replaceable>.<replaceable><arch></replaceable>.rpm</filename>
> </screen>
>     <para>
>       as appropriate.
>@@ -66,9 +76,12 @@
>     <tip>
>       <title>Following Generic Textbooks</title>
>       <para>
>-        Many of the tutorials, examples, and textbooks about Linux kernel development assume the kernel sources are installed under the <filename>/usr/src/linux</filename> directory.
>-        If you make a symbolic link, as shown below, you should be able to use those learning materials with the &FC; packages.
>-        Install the appropriate kernel sources, as shown earlier, and then:
>+        Many of the tutorials, examples, and textbooks about Linux
>+	kernel development assume the kernel sources are installed under
>+	the <filename>/usr/src/linux</filename> directory. If you make a
>+	symbolic link, as shown below, you should be able to use those
>+	learning materials with the &FC; packages. Install the
>+	appropriate kernel sources, as shown earlier, and then:
>       </para>
> <screen width="56">
> <command>ln</command> <parameter class="option">-s</parameter> <filename>/usr/src/kernels/kernel-<replaceable><all-the-rest></replaceable></filename> <filename>/usr/src/linux</filename>
>@@ -95,32 +108,43 @@
>       Preparing for Kernel Development
>     </title>
>     <para>
>-      &DISTRO; &DISTROVER; does not include the <filename>kernel-source</filename> package provided by older versions.
>-      Instead, configured sources are available as described in <xref linkend="sn-kernel-flavors"/>.
>-      Users that require access to &FC; original kernel sources can find them in the <filename>kernel</filename> <filename>.src.rpm</filename> package.
>-      To create an exploded source tree from this file, perform the following steps:
>-  </para>
>-  <warning>
>-    <title>These Instructions Refer to the Currently-running Kernel!</title>
>-    <para>
>-      To simplify the following directions, we have assumed that you want to configure the kernel sources to match your currently-running kernel.
>-      In the steps below, you must understand that the phrase
>-      <wordasword><version></wordasword> refers to the kernel
>-      version shown by this command:
>+      &DISTRO; &DISTROVER; does not include the
>+      <filename>kernel-source</filename> package provided by older
>+      versions. Instead, configured sources are available as described
>+      in <xref
>+	linkend="sn-kernel-flavors"/>. Users that require access to &FC;
>+      original kernel sources can find them in the
>+      <filename>kernel</filename> <filename>.src.rpm</filename> package.
>+      To create an exploded source tree from this file, perform the
>+      following steps:
>     </para>
>+    <important>
>+    <title>These Instructions Refer to the Currently-running Kernel!</title>
>+      <para>
>+	To simplify the following directions, we have assumed that you
>+	want to configure the kernel sources to match your
>+	currently-running kernel. In the steps below, you must
>+	understand that the phrase
>+	<replaceable><version></replaceable> refers to the kernel
>+	version shown by this command:
>+      </para>
> <screen width="56">
> <command>uname</command> <parameter class="option">-r</parameter>
> </screen>
>-  </warning>
>+    </important>
>     <procedure id="sn-kernel-exploding-steps">
>       <step>
>         <para>
>-          Obtain the <filename>kernel-<replaceable><version></replaceable>.src.rpm</filename> file from one of the following sources:
>+          Obtain the
>+	  <filename>kernel-<replaceable><version></replaceable>.src.rpm</filename>
>+	  file from one of the following sources:
>         </para>
>         <itemizedlist>
>           <listitem>
>             <para>
>-                The <filename>SRPMS</filename> directory on the appropriate <wordasword>SRPMS</wordasword> <abbrev>CD</abbrev> <filename>iso</filename> image.
>+	      The <filename>SRPMS</filename> directory on the
>+	      appropriate <wordasword>SRPMS</wordasword>
>+	      <abbrev>CD</abbrev> <filename>iso</filename> image.
>               </para>
>           </listitem>
>           <listitem>
>@@ -141,13 +165,17 @@
>       </step>
>       <step>
>         <para>
>-          Install  <filename>kernel-<replaceable><version></replaceable>.src.rpm</filename> using the command:
>+          Install
>+	  <filename>kernel-<replaceable><version></replaceable>.src.rpm</filename>
>+	  using the command:
>         </para>
> <screen width="56">
> <command>rpm</command> <parameter class="option">-Uvh</parameter> <filename>kernel-<replaceable><version></replaceable>.src.rpm</filename>
> </screen>
>         <para>
>-          This writes the <abbrev>RPM</abbrev> contents into <filename>/usr/src/redhat/SOURCES</filename> and <filename>/usr/src/redhat/SPECS</filename>.
>+          This writes the <abbrev>RPM</abbrev> contents into
>+	  <filename>/usr/src/redhat/SOURCES</filename> and
>+	  <filename>/usr/src/redhat/SPECS</filename>.
>         </para>
>       </step>
>       <step>
>@@ -159,8 +187,13 @@
> <command>rpmbuild</command> <parameter class="option">-bp --target $(arch)</parameter> <filename>kernel.spec</filename>
> </screen>
>         <para>
>-          The kernel source tree will be located in the <filename>/usr/src/redhat/BUILD/kernel-</filename><replaceable><version></replaceable> directory.
>-          It is common practice to move the resulting <filename>linux-</filename><replaceable><version></replaceable> directory to the <filename>/usr/src</filename> tree; while not strictly necessary, we suggest that you do this to match the generally-available documentation.
>+          The kernel source tree will be located in the
>+	  <filename>/usr/src/redhat/BUILD/kernel-</filename><replaceable><version></replaceable>
>+	  directory. It is common practice to move the resulting
>+	  <filename>linux-</filename><replaceable><version></replaceable>
>+	  directory to the <filename>/usr/src</filename> tree; while not
>+	  strictly necessary, we suggest that you do this to match the
>+	  generally-available documentation.
>         </para>
> <screen width="56">
> <command>cd</command> <filename>/usr/src/redhat/BUILD/kernel-<replaceable><version></replaceable></filename> <filename>/usr/src/</filename>
>@@ -172,9 +205,13 @@
>       </step>
>       <step>
>         <para>
>-          The configurations for the specific kernels shipped in &DISTRO; &DISTROVER; are in the <filename>configs/</filename> directory.
>-          For example, the i686 SMP configuration file is named <filename>configs/kernel-<replaceable><version></replaceable>-i686-smp.config</filename>.
>-          Issue the following command to place the desired configuration file in the proper place for building:
>+          The configurations for the specific kernels shipped in
>+	  &DISTRO; &DISTROVER; are in the <filename>configs/</filename>
>+	  directory. For example, the i686 SMP configuration file is
>+	  named
>+	  <filename>configs/kernel-<replaceable><version></replaceable>-i686-smp.config</filename>.
>+	  Issue the following command to place the desired configuration
>+	  file in the proper place for building:
>         </para>
> <screen width="56">
> <command>cp</command> <filename>configs/<replaceable><desired-config-file></replaceable></filename> <filename>.config</filename>
>@@ -196,10 +233,14 @@
>   <section id="sn-kernel-3rdparty">
>     <title>Building Only Kernel Modules</title>
>     <para>
>-      An exploded source tree is <emphasis>not</emphasis> required to build a kernel module, such as your own device driver, against the currently in-use kernel.
>+      An exploded source tree is <emphasis>not</emphasis> required to
>+      build a kernel module, such as your own device driver, against the
>+      currently in-use kernel.
>     </para>
>     <para>
>-      For example, to build the <filename>foo.ko</filename> module, create the following <filename>Makefile</filename> in the directory containing the <filename>foo.c</filename> file:
>+      For example, to build the <filename>foo.ko</filename> module,
>+      create the following <filename>Makefile</filename> in the
>+      directory containing the <filename>foo.c</filename> file:
>     </para>
> <programlisting width="56">
> obj-m := foo.o
>@@ -218,10 +259,20 @@
>   <section id="sn-kernel-coop">
>     <title>Userspace Dependancies on the Kernel</title>
>     <para>
>-      &DISTRO; adds support for clustered systems.
>-      This requires a special kernel that works in conjunction with some user-space utilities, such as management daemons.
>-      Consequently, to remove such a kernel, perhaps after an update, you <emphasis>cannot</emphasis> simply use the <command>rpm -e kernel-<replaceable><version></replaceable></command> command as in earlier distributions because these userspace packages depend on the kernel package.
>-      You may either list both the kernel package and its userspace dependant packages on the <command>rpm -e</command> command, or you may wish to use the <command>yum remove kernel-<replaceable><version></replaceable></command> command instead since <command>yum</command> automatically removes dependant packages if necesssary.
>+      &DISTRO; adds support for clustered systems. This requires a
>+      special kernel that works in conjunction with some user-space
>+      utilities, such as management daemons. Consequently, to remove
>+      such a kernel, perhaps after an update, you
>+      <emphasis>cannot</emphasis> simply use the <command>rpm -e
>+	kernel-<replaceable><version></replaceable></command>
>+      command as in earlier distributions because these userspace
>+      packages depend on the kernel package. You may either list both
>+      the kernel package and its userspace dependant packages on the
>+      <command>rpm -e</command> command, or you may wish to use the
>+      <command>yum remove
>+	kernel-<replaceable><version></replaceable></command>
>+      command instead since <command>yum</command> automatically removes
>+      dependant packages if necesssary.
>     </para>
>   </section>
> </section>
>
>--
>Fedora-docs-commits mailing list
>Fedora-docs-commits at redhat.com
>https://www.redhat.com/mailman/listinfo/fedora-docs-commits
>
>
>
Other than the error in the kernel.org URL, looking good.

--
Patrick "The N-Man" Barnes
nman64 at n-man.com

www.n-man.com
--


-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 189 bytes
Desc: OpenPGP digital signature
URL: <http://listman.redhat.com/archives/fedora-docs-list/attachments/20050607/a21d2178/attachment.sig>


More information about the fedora-docs-list mailing list