[PATCH] bgworker doc typo fixes
Hi,
I noticed a couple of missing words (at least to my reading) in the
bgworker doc. This changes "...is started including the module name..." to
"...is started by including the module name..." and "...to obtain
information the status of the worker." to "...to obtain information
regarding the status of the worker."
Thanks,
Maciek
Attachments:
bgworker-doc-typo-fixes.patchapplication/octet-stream; name=bgworker-doc-typo-fixes.patchDownload
diff --git a/doc/src/sgml/bgworker.sgml b/doc/src/sgml/bgworker.sgml
index 102d463..9e6dea9 100644
--- a/doc/src/sgml/bgworker.sgml
+++ b/doc/src/sgml/bgworker.sgml
@@ -31,7 +31,7 @@
<para>
Background workers can be initialized at the time that
- <productname>PostgreSQL</> is started including the module name in
+ <productname>PostgreSQL</> is started by including the module name in
<varname>shared_preload_libraries</>. A module wishing to run a background
worker can register it by calling
<function>RegisterBackgroundWorker(<type>BackgroundWorker *worker</type>)</function>
@@ -179,10 +179,10 @@ typedef struct BackgroundWorker
When a background worker is registered using the
<function>RegisterDynamicBackgroundWorker</function> function, it is
possible for the backend performing the registration to obtain information
- the status of the worker. Backends wishing to do this should pass the
- address of a <type>BackgroundWorkerHandle *</type> as the second argument
- to <function>RegisterDynamicBackgroundWorker</function>. If the worker
- is successfully registered, this pointer will be initialized with an
+ regarding the status of the worker. Backends wishing to do this should
+ pass the address of a <type>BackgroundWorkerHandle *</type> as the second
+ argument to <function>RegisterDynamicBackgroundWorker</function>. If the
+ worker is successfully registered, this pointer will be initialized with an
opaque handle that can subsequently be passed to
<function>GetBackgroundWorkerPid(<parameter>BackgroundWorkerHandle *</parameter>, <parameter>pid_t *</parameter>)</function>.
This function can be used to poll the status of the worker: a return
On Fri, Oct 4, 2013 at 7:48 AM, Maciek Sakrejda <m.sakrejda@gmail.com> wrote:
I noticed a couple of missing words (at least to my reading) in the bgworker
doc. This changes "...is started including the module name..." to "...is
started by including the module name..." and "...to obtain information the
status of the worker." to "...to obtain information regarding the status of
the worker."
Thanks, committed.
--
Robert Haas
EnterpriseDB: http://www.enterprisedb.com
The Enterprise PostgreSQL Company
--
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers