Tag GENERIC as filename for consistency with the rest of the whole

handbook for kernel names.
This commit is contained in:
Marc Fonvieille 2011-05-22 18:49:23 +00:00
parent 529f074d82
commit 677267a4e2
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=37285

View file

@ -302,18 +302,18 @@ MergeChanges /etc/ /var/named/etc/</programlisting>
load the new binaries into memory.</para>
<para>The <command>freebsd-update</command> utility can
automatically update the <literal>GENERIC</literal> kernel only.
automatically update the <filename>GENERIC</filename> kernel only.
If a custom kernel is in use, it will have to be rebuilt and
reinstalled after <command>freebsd-update</command> finishes
installing the rest of the updates. However,
<command>freebsd-update</command> will detect and update the
<literal>GENERIC</literal> kernel in <filename
<filename>GENERIC</filename> kernel in <filename
class="directory">/boot/GENERIC</filename> (if it exists), even if
it is not the current (running) kernel of the system.</para>
<note>
<para>It is a good idea to always keep a copy of the
<literal>GENERIC</literal> kernel in <filename
<filename>GENERIC</filename> kernel in <filename
class="directory">/boot/GENERIC</filename>. It will be helpful
in diagnosing a variety of problems, and in performing version
upgrades using <command>freebsd-update</command> as described in
@ -366,24 +366,24 @@ MergeChanges /etc/ /var/named/etc/</programlisting>
manual intervention during the build process.</para>
<para>If a custom kernel is in use, the upgrade process is slightly
more involved. A copy of the <literal>GENERIC</literal> kernel is
more involved. A copy of the <filename>GENERIC</filename> kernel is
needed, and it should be placed in <filename
class="directory">/boot/GENERIC</filename>. If the
<literal>GENERIC</literal> kernel is not already present in the
<filename>GENERIC</filename> kernel is not already present in the
system, it may be obtained using one of the following methods:</para>
<itemizedlist>
<listitem>
<para>If a custom kernel has only been built once, the kernel in
<filename class="directory">/boot/kernel.old</filename> is
actually the <literal>GENERIC</literal> one. Simply rename this
actually the <filename>GENERIC</filename> one. Simply rename this
directory to
<filename class="directory">/boot/GENERIC</filename>.</para>
</listitem>
<listitem>
<para>Assuming physical access to the machine is possible, a copy
of the <literal>GENERIC</literal> kernel can be installed from
of the <filename>GENERIC</filename> kernel can be installed from
the CD-ROM media. Insert your installation disc and use the
following commands:</para>
@ -394,12 +394,12 @@ MergeChanges /etc/ /var/named/etc/</programlisting>
<para>Replace <filename
class="directory"><replaceable>X.Y-RELEASE</replaceable></filename>
with the actual version of the release you are using. The
<literal>GENERIC</literal> kernel will be installed in <filename
<filename>GENERIC</filename> kernel will be installed in <filename
class="directory">/boot/GENERIC</filename> by default.</para>
</listitem>
<listitem>
<para>Failing all the above, the <literal>GENERIC</literal> kernel
<para>Failing all the above, the <filename>GENERIC</filename> kernel
may be rebuilt and installed from the sources:</para>
<screen>&prompt.root; <userinput>cd /usr/src</userinput>
@ -407,16 +407,16 @@ MergeChanges /etc/ /var/named/etc/</programlisting>
&prompt.root; <userinput>mv /boot/GENERIC/boot/kernel/* /boot/GENERIC</userinput>
&prompt.root; <userinput>rm -rf /boot/GENERIC/boot</userinput></screen>
<para>For this kernel to be picked up as <literal>GENERIC</literal>
<para>For this kernel to be picked up as <filename>GENERIC</filename>
by <command>freebsd-update</command>, the
<literal>GENERIC</literal> configuration file must not have been
<filename>GENERIC</filename> configuration file must not have been
modified in any way. It is also suggested that it is built
without any other special options (preferably with an empty
<filename>/etc/make.conf</filename>).</para>
</listitem>
</itemizedlist>
<para>Rebooting to the <literal>GENERIC</literal> kernel is not
<para>Rebooting to the <filename>GENERIC</filename> kernel is not
required at this stage.</para>
<para>Major and minor version updates may be performed by
@ -464,7 +464,7 @@ This kernel will not be updated: you MUST update the kernel manually
before running "/usr/sbin/freebsd-update install"</screen>
<para>This warning may be safely ignored at this point. The updated
<literal>GENERIC</literal> kernel will be used as an intermediate
<filename>GENERIC</filename> kernel will be used as an intermediate
step in the upgrade process.</para>
<para>After all patches have been downloaded to the local
@ -504,13 +504,13 @@ before running "/usr/sbin/freebsd-update install"</screen>
<screen>&prompt.root; <userinput>nextboot -k GENERIC</userinput></screen>
<warning>
<para>Before rebooting with the <literal>GENERIC</literal> kernel,
<para>Before rebooting with the <filename>GENERIC</filename> kernel,
make sure it contains all drivers required for your system to boot
properly (and connect to the network, if the machine that is being
updated is accessed remotely). In particular, if the previously
running custom kernel contained built-in functionality usually
provided by kernel modules, make sure to temporarily load these
modules into the <literal>GENERIC</literal> kernel using the
modules into the <filename>GENERIC</filename> kernel using the
<filename>/boot/loader.conf</filename> facility. You may also wish
to disable non-essential services, disk and network mounts, etc.
until the upgrade process is complete.</para>
@ -557,7 +557,7 @@ before running "/usr/sbin/freebsd-update install"</screen>
<screen>&prompt.root; <userinput>freebsd-update install</userinput></screen>
<para>If the <literal>GENERIC</literal> kernel was temporarily used,
<para>If the <filename>GENERIC</filename> kernel was temporarily used,
this is the time to build and install a new custom kernel in the
usual way.</para>