From: Robert Haas <rhaas@postgresql.org>
Date: Thu, 4 Jul 2013 15:11:56 +0000 (-0400)
Subject: docs: Clarify flag dependencies for background workers.
X-Git-Tag: REL9_4_BETA1~1373
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=5cbe935c9d6046f5600ff2e083b4bae6ee1f4aa2;p=thirdparty%2Fpostgresql.git

docs: Clarify flag dependencies for background workers.

BGWORKER_BACKEND_DATABASE_CONNECTION can only be used if
BGWORKER_SHMEM_ACCESS is also used.

Michael Paquier, with some tweaks by me.
---

diff --git a/doc/src/sgml/bgworker.sgml b/doc/src/sgml/bgworker.sgml
index 1151161a848..b0dde7564d8 100644
--- a/doc/src/sgml/bgworker.sgml
+++ b/doc/src/sgml/bgworker.sgml
@@ -64,7 +64,10 @@ typedef struct BackgroundWorker
    <literal>BGWORKER_SHMEM_ACCESS</literal> (requesting shared memory access)
    and <literal>BGWORKER_BACKEND_DATABASE_CONNECTION</literal> (requesting the
    ability to establish a database connection, through which it can later run
-   transactions and queries).
+   transactions and queries). A background worker using
+   <literal>BGWORKER_BACKEND_DATABASE_CONNECTION</literal> to connect to
+   a database must also attach shared memory using
+   <literal>BGWORKER_SHMEM_ACCESS</literal>, or worker start-up will fail.
   </para>
 
   <para>