Bug 70005

Summary: [PATCH] Contradictory section in Handbook(config) at 11.12.1.1 vfs.vmiodirenable - proposal to change wording
Product: Documentation Reporter: Marju Ignatjeva <marju>
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 Marju Ignatjeva 2004-08-04 18:20:09 UTC
There is a contradictory section in the Handbook's Configuration and Tuning chapter, at       
11.12.1.1 vfs.vmiodirenable

If you look at how that section has been changed, you'll see that the default value of the variable is now 1, however the text keeps talking about _turning on_ that variable. I created a patch, shown below in the 'Fix to the problem' box.
Here follows an illustration to my problem:

RCS file: /usr/local/www/cvsroot/FreeBSD/doc/en_US.ISO8859-1/books/handbook/config/chapter.sgml,v
retrieving revision 1.1
retrieving revision 1.162
diff -u -p -r1.1 -r1.162
--- doc/en_US.ISO8859-1/books/handbook/config/chapter.sgml	2001/07/10 02:33:49	1.1
+++ doc/en_US.ISO8859-1/books/handbook/config/chapter.sgml	2004/07/28 09:14:23	1.162
@@ -1,160 +1,216 @@

+	<indexterm>
+	  <primary><varname>vfs.vmiodirenable</varname></primary>
+	</indexterm>
+
 	<para>The <varname>vfs.vmiodirenable</varname> sysctl variable
-	  defaults to 0 (off) (though soon it will default to 1) and may
-	  be set to 0 (off) or 1 (on).  This parameter controls how
-	  directories are cached by the system.  Most directories are
-	  small and use but a single fragment (typically 1K) in the
-	  filesystem and even less (typically 512 bytes) in the buffer
-	  cache.  However, when operating in the default mode the buffer
+	  may be set to either 0 (off) or 1 (on); it is 1 by default.
+	  This variable controls how directories are cached by the
+	  system.  Most directories are small, using just a single
+	  fragment (typically 1&nbsp;K) in the file system and less
+	  (typically 512&nbsp;bytes) in the buffer cache.
+	  However, when operating in the default mode the buffer
 	  cache will only cache a fixed number of directories even if
 	  you have a huge amount of memory.  Turning on this sysctl
 	  allows the buffer cache to use the VM Page Cache to cache the
-	  directories.

Fix: I created a patch with some rearrangements as to the wording and here is my diff with that patch against revision 1.161:

eiland>diff -u r1.161 conf.fix 
How-To-Repeat: diff the initial revision against the current one...
http://www.freebsd.org/cgi/cvsweb.cgi/doc/en_US.ISO8859-1/books/handbook/config/chapter.sgml
Comment 1 Peter Pentchev freebsd_committer freebsd_triage 2004-08-09 13:58:06 UTC
State Changed
From-To: open->closed

Committed with minor modifications, thanks!