aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Haas <rhaas@postgresql.org>2013-07-04 11:11:56 -0400
committerRobert Haas <rhaas@postgresql.org>2013-07-04 11:15:12 -0400
commit5cbe935c9d6046f5600ff2e083b4bae6ee1f4aa2 (patch)
tree8686a35701f0f337c1b5fe785668dd35b6f5cdc9
parent0d1795680d57d5997c244410e4d8a2eca22ae903 (diff)
downloadpostgresql-5cbe935c9d6046f5600ff2e083b4bae6ee1f4aa2.tar.gz
postgresql-5cbe935c9d6046f5600ff2e083b4bae6ee1f4aa2.zip
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.
-rw-r--r--doc/src/sgml/bgworker.sgml5
1 files changed, 4 insertions, 1 deletions
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>