Bug 29570

Summary: Mark Up changes for chapter Configuration and Tuning
Product: Documentation Reporter: mheinen0 <mheinen0>
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
ch-udiff none

Description mheinen0 2001-08-09 17:10:01 UTC
	
	additional files marked up with <filename>,
	replaced literal " with <quote>,
	marked up root as user,
	changed fxp0 to show up as device,
	replaced bind with &man.named.8;,
	marked up syslog, ppp as <command>

Fix: 

RCS file: /u/cvs/doc/en_US.ISO8859-1/books/handbook/config/chapter.sgml,v
	retrieving revision 1.12
	diff -r1.12 chapter.sgml
	158,159c158,159
	< 	partition and be done with it?  Then I don't have to worry
	< 	about undersizing things!</para>
	---
	> 	  partition and be done with it?  Then I don't have to worry
	> 	  about undersizing things!</para>
	244c244,245
	<       or 'make world' will not overwrite the <filename>rc.conf</filename>
	---
	>       or <command>make world</command> will not overwrite the 
	>       <filename>rc.conf</filename>
	267c268,269
	<       identified with a ".default" suffix.  If there are no existing
	---
	>       identified with a <quote>.default</quote> suffix.  If there 
	>       are no existing
	285,287c287,289
	<     <para>It can be quickly seen that only the srm.conf file has been
	<       changed.  A later update of the apache port would not overwrite
	<       this changed file.</para>
	---
	>     <para>It can be quickly seen that only the <filename>srm.conf</filename>
	>       file has been changed.  A later update of the apache port would not
	>       overwrite this changed file.</para>
	305,308c307,313
	<       system startup with a 'start' argument, and at system shutdown
	<       with a 'stop' argument.  This is the recommended way for
	<       starting system-wide services that are to be run as root, or that
	<       expect to be started as root.  These scripts are registered as
	---
	>       system startup with a <option>start</option> argument, and at
	>       system shutdown with a <option>stop</option> argument.
	>       This is the recommended way for
	>       starting system-wide services that are to be run as
	>       <username>root</username>, or that
	>       expect to be started as <username>root</username>.
	>       These scripts are registered as
	364c369
	<       and maintained by non-root users.</para>
	---
	>       and maintained by non-<username>root</username> users.</para>
	367c372,373
	<       time specification may be replaced by '@reboot', which will
	---
	>       time specification may be replaced by <literal>@reboot</literal>,
	>       which will
	383,384c389,391
	<     <para>A given network interface has one "real" address, and may
	<       have any number of "alias" addresses.  These aliases are
	---
	>     <para>A given network interface has one <quote>real</quote> address,
	>       and may have any number of <quote>alias</quote> addresses.
	>       These aliases are
	388c395,396
	<     <para>An alias entry for the interface 'fxp0' looks like:</para>
	---
	>     <para>An alias entry for the interface <devicename>fxp0</devicename>
	>       looks like:</para>
	403c411,412
	<     <para>For example, consider the case where the fxp0 interface is
	---
	>     <para>For example, consider the case where the 
	>       <devicename>fxp0</devicename> interface is
	446,447c455,456
	< 	      <entry>Extra sendmail configuration, other MTA configuration 
	< 		files.
	---
	> 	      <entry>Extra &man.sendmail.8; configuration, other 
	> 		MTA configuration files.
	452c461,462
	< 	      <entry>Configuration for both user- and kernel-ppp programs.
	---
	> 	      <entry>Configuration for both user- and
	> 	        kernel-<command>ppp</command> programs.
	457c467
	< 	      <entry>Default location for bind(8) data.  Normally the
	---
	> 	      <entry>Default location for &man.named.8; data.  Normally the
	472,473c482,483
	< 	      <entry>Persistent system-specific data files, such as bind zone 
	< 		files, database files, and so on.</entry>
	---
	> 	      <entry>Persistent system-specific data files, such as 
	> 		&man.named.8; zone files, database files, and so on.</entry>
	602c612,613
	< 	  of syslog messages are logged to particular log files.</para>
	---
	> 	  of <command>syslog</command> messages are logged to particular
	> 	  log files.</para>
	653,654c664,665
	< 	  causing them to be named: logfile.0.gz, logfile.1.gz, and so
	< 	  on.</para>
	---
	> 	  causing them to be named: <filename>logfile.0.gz</filename>,
	> 	  <filename>logfile.1.gz</filename>, and so on.</para>
How-To-Repeat: 	read the Chapter 'Configuration and Tuning'
Comment 1 dima 2001-08-09 18:28:47 UTC
Martin Heinen <mheinen0@wiesbaden-online.de> writes:
> >Description:
> 	
> 	additional files marked up with <filename>,
> 	replaced literal " with <quote>,
> 	marked up root as user,
> 	changed fxp0 to show up as device,
> 	replaced bind with &man.named.8;,
> 	marked up syslog, ppp as <command>

Great!  Put please submit this in the form of a unified diff, and
don't indent it.  The former will make it easier to read, and the
latter will make it possible to apply.

Thanks.
Comment 2 mheinen0 2001-08-10 11:52:10 UTC
On Thu, Aug 09, 2001 at 10:28:47AM -0700, Dima Dorfman wrote:

> Great!  Put please submit this in the form of a unified diff, and
> don't indent it.  The former will make it easier to read, and the
> latter will make it possible to apply.

Sorry for the inconvenience, I attached a unified diff against
1.13.

Martin

-- 
Marxpitn
Comment 3 dima 2001-08-11 21:23:11 UTC
Martin Heinen <mheinen0@wiesbaden-online.de> writes:
>  	    <row>
>  	      <entry><filename>/etc/ppp</filename></entry>
> -	      <entry>Configuration for both user- and kernel-ppp programs.
> +	      <entry>Configuration for both user- and
> +	        kernel-<command>ppp</command> programs.
>  	      </entry>

This isn't right, because it isn't talking about ppp(8) specifically.

> @@ -743,8 +754,9 @@
>      <screen>&prompt.root; <userinput>sysctl kern.maxfiles=5000</userinput>
>  kern.maxfiles: 2088 -> 5000</screen>
>  
> -    <para>Settings of sysctl variables are usually either strings, numbers,
> -      or booleans.  A boolean being 1 for yes or a 0 for no.</para>
> +    <para>Settings of &man.sysctl.8; variables are usually either strings,

Changing sysctl -> sysctl.8 seems wrong, since that command isn't the
only way to set sysctl variables.  Besides, there's concern with
overusing the man page entities.

Other than that, the patch looks good.  I'll apply it shortly.
Comment 4 dd freebsd_committer freebsd_triage 2001-08-11 21:25:49 UTC
State Changed
From-To: open->closed

Applied, thanks!