Bug 34036

Summary: [PATCH] Kernel Config Chapter, not 4.5 ready
Product: Documentation Reporter: darklogik <darklogik>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description darklogik 2002-01-18 15:30:00 UTC 
As talked about with a few project members, and mainly under the direction of RWatson, I have added
some of the new features of the 4.5 GENERIC kernel to the handbook.  This is not all of the options, but it
will add the options SOFTUPDATES and the kern.maxusers information.  It will also reword a previous sentence
that I thought difficult to understand :)

Fix: Apply this diff, I will provide more to the chapter later on :)





How-To-Repeat: Look at both, 4.5 GENERIC and the handbook kernel config chapter
Comment 1 setantae 2002-01-18 16:18:31 UTC 
On Fri, Jan 18, 2002 at 10:26:32AM -0500, Tom Rhodes wrote:

> +     <para>This options allows for faster dist writing.</para>

s/dist/disk/

> +         <para><option>SOFTUPDATES</option> are already enabled in the

Did I hear someone say on -doc earlier this week that SoftUpdates is to be
considered singular ?

> +         <filename>GENERIC</filename> kernel, but they are not turned on
> + 	by default.  You need to set this option yourself using the
> + 	&man.tunefs.8; command, and specifying the <option>-n</option>
> + 	option.

Could also mention newfs -U ?

Ceri
Comment 2 darklogik 2002-01-18 16:31:16 UTC 
I am sorry, but I have noticed a slight mistake in my patch, on the line under

options SOFTUPDATES, I typed "dist" instead of "disk" I apologize for 
that mistake and I will be a tad bit more careful on the next!

Also, I have dabbed into GENERIC a bit more, and noticed that options 
UFS_DIRHASH is listed, but not all togeather.  For instance, GENERIC 
says that the option speeds up performance on big directories, but makes 
no note on the fact that, the performance is uses ram for this, a 
machine with a small amount of ram may not want that option listed.  I 
will make a note of that on my next kernel patch.


> + 
> +     <programlisting>options	     SOFTUPDATES         #Softupdates</programlisting>
> + 
> +     <para>This options allows for faster dist writing.</para>
> + 
> +       <note>
> +         <para><option>SOFTUPDATES</option> are already enabled in the
> +         <filename>GENERIC</filename> kernel, but they are not turned on
> + 	by default.  You need to set this option yourself using the
> + 	&man.tunefs.8; command, and specifying the <option>-n</option>
> + 	option.  Please read over the
> + 	<filename>/usr/src/sys/ufs/ffs/README.softupdates</filename> file before
> + 	setting this option</para>
> +       </note>
>   
>       <programlisting>options          USERCONFIG          #boot -c editor</programlisting>


-- 
Tom (Darklogik) Rhodes
www.Pittgoth.com Gothic Liberation Front
www.FreeBSD.org  The Power To Serve
Comment 3 darklogik 2002-01-18 16:40:41 UTC 
Ceri wrote:

> On Fri, Jan 18, 2002 at 10:26:32AM -0500, Tom Rhodes wrote:
> 
> 
>>+     <para>This options allows for faster dist writing.</para>
>>
> 
> s/dist/disk/
> 


I was one step ahead or behind you, right before I obtained your email, 
I sent a reply to my patch pointing this out :)

> 
>>+         <para><option>SOFTUPDATES</option> are already enabled in the
>>
> 
> Did I hear someone say on -doc earlier this week that SoftUpdates is to be
> considered singular ?


I sup'd the source yesterday to verify that (I remember something along 
that line) but in my 4.5 GENERIC file, it is listed as plural, and it 
builds fine without modification, so I just left it be :)

> 
> 
>>+         <filename>GENERIC</filename> kernel, but they are not turned on
>>+ 	by default.  You need to set this option yourself using the
>>+ 	&man.tunefs.8; command, and specifying the <option>-n</option>
>>+ 	option.
>>
> 
> Could also mention newfs -U ?
> 
> Ceri
> 
Thanks for pointing out the -U option, but isn't that for a NEW filesystem?


#man 8 newfs
<snip>
-U   Enables soft updates on the new filesystem

I can understand pointing this out, but that is with a new filesystem, 
and figured a need to only point out how to enable softupdates, I 
suppose adding a &man.newfs.8 wouldn't hurt at all though :)

At least I can be sure that more people are paying attention to me than 
what credit I give hehehe


-- 
Tom (Darklogik) Rhodes
www.Pittgoth.com Gothic Liberation Front
www.FreeBSD.org  The Power To Serve
Comment 4 setantae 2002-01-19 10:38:30 UTC 
On Fri, Jan 18, 2002 at 11:40:41AM -0500, Tom Rhodes wrote:
> Ceri wrote:
> >On Fri, Jan 18, 2002 at 10:26:32AM -0500, Tom Rhodes wrote:
> >
> >>+         <para><option>SOFTUPDATES</option> are already enabled in the
> >
> >Did I hear someone say on -doc earlier this week that SoftUpdates is to be
> >considered singular ?
> 
> I sup'd the source yesterday to verify that (I remember something along 
> that line) but in my 4.5 GENERIC file, it is listed as plural, and it 
> builds fine without modification, so I just left it be :)

I meant more as in :
	<para><option>SOFTUPDATES</option> is already enabled ....

> >Could also mention newfs -U ?
> >
> Thanks for pointing out the -U option, but isn't that for a NEW filesystem?

Certainly is, yes.

> I can understand pointing this out, but that is with a new filesystem, 
> and figured a need to only point out how to enable softupdates, I 
> suppose adding a &man.newfs.8 wouldn't hurt at all though :)

I reckon; I find it a lot less hassle to just do :
	newfs -U /dev/whatever
than:
	newfs /dev/whatever && tunefs -n enable /dev/whatever

Laziness _is_ a virtue :)

Ceri
Comment 5 darklogik 2002-01-21 04:19:51 UTC 
Ceri wrote:

>On Fri, Jan 18, 2002 at 11:40:41AM -0500, Tom Rhodes wrote:
>
>>Ceri wrote:
>>
>>>On Fri, Jan 18, 2002 at 10:26:32AM -0500, Tom Rhodes wrote:
>>>
>>>>+         <para><option>SOFTUPDATES</option> are already enabled in the
>>>>
>>>Did I hear someone say on -doc earlier this week that SoftUpdates is to be
>>>considered singular ?
>>>
>>I sup'd the source yesterday to verify that (I remember something along 
>>that line) but in my 4.5 GENERIC file, it is listed as plural, and it 
>>builds fine without modification, so I just left it be :)
>>
>
>I meant more as in :
>	<para><option>SOFTUPDATES</option> is already enabled ....
>
>>>Could also mention newfs -U ?
>>>
>>Thanks for pointing out the -U option, but isn't that for a NEW filesystem?
>>
>
>Certainly is, yes.
>
>>I can understand pointing this out, but that is with a new filesystem, 
>>and figured a need to only point out how to enable softupdates, I 
>>suppose adding a &man.newfs.8 wouldn't hurt at all though :)
>>
>
>I reckon; I find it a lot less hassle to just do :
>	newfs -U /dev/whatever
>than:
>	newfs /dev/whatever && tunefs -n enable /dev/whatever
>
>Laziness _is_ a virtue :)
>
>Ceri
>
>
More or less depends on how you set up your hard drive though, I would 
not recommend you play around with newfs on a /usr partition :) 
 Thinking that most users would already have their system setup before 
compiling a kernel was the idea in mind when I wrote this, and that they 
would also enable softupdates on current partitions.  I suppose, 
however, a man link or quick info line would not hurt one bit, should I 
submit another patch or just revise the section if/when this is commited?


--Tom Rhodes
Comment 6 Giorgos Keramidas freebsd_committer freebsd_triage 2002-01-21 18:17:25 UTC 
State Changed
From-To: open->closed

Tmo, who submitted this, has told me in private mail he's got another 
patch coming, and will file a new PR when it is ready.