Repository navigation
Conversation
Section 7.2 of the v5.6 documentation lists a parameter that does not
exist (ivorysql.listen_address), omits one that does
(ivorysql.enable_case_switch), and never mentions the seven
developer-only parameters that are registered by IvorySQL but hidden
from pg_settings.
Changes (CN + EN):
* ivorysql.listen_address -> ivorysql.listen_addresses, with the
default value ('localhost') and the fact that it accepts a
comma-separated list.
* add ivorysql.enable_case_switch (bool, default on) and point to
section 7.3 for the identifier case conversion details.
* add a "Developer options" subsection documenting
allow_out_parameter_const, default_with_rowids,
enable_internal_warning, enable_seq_scale_fixed,
identifier_case_from_pg_dump, out_parameter_column_position and
rowid_seq_cache, noting that they are registered with
GUC_NO_SHOW_ALL (invisible in pg_settings) and are not written to
ivorysql.conf.sample.
Verified against a self-built IvorySQL 5.6 instance:
show ivorysql.listen_address; -> ERROR: unrecognized configuration parameter
show ivorysql.listen_addresses; -> localhost
show ivorysql.enable_case_switch; -> on
select count(*) from pg_settings where name like 'ivorysql.%'; -> 8
(the seven developer options are all counted 0 there)
Antora build before/after: the 7.2 table goes from 30 rows / 60 cells
to 39 rows / 86 cells, and the page gains one section (4 -> 5).
Closes IvorySQL#372
Signed-off-by: 王诗焱 <3372848903@qq.com>
|
🚀 IvorySQL-Docs Preview Ready
|
|
CLA: the Individual Contributor License Agreement for 王诗焱 (GitHub: qwer381) was signed and emailed to cla@ivorysql.org on 2026-11-10 (delivery confirmed by the mail provider). If the community needs it re-sent to another address, or needs a scanned wet signature instead of the typed one, say the word and I will send it again. |
|
Friendly ping — this PR plus #375, #377, #379 and #383 are all green ( One question that would help me align with your conventions: should these target |
b29ac50 to
1372aab
Compare
|
🚀 IvorySQL-Docs Preview Ready
|
|
🚀 IvorySQL-Docs Preview Ready
|
|
Correction to my comment of 2026-11-11: "re-targeting is a one-line change on my side" is not accurate, and I would rather fix that here than leave it standing.
The PR therefore stays on |
PR: docs(7.2): fix the
listen_addressesname, addenable_case_switch, document the developer-only GUCsCloses #372
Target branch:
v5.6. One commit, parent7c3f4a67— the currentv5.6head — and no conflicts against it.What this changes
One page pair, three corrections —
CN/modules/ROOT/pages/7.2.adocandEN/modules/ROOT/pages/7.2.adoc:ivorysql.listen_address→ivorysql.listen_addresses. The singular name does not exist on the server; the row now also states the default ('localhost') and that a comma-separated list of addresses is accepted.ivorysql.enable_case_switch(defaulton), cross-referencing7.3, which already documents the behaviour it controls.=== 开发者选项/=== Developer optionssubsection listing the 7 parameters registered asGUC_NO_SHOW_ALL | GUC_NOT_IN_SAMPLE, stating plainly that they do not appear inpg_settingsand are not written toivorysql.conf.sample.Diffstat:
No source code, no build files, no other pages. The
=== 实现 / === Achievesection is intentionally not touched: onv5.6the GUC definitions really are theIvy_ConfigureNamesBool/Int/String/Enumarrays insrc/backend/utils/misc/ivy_guc.c, so that text is correct for this branch (it changed only onmaster).Why
SHOW ivorysql.listen_address;fails on a 5.6 instance withERROR: unrecognized configuration parameter "ivorysql.listen_address"— the page currently hands users a name that cannot work. Inv5.6,Ivy_ConfigureNamesStringholds"ivorysql.listen_addresses"withGUC_LIST_INPUTand default"localhost".ivorysql.enable_case_switchisPGC_USERSETwith boot valuetrue; leaving it out of the only table that lists settableivorysql.*parameters makes that table incomplete.pg_settings(only 8 of the 15ivorysql.*entries are returned) nor inivorysql.conf.sample, so they are undiscoverable today. A separate subsection keeps the main table about everyday configuration while making them findable and clearly fenced off.Testing
1. Applies to the target branch
2. The page still builds — same generator as
.github/workflows/pr-preview.yml(Antora 3,start_path: CNandEN):npx antora antora-playbook.yml # exit 0Rendered
7.2.html, before → after (every warning in that build comes from pre-existing4.6.2.adoc/6.3.2.adoc/7.15.adoc; none from7.2.adoc):<tr><td><h3>7.2.html7.2.html+9rows = the new/renamed main-table rows plus the developer table (header + 7 rows);+1heading = the new subsection. CN and EN render identically, as intended.3. The behaviour claims hold on a running server — IvorySQL 5.6 built from tag
IvorySQL_5.6,initdb -m oracle,select version()→PostgreSQL 18.6 (IvorySQL 5.6) ... gcc 13.3.0:4. Both languages changed identically
Checklist
7.2onv5.6)v5.6, site builds, rendered row/heading deltas as statedCloses #372in the descriptionSigned-off-by(human submitter)