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

Karsten Wade (kwade) fedora-docs-commits at redhat.com
Tue Jun 7 19:23:56 UTC 2005


Author: kwade

Update of /cvs/docs/release-notes/FC4
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv6131

Modified Files:
	kernel.xml 
Log Message:
These should be the real changes to kernel.xml, and I'll do the line formating changes separately.  Note the changes in how <screen> is used, dropping of <prompt>, and how <filename> wraps <replaceable> content.  IIRC, these are our style uses.


Index: kernel.xml
===================================================================
RCS file: /cvs/docs/release-notes/FC4/kernel.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- kernel.xml	30 May 2005 23:27:45 -0000	1.4
+++ kernel.xml	7 Jun 2005 19:23:54 -0000	1.5
@@ -25,7 +25,9 @@
     <para>
       You may obtain a list of any such patches by using the command on the &FC; package:
     </para>
-    <screen width="56"><prompt>$ </prompt><command>rpm</command> <parameter class="option">-qpl</parameter> <filename>kernel-</filename><replaceable><version></replaceable><filename>.src.rpm</filename></screen>
+<screen width="56">
+<command>rpm</command> <parameter class="option">-qpl</parameter> <filename>kernel-<replaceable><version></replaceable>.src.rpm</filename>
+</screen>
   </section>
   <section id="sn-kernel-flavors">
     <title>Kernel Flavors</title>
@@ -38,24 +40,26 @@
           Native kernel, in both uniprocessor and <abbrev>SMP</abbrev> varieties.
         </para>
         <para>
-          Configured sources are available in the <filename>kernel-devel-</filename><replaceable><version></replaceable><filename>.</filename><replaceable><arch></replaceable><filename>.rpm</filename> package.
+          Configured sources are available in the <filename>kernel-devel-<replaceable><version></replaceable>.<replaceable><arch></replaceable>.rpm</filename> package.
         </para>
       </listitem>
       <listitem>
         <para>
-          Virtual kernel for use with the <wordasword>XEN</wordasword> emulator package.
+          Virtual kernel for use with the <wordasword>Xen</wordasword> emulator package.
         </para>
         <para>
-          Configured sources are available in the <filename>kernel-xen0-devel-</filename><replaceable><version></replaceable><filename>.</filename><replaceable><arch></replaceable><filename>.rpm</filename> package.
+          Configured sources are available in the <filename>kernel-xen0-devel-<replaceable><version></replaceable>.<replaceable><arch></replaceable><filename>.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/</filename><replaceable><version></replaceable>[<filename>-xen0</filename>]<filename>-</filename><replaceable><arch></replaceable><filename>/</filename> tree.
+      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"><prompt># </prompt><command>rpm</command> <parameter class="option">-Uvh</parameter> <filename>kernel-devel[-xen0]-</filename><replaceable><version></replaceable><filename>.</filename><replaceable><arch></replaceable><filename>.rpm</filename></screen>
+<screen width="56">
+<command>rpm</command> <parameter class="option">-Uvh</parameter> <filename>kernel-devel[-xen0]-<replaceable><version></replaceable>.<replaceable><arch></replaceable><filename>.rpm</filename> 
+</screen>
     <para>
       as appropriate.
     </para>
@@ -66,7 +70,9 @@
         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"><prompt># </prompt><command>ln</command> <parameter class="option">-s</parameter> <filename>/usr/src/kernels/kernel-</filename><replaceable><all-the-rest></replaceable> <filename>/usr/src/linux</filename></screen>
+<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>
+</screen>
     </tip>
   </section>
   <!--
@@ -95,15 +101,16 @@
       To create an exploded source tree from this file, perform the following steps:
   </para>
   <warning>
-    <title>These Instructions Refer The Currently-running Kernel!</title>
+    <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 the:
-    </para>
-    <screen width="56"><prompt>$ </prompt><command>uname</command> <parameter class="option">-r</parameter></screen>
-    <para>
-      command.
-    </para>
+      In the steps below, you must understand that the phrase
+      <wordasword><version></wordasword> refers to the kernel
+      version shown by this command:
+    </para>
+<screen width="56">
+<command>uname</command> <parameter class="option">-r</parameter>
+</screen>
   </warning>
     <procedure id="sn-kernel-exploding-steps">
       <step>
@@ -125,7 +132,10 @@
             <para>
               By running the following command:
             </para>
-            <screen width="56"><prompt># </prompt><command>up2date</command> <parameter class="option">--get-source</parameter> <filename>kernel</filename></screen>
+<screen width="56">
+<command>up2date</command> <parameter
+		class="option">--get-source</parameter> <filename>kernel</filename>
+</screen>
           </listitem>
         </itemizedlist>
       </step>
@@ -133,7 +143,9 @@
         <para>
           Install  <filename>kernel-<replaceable><version></replaceable>.src.rpm</filename> using the command:
         </para>
-        <screen width="56"><prompt># </prompt><command>rpm</command> <parameter class="option">-Uvh</parameter> <filename>kernel-</filename><replaceable><version></replaceable><filename>.src.rpm</filename></screen>
+<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>.
         </para>
@@ -142,17 +154,21 @@
         <para>
           Prepare the kernel sources using the commands:
         </para>
-        <screen width="56"><prompt># </prompt><command>cd</command> <filename>/usr/src/redhat/SPECS</filename>
-<prompt># </prompt><command>rpmbuild</command> <parameter class="option">-bp --target $(arch)</parameter> <filename>kernel.spec</filename></screen>
+<screen width="56">
+<command>cd</command> <filename>/usr/src/redhat/SPECS</filename>
+<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.
         </para>
-        <screen width="56"><prompt># </prompt><command>cd</command> <filename>/usr/src/redhat/BUILD/kernel-</filename><replaceable><version></replaceable> <filename>/usr/src/</filename>
-<prompt># </prompt><command>mv</command> <filename>linux-</filename><replaceable><version></replaceable> <filename>/usr/src/</filename>
-<prompt># </prompt><command>cd</command> <filename>/usr/src</filename>
-<prompt># </prompt><command>ln</command> <parameter class="option">-s</parameter> <filename>./linux-</filename><replaceable><version></replaceable> <filename>linux</filename>
-<prompt># </prompt><command>cd</command> <filename>/usr/src/linux</filename></screen>
+<screen width="56">
+<command>cd</command> <filename>/usr/src/redhat/BUILD/kernel-<replaceable><version></replaceable></filename> <filename>/usr/src/</filename>
+<command>mv</command> <filename>linux-<replaceable><version></replaceable></filename> <filename>/usr/src/</filename>
+<command>cd</command> <filename>/usr/src</filename>
+<command>ln</command> <parameter class="option">-s</parameter> <filename>./linux-<replaceable><version></replaceable></filename> <filename>linux</filename>
+<command>cd</command> <filename>/usr/src/linux</filename>
+</screen>
       </step>
       <step>
         <para>
@@ -160,13 +176,17 @@
           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"><prompt># </prompt><command>cp</command> <filename>configs/</filename><replaceable><desired-config-file></replaceable> <filename>.config</filename></screen>
+<screen width="56">
+<command>cp</command> <filename>configs/<replaceable><desired-config-file></replaceable></filename> <filename>.config</filename>
+</screen>
       </step>
       <step>
         <para>
           Issue the following command:
         </para>
-        <screen width="56"><prompt># </prompt><command>make oldconfig</command></screen>
+<screen width="56">
+<command>make oldconfig</command>
+</screen>
       </step>
     </procedure>
     <para>
@@ -200,8 +220,8 @@
     <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-</command><replaceable><version></replaceable> 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-</command><replaceable><version></replaceable> command instead since <command>yum</command> automatically removes dependant packages if necesssary.
+      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>




More information about the Fedora-docs-commits mailing list