[Pgpool-hackers] First try at rephrasing the documentation

[Tatsuo Ishii]

I have read through your patches and feel very comfortable with it. I
would like to commit your version unless there's an
objection. Included is trivial fix for your document. Please update
yours.

I will try to answer your TODO items one by one following emals...
--
Tatsuo Ishii
SRA OSS, Inc. Japan
English: http://www.sraoss.co.jp/index_en.php
Japanese: http://www.sraoss.co.jp

-------------------------------------------------------------------------
*** pgpool-en.html.contrib	2010-12-20 15:23:45.000000000 +0900
--- pgpool-en.html	2010-12-20 15:30:54.000000000 +0900
*** 486,492 ****
  			This is useful to prevent pgpool childs from being
  			occupied by a lazy client or a broken TCP/IP connection between client and
  			pgpool. The default value for client_idle_limit is 0, which means 
! 			the feature is turned off. this value. This parameter is ignored in the 
  			second stage of online recovery. You need to reload pgpool.conf if you 
  			change client_idle_limit.</p>
  
--- 486,492 ----
  			This is useful to prevent pgpool childs from being
  			occupied by a lazy client or a broken TCP/IP connection between client and
  			pgpool. The default value for client_idle_limit is 0, which means 
! 			the feature is turned off. This parameter is ignored in the 
  			second stage of online recovery. You need to reload pgpool.conf if you 
  			change client_idle_limit.</p>
  
***************
*** 624,630 ****
  If true, and an error occurs when writing to the backend communication,
  pgpool-II will trigger the fail over procedure . This is the same behavior as of 
  pgpool-II 2.2.x or earlier. If set to false, pgpool will report an error and 
! disconnect the session. 
  Please note that if set, however, pgpool will also do the fail over when 
  connecting to a backend fails or pgpool detects the administrative shutdown of 
  postmaster. You need to reload pgpool.conf if you change this value.
--- 624,631 ----
  If true, and an error occurs when writing to the backend communication,
  pgpool-II will trigger the fail over procedure . This is the same behavior as of 
  pgpool-II 2.2.x or earlier. If set to false, pgpool will report an error and 
! disconnect the session.
! Default is true.
  Please note that if set, however, pgpool will also do the fail over when 
  connecting to a backend fails or pgpool detects the administrative shutdown of 
  postmaster. You need to reload pgpool.conf if you change this value.
-------------------------------------------------------------------------

From: Marc Cousin <cousinmarc at gmail.com>
Subject: [Pgpool-hackers] First try at rephrasing the documentation
Date: Fri, 17 Dec 2010 10:52:11 +0100
Message-ID: <201012171052.12087.cousinmarc at gmail.com>

> Hi,
> 
> Here is my first try at rephrasing the documentation. A word of warning first:  
> I am not a native English speaker. That may also be a reason why I have so 
> much trouble reading the current documentation.
> 
> I kept the current structure, which I didn't feel was a problem. I mostly 
> tried to rephrase, or use more accurate words, when I felt it was hard to 
> understand. I also tried to add bits of information here and there.
> 
> I spent a lot of time reading the source code to write this, but I'm still not 
> that familiar with it, so there will obviously be things I have misunderstood.
> 
> It is not complete either: I have several TODO items in it. Most of them are 
> questions that I didn't find an answer to, or thought it would only take a few 
> seconds to a hacker to answer, when it might take me hours :)
> 
> So if anyone is interested in it, here is the document (I can send a patch 
> also, but the patch is bigger than the file).
> 
> I'd really like to know if it may be useful, and if it is, I'd need help on 
> these items to complete the job:
> - A native english speaker, to check that what I wrote is correct english
> - A hacker, to check the TODOs and fill in the things that I didn't get 
> correctly  (or tell me, so that I can fill them myself), and check that I 
> didn't write anything wrong, technically speaking.
> 
> I did the work on pgpoolII-3.0.1's doc, by the way.
> 
> Cheers
> 
> Marc