Bug 51109
| Summary: | [PATCH] handbook (kernelconfig) | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Product: | Documentation | Reporter: | Martin Karlsson <mk-freebsd> | ||||||
| Component: | Books & Articles | Assignee: | freebsd-doc (Nobody) <doc> | ||||||
| Status: | Closed FIXED | ||||||||
| Severity: | Affects Only Me | ||||||||
| Priority: | Normal | ||||||||
| Version: | Latest | ||||||||
| Hardware: | Any | ||||||||
| OS: | Any | ||||||||
| Attachments: |
|
||||||||
|
Description
Martin Karlsson
2003-04-17 23:20:12 UTC
On Fri, Apr 18, 2003 at 12:16:31AM +0200, Martin Karlsson wrote:
> >Description:
> The handbook does explain how to copy GENERIC to MYKERNEL, and edit
> MYKERNEL, but does not explicitly mention why editing
> GENERIC directly is a bad idea. Perhaps it should? This patch aims to
> fix that.
>
> I have seen related questions (Where did GENERIC go?) on -questions only
> a few times, but being explicit about important things is rarely bad IMO.
>
> >How-To-Repeat:
> Read the handbook, 9.3 Building and Installing a Custom Kernel.
> >Fix:
>
>
>
> --- kernelconfig.diff begins here ---
> Index: chapter.sgml
> ===================================================================
> RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/handbook/kernelconfig/chapter.sgml,v
> retrieving revision 1.104
> diff -u -r1.104 chapter.sgml
> --- chapter.sgml 2003/03/31 17:01:34 1.104
> +++ chapter.sgml 2003/04/17 21:55:17
> @@ -186,6 +186,13 @@
> call it <filename>MYKERNEL</filename> for the purpose of this
> example.</para>
>
> + <note>
> + <para>Do <emphasis>not</emphasis> simply edit <filename>GENERIC</filename>.
> + If you do, it will be overwritten the next time you <link
> + linkend="cutting-edge">update your source tree</link>, and all
> + your kernel modifications will be lost.</para>
> + </note>
> +
> <tip>
> <para>Storing your kernel config file directly under
> <filename>/usr/src</filename> can be a bad idea. If you are
> --- kernelconfig.diff ends here ---
The tip continues, but the diff doesn't :-)
| <para>Storing your kernel config file directly under
| <filename>/usr/src</filename> can be a bad idea. If you are
| experiencing problems it can be tempting to just delete
| <filename>/usr/src</filename> and start again. Five seconds after
| you do that you realize that you have deleted your custom kernel
| config file.</para>
Do we need to clarify this? If so, this should be
added to the tip.
--
Marxpitn
Hi, * Martin Heinen <martin@sumuk.de> [2003-04-18 01.08 +0200]: [...snip...] > The tip continues, but the diff doesn't :-) :-) I see what you mean. > > | <para>Storing your kernel config file directly under > | <filename>/usr/src</filename> can be a bad idea. If you are > | experiencing problems it can be tempting to just delete > | <filename>/usr/src</filename> and start again. Five seconds after > | you do that you realize that you have deleted your custom kernel > | config file.</para> > > Do we need to clarify this? If so, this should be > added to the tip. Perhaps we don't. I'll attach a re-worked diff, but feel free to close the PR if you think it would be too explicit. > -- > Marxpitn -- Martin Karlsson On Fri, Apr 18, 2003 at 02:37:27AM +0200, Martin Karlsson wrote: > * Martin Heinen <martin@sumuk.de> [2003-04-18 01.08 +0200]: > > Do we need to clarify this? If so, this should be > > added to the tip. > > Perhaps we don't. I'll attach a re-worked diff, but feel free to > close the PR if you think it would be too explicit. Good catch, we can't be clear enough. I'll commit it shortly. -- Marxpitn State Changed From-To: open->closed Applied the second patch. Thanks for your submission. |
