Document that TCP keepalive settings read as 0 on Unix-socket connections.

tglsfdc · tglsfdc · commit c22acf455842 · 2012-10-31T14:26:40.000-04:00
Per bug #7631 from Rob Johnson.  The code is operating as designed, but the
docs didn't explain it.
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
@@ -555,8 +555,9 @@ SET ENABLE_SEQSCAN TO OFF;
         an otherwise idle connection.  A value of 0 uses the system default.
         This parameter is supported only on systems that support the
         <symbol>TCP_KEEPIDLE</> or <symbol>TCP_KEEPALIVE</> symbols, and on
-        Windows; on other systems, it must be zero. This parameter is ignored
-        for connections made via a Unix-domain socket.
+        Windows; on other systems, it must be zero.
+        In sessions connected via a Unix-domain socket, this parameter is
+        ignored and always reads as zero.
        </para>
        <note>
         <para>
@@ -578,8 +579,9 @@ SET ENABLE_SEQSCAN TO OFF;
         otherwise idle connection.  A value of 0 uses the system default.
         This parameter is supported only on systems that support the
         <symbol>TCP_KEEPINTVL</> symbol, and on Windows; on other systems, it
-        must be zero. This parameter is ignored for connections made via a
-        Unix-domain socket.
+        must be zero.
+        In sessions connected via a Unix-domain socket, this parameter is
+        ignored and always reads as zero.
        </para>
        <note>
         <para>
@@ -600,8 +602,9 @@ SET ENABLE_SEQSCAN TO OFF;
         Specifies the number of keepalive packets to send on an otherwise idle
         connection.  A value of 0 uses the system default.  This parameter is
         supported only on systems that support the <symbol>TCP_KEEPCNT</>
-        symbol; on other systems, it must be zero. This parameter is ignored
-        for connections made via a Unix-domain socket.
+        symbol; on other systems, it must be zero.
+        In sessions connected via a Unix-domain socket, this parameter is
+        ignored and always reads as zero.
        </para>
        <note>
         <para>
