Repository navigation
Commit 4d165de
committed
docs(4.1): state ivorysql.conf.sample coverage (4 of 15 GUCs)
ivorysql.conf.sample is what initdb turns into ivorysql.conf on an
Oracle-mode cluster, and it is the only list of ivorysql.* parameters a
reader meets on the installation path. It shows four of them: three
commented examples (ivorysql.listen_addresses, ivorysql.port,
ivorysql.identifier_case_switch) and one active line
(ivorysql.enable_emptystring_to_NULL).
The other eleven are registered in src/backend/utils/misc/ivy_guc.c and
documented nowhere: "git grep -i 'conf\.sample'" over the whole v5.6
branch returns no hits, so nothing states how much of the parameter set
the sample covers or where the rest are described. Seven of the eleven
also carry GUC_NO_SHOW_ALL, so they are absent from SHOW ALL and from the
pg_settings view as well (8 rows for ivorysql.%, not 15), and two of them
cannot be set in a configuration file at all.
Add a "Configuration Files and Parameters" section to the installation
page (CN and EN), between "Start Database" and "Connecting to IvorySQL":
- where ivorysql.conf comes from: written by initdb from the share
directory sample, with only the Oracle port and
shared_preload_libraries replaced by the installation values, and
included from postgresql.conf by include_if_exists =
'ivorysql.conf'; commented out in PostgreSQL mode;
- the coverage: 4 of the 15 ivorysql.* parameters, which four, and that
only ivorysql.enable_emptystring_to_NULL is an active line;
- why the eleven stay out: they are registered with GUC_NOT_IN_SAMPLE,
and src/test/modules/test_misc/t/003_check_guc.pl asserts that the
parameters in the sample and the parameters without that flag are the
same set, so adding them by hand would fail the test;
- how to reach them instead: user-facing ones through SHOW / SET,
developer and diagnostic ones (GUC_NO_SHOW_ALL) through the
enumeration query, which returns 8 rows rather than 15 by default;
- a pointer to the parameter table in 7.2 "GUC框架" and to ivy_guc.c
(guc_parameters.dat on master) for the rows that table does not list.
Insertion only: 2 files changed, 52 insertions(+), 26 lines per language,
no existing line modified. Verified with four Antora builds (CN and EN,
base and patched, all exit 0), the same warning multiset as the baseline
(CN 4 to 4, EN 8 to 8, none from 4.1.adoc), identical rendered counters
in both languages (<h2> 9 to 10, id= 17 to 18, <pre> 29 to 30, tables
unchanged at 6 / 13 / 34), and a site-wide diff in which only
ivorysql-doc/v5.6/4.1.html changes.
Closes #3821 parent 7c3f4a6 commit 4d165de
2 files changed
Lines changed: 52 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
223 | 223 | | |
224 | 224 | | |
225 | 225 | | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
226 | 252 | | |
227 | 253 | | |
228 | 254 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
227 | 227 | | |
228 | 228 | | |
229 | 229 | | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
230 | 256 | | |
231 | 257 | | |
232 | 258 | | |
| |||
0 commit comments