Bug 74724

Summary: [patch] several problems in handbook network-inetd webpage
Product: Documentation Reporter: Francois Ropert <francois.ropert>
Component: Books & ArticlesAssignee: Ceri Davies <ceri>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Francois Ropert 2004-12-05 15:20:18 UTC
First problem : Miss words in 23.2.3 Command-Line Options section : inetd synopsis missings : [-s maximum ]

Second problem :

Missing description of -s maximum (after -R rate description and before -a description)

Third problem :

Typo error in 23.2.4 inetd.conf : Comments in the file are precedeb by a #.

# is surround of antiquote and quotation marks.

Fix: 

First problem : add [-s maximum] between [-R rate] and [configuration file] in synopsis.

Second problem : Missing description of -s maximum :

-s maximum
Specify the default maximum number of simultaneous invocations of each service from a single IP address; the default is unlimited. May be overridden on a per-service basis with the "max-child-per-ip" parameter.

Third problem :

Replace ``#'' by ''#'' in the third line from "Example 23-1. Sending inetd a HangUP Signal".
How-To-Repeat: Refresh web browser
Comment 1 Kevin Kinsey 2004-12-14 05:35:58 UTC
Francois Ropert wrote:

>First problem : Miss words in 23.2.3 Command-Line Options section : inetd synopsis missings : [-s maximum ]
>
>Second problem :
>
>Missing description of -s maximum (after -R rate description and before -a description)
>
>  
>
Third problem :

>Typo error in 23.2.4 inetd.conf : Comments in the file are preceded by a #.
>
># is surround of antiquote and quotation marks.
>  
>


Merci, Francois for the problem report.  I have addressed items
#1 and #2.  The "antiquote" "quote" problem is in the way the
documents are rendered; in the sgml source files they are listed
as <quote> </quote>, so someone more experienced than I will
need to address that, if indeed it can be addressed within the
current doc build system (IANAE.)

Thanks again for your submission.  I have attached a patch
below for the Document Project Team to review.

Kevin Kinsey

Affects: /usr/doc/en/books/handbook/network-servers/chapter.sgml
------------------------------------------------------------------------------------------------------------------

--- chapter.sgml        Fri Nov 19 17:19:42 2004
+++ chapter.sgml.edit   Mon Dec 13 23:27:32 2004
@@ -158,7 +158,7 @@
       <para><application>inetd</application> synopsis:</para>
 
       <para><option>     inetd [-d] [-l] [-w] [-W] [-c maximum] [-C 
rate] [-a address | hostname]
-           [-p filename] [-R rate] [configuration file]</option></para>
+           [-p filename] [-R rate] [-s maximum] [configuration 
file]</option></para>
 
       <variablelist>
        <varlistentry>
@@ -229,6 +229,19 @@
              allows an unlimited number of invocations.</para>
          </listitem>
        </varlistentry>
+
+      <varlistentry>
+          <term>-s maximum</term>
+
+          <listitem>
+            <para>Specify the default maximum number of simultaneous
+             invocations of each service from a single IP address;
+             the default is unlimited.  May be overridden on a
+             per-service basis with the
+             <option>max-child-per-ip</option>
+              parameter.</para>
+          </listitem>
+        </varlistentry>
 
        <varlistentry>
          <term>-a</term>

--------------------------------------------------------------------------------------------------------------------
Comment 2 Ceri Davies 2004-12-14 11:07:39 UTC
On Tue, Dec 14, 2004 at 05:40:28AM +0000, Kevin D. Kinsey, DaleCo, S.P. wrote:
> The following reply was made to PR docs/74724; it has been noted by GNATS.

>  Third problem :
>  
>  >Typo error in 23.2.4 inetd.conf : Comments in the file are preceded by a #.
>  >
>  ># is surround of antiquote and quotation marks.
>  
>  Merci, Francois for the problem report.  I have addressed items
>  #1 and #2.  The "antiquote" "quote" problem is in the way the
>  documents are rendered; in the sgml source files they are listed
>  as <quote> </quote>, so someone more experienced than I will
>  need to address that, if indeed it can be addressed within the
>  current doc build system (IANAE.)

# should be marked up as <literal> there, not with <quote>.

Ceri

Patch looks good, by the way.
Comment 3 Ceri Davies freebsd_committer freebsd_triage 2004-12-14 11:07:47 UTC
Responsible Changed
From-To: freebsd-doc->ceri

I'll shepherd Kevin's patch in.
Comment 4 Kevin Kinsey 2004-12-18 00:29:06 UTC
Ceri Davies wrote:

>OK.  Would you like to send me the patch as it stands now and I'll check
>that we're really on the same wavelength here.
>  
>
>>If the example works for you, I'll submit a new (albeit larger)
>>patch when I can (before the Holidays) and let you guys do
>>whatcha will.
>>    
>>
>
>OK, great.  I'm away between the 20th and 29th and probably offline for
>the duration, so if you want to run it by someone else rather than
>waiting that's ok withe me.  Otherwise I'll pick it up when I get back.
>  
>

Hope you have a good Holiday.  I'll put this one back
in the PR stack, in case you're off line already...

New patch for this chapter:

http://daleco.biz/patches/74724.patch

This is an "old style" diff, but applies cleanly.  The
result is at:

http://daleco.biz/inetd.html

             but is subject to removal at my whim ;-)

Another, equivalent "unified" patch (diff -u) doesn't
seem to apply cleanly for me.  If this would be better
and you can fix it, 'tis here:

http://daleco.biz/patches/74724.patch.u.bad

Kevin Kinsey
Comment 5 Ceri Davies freebsd_committer freebsd_triage 2006-02-16 20:56:56 UTC
State Changed
From-To: open->closed

Sorry this took so long, but it's been fixed.