| From: | Joao Rito <joaovictor(dot)rito(at)gmail(dot)com> |
|---|---|
| To: | Kyotaro Horiguchi <horikyota(dot)ntt(at)gmail(dot)com> |
| Cc: | PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org> |
| Subject: | [PATCH v2] doc: Fix autovacuum_max_workers and autovacuum_worker_slots descriptions |
| Date: | 2026-11-19 04:15:26 |
| Message-ID: | 20261119041526.4022-1-joaovictor.rito@gmail.com |
| Views: | Whole Thread | Raw Message | Download mbox | Resend email |
| Thread: | |
| Lists: | pgsql-hackers |
Reword the autovacuum_worker_slots description to say that it sets the
number of slots to allocate, and explain that autovacuum_max_workers can
be raised up to this value by reloading the configuration. Update the
GUC short description to match.
---
Hi Horiguchi-san,
Thank you very much for the review and for the diff. I rewrote the patch from it.
Changes in v2:
- Reword the existing text of autovacuum_worker_slots instead of adding a new paragraph. I used your wording: "slots to allocate for autovacuum worker processes", and "Setting this parameter higher than autovacuum_max_workers allows it to be increased up to this value by reloading the configuration without restarting the server".
- Drop the sentences about when the WARNING is logged, and leave the autovacuum_max_workers text as it was.
- Change the short_desc in guc_parameters.dat to "Sets the number of slots to allocate for autovacuum workers."
I tested on master (ba11c48) with --enable-cassert. The patch also applies cleanly with "git am" on a newer master (1191073). The documentation passes "make -C doc/src/sgml check" and the HTML build. "SELECT short_desc FROM pg_settings WHERE name = 'autovacuum_worker_slots'" returns the new text. "make check" passed (243 tests), and so did src/test/modules/test_misc (169 tests; 5 of 16 test files were skipped because the build has no injection points).
What I did not test: I did not read the rendered HTML. I tested only one platform. I did not check whether translations (.po files) need a change for the short_desc.
Thank you again,
Joao Rito
doc/src/sgml/config.sgml | 7 ++++---
src/backend/utils/misc/guc_parameters.dat | 2 +-
2 files changed, 5 insertions(+), 4 deletions(-)
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 886e8c4..cf95130 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -9499,14 +9499,15 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
</term>
<listitem>
<para>
- Specifies the number of backend slots to reserve for autovacuum worker
+ Specifies the number of slots to allocate for autovacuum worker
processes. The default is typically 16 slots, but might be less if
your kernel settings will not support it (as determined during initdb).
This parameter can only be set at server start.
</para>
<para>
- When changing this value, consider also adjusting
- <xref linkend="guc-autovacuum-max-workers"/>.
+ Setting this parameter higher than <xref linkend="guc-autovacuum-max-workers"/>
+ allows it to be increased up to this value by reloading the configuration
+ without restarting the server.
</para>
</listitem>
</varlistentry>
diff --git a/src/backend/utils/misc/guc_parameters.dat b/src/backend/utils/misc/guc_parameters.dat
index 184fcf4..3c2b7c3 100644
--- a/src/backend/utils/misc/guc_parameters.dat
+++ b/src/backend/utils/misc/guc_parameters.dat
@@ -294,7 +294,7 @@
# see max_connections
{ name => 'autovacuum_worker_slots', type => 'int', context => 'PGC_POSTMASTER', group => 'VACUUM_AUTOVACUUM',
- short_desc => 'Sets the number of backend slots to allocate for autovacuum workers.',
+ short_desc => 'Sets the number of slots to allocate for autovacuum workers.',
variable => 'autovacuum_worker_slots',
boot_val => '16',
min => '1',
--
2.39.5
| From | Date | Subject | |
|---|---|---|---|
| Next Message | Hayato Kuroda (Fujitsu) | 2026-11-19 04:21:33 | RE: [PATCH] pg_createsubscriber: add hint to wal_level error |
| Previous Message | Jeff Davis | 2026-11-19 04:09:57 | Re: fix special case during recovery for hot_standby=off |