docs: Clarify flag dependencies for background workers.
authorRobert Haas
Thu, 4 Jul 2013 15:11:56 +0000 (11:11 -0400)
committerRobert Haas
Thu, 4 Jul 2013 15:15:12 +0000 (11:15 -0400)
BGWORKER_BACKEND_DATABASE_CONNECTION can only be used if
BGWORKER_SHMEM_ACCESS is also used.

Michael Paquier, with some tweaks by me.

doc/src/sgml/bgworker.sgml

index 1151161a848d8948de11697f2b822fcc70ee3cfb..b0dde7564d86093e9aa4424ab562151e3ebb3f6f 100644 (file)
@@ -64,7 +64,10 @@ typedef struct BackgroundWorker
    BGWORKER_SHMEM_ACCESS (requesting shared memory access)
    and BGWORKER_BACKEND_DATABASE_CONNECTION (requesting the
    ability to establish a database connection, through which it can later run
-   transactions and queries).
+   transactions and queries). A background worker using
+   BGWORKER_BACKEND_DATABASE_CONNECTION to connect to
+   a database must also attach shared memory using
+   BGWORKER_SHMEM_ACCESS, or worker start-up will fail.