pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
Mark a reloption as indexterm
17+ messages / 3 participants
[nested] [flat]

Commits from this thread:
  2019-04-16 c8e0f6bbdb  Add index terms for reloptions in documentation.
* Mark a reloption as indexterm
@ 2019-04-09 18:54 Fujii Masao <masao.fujii@gmail.com>
  2019-04-09 19:11 ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  0 siblings, 1 reply; 17+ messages in thread

From: Fujii Masao @ 2019-04-09 18:54 UTC (permalink / raw)
  To: pgsql-docs

Hi,

I'd like to propose to mark reloptions as indexterms, like GUC,
so that users can more easily search the pages describing
a reloption in document. Attached is the patch which does this.
Is this helpful? Thought?

Regards,

-- 
Fujii Masao

Attachments:

reloption-doc-v1.patch (application/octet-stream, 26.1K) download *** a/doc/src/sgml/config.sgml --- b/doc/src/sgml/config.sgml *************** *** 6934,6940 **** COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv; <varlistentry id="guc-log-autovacuum-min-duration" xreflabel="log_autovacuum_min_duration"> <term><varname>log_autovacuum_min_duration</varname> (<type>integer</type>) <indexterm> ! <primary><varname>log_autovacuum_min_duration</varname> configuration parameter</primary> </indexterm> </term> <listitem> --- 6934,6941 ---- <varlistentry id="guc-log-autovacuum-min-duration" xreflabel="log_autovacuum_min_duration"> <term><varname>log_autovacuum_min_duration</varname> (<type>integer</type>) <indexterm> ! <primary><varname>log_autovacuum_min_duration</varname></primary> ! <secondary>configuration parameter</secondary> </indexterm> </term> <listitem> *************** *** 6993,6999 **** COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv; <varlistentry id="guc-autovacuum-vacuum-threshold" xreflabel="autovacuum_vacuum_threshold"> <term><varname>autovacuum_vacuum_threshold</varname> (<type>integer</type>) <indexterm> ! <primary><varname>autovacuum_vacuum_threshold</varname> configuration parameter</primary> </indexterm> </term> <listitem> --- 6994,7001 ---- <varlistentry id="guc-autovacuum-vacuum-threshold" xreflabel="autovacuum_vacuum_threshold"> <term><varname>autovacuum_vacuum_threshold</varname> (<type>integer</type>) <indexterm> ! <primary><varname>autovacuum_vacuum_threshold</varname></primary> ! <secondary>configuration parameter</secondary> </indexterm> </term> <listitem> *************** *** 7012,7018 **** COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv; <varlistentry id="guc-autovacuum-analyze-threshold" xreflabel="autovacuum_analyze_threshold"> <term><varname>autovacuum_analyze_threshold</varname> (<type>integer</type>) <indexterm> ! <primary><varname>autovacuum_analyze_threshold</varname> configuration parameter</primary> </indexterm> </term> <listitem> --- 7014,7021 ---- <varlistentry id="guc-autovacuum-analyze-threshold" xreflabel="autovacuum_analyze_threshold"> <term><varname>autovacuum_analyze_threshold</varname> (<type>integer</type>) <indexterm> ! <primary><varname>autovacuum_analyze_threshold</varname></primary> ! <secondary>configuration parameter</secondary> </indexterm> </term> <listitem> *************** *** 7031,7037 **** COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv; <varlistentry id="guc-autovacuum-vacuum-scale-factor" xreflabel="autovacuum_vacuum_scale_factor"> <term><varname>autovacuum_vacuum_scale_factor</varname> (<type>floating point</type>) <indexterm> ! <primary><varname>autovacuum_vacuum_scale_factor</varname> configuration parameter</primary> </indexterm> </term> <listitem> --- 7034,7041 ---- <varlistentry id="guc-autovacuum-vacuum-scale-factor" xreflabel="autovacuum_vacuum_scale_factor"> <term><varname>autovacuum_vacuum_scale_factor</varname> (<type>floating point</type>) <indexterm> ! <primary><varname>autovacuum_vacuum_scale_factor</varname></primary> ! <secondary>configuration parameter</secondary> </indexterm> </term> <listitem> *************** *** 7051,7057 **** COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv; <varlistentry id="guc-autovacuum-analyze-scale-factor" xreflabel="autovacuum_analyze_scale_factor"> <term><varname>autovacuum_analyze_scale_factor</varname> (<type>floating point</type>) <indexterm> ! <primary><varname>autovacuum_analyze_scale_factor</varname> configuration parameter</primary> </indexterm> </term> <listitem> --- 7055,7062 ---- <varlistentry id="guc-autovacuum-analyze-scale-factor" xreflabel="autovacuum_analyze_scale_factor"> <term><varname>autovacuum_analyze_scale_factor</varname> (<type>floating point</type>) <indexterm> ! <primary><varname>autovacuum_analyze_scale_factor</varname></primary> ! <secondary>configuration parameter</secondary> </indexterm> </term> <listitem> *************** *** 7071,7077 **** COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv; <varlistentry id="guc-autovacuum-freeze-max-age" xreflabel="autovacuum_freeze_max_age"> <term><varname>autovacuum_freeze_max_age</varname> (<type>integer</type>) <indexterm> ! <primary><varname>autovacuum_freeze_max_age</varname> configuration parameter</primary> </indexterm> </term> <listitem> --- 7076,7083 ---- <varlistentry id="guc-autovacuum-freeze-max-age" xreflabel="autovacuum_freeze_max_age"> <term><varname>autovacuum_freeze_max_age</varname> (<type>integer</type>) <indexterm> ! <primary><varname>autovacuum_freeze_max_age</varname></primary> ! <secondary>configuration parameter</secondary> </indexterm> </term> <listitem> *************** *** 7099,7105 **** COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv; <varlistentry id="guc-autovacuum-multixact-freeze-max-age" xreflabel="autovacuum_multixact_freeze_max_age"> <term><varname>autovacuum_multixact_freeze_max_age</varname> (<type>integer</type>) <indexterm> ! <primary><varname>autovacuum_multixact_freeze_max_age</varname> configuration parameter</primary> </indexterm> </term> <listitem> --- 7105,7112 ---- <varlistentry id="guc-autovacuum-multixact-freeze-max-age" xreflabel="autovacuum_multixact_freeze_max_age"> <term><varname>autovacuum_multixact_freeze_max_age</varname> (<type>integer</type>) <indexterm> ! <primary><varname>autovacuum_multixact_freeze_max_age</varname></primary> ! <secondary>configuration parameter</secondary> </indexterm> </term> <listitem> *************** *** 7127,7133 **** COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv; <varlistentry id="guc-autovacuum-vacuum-cost-delay" xreflabel="autovacuum_vacuum_cost_delay"> <term><varname>autovacuum_vacuum_cost_delay</varname> (<type>floating point</type>) <indexterm> ! <primary><varname>autovacuum_vacuum_cost_delay</varname> configuration parameter</primary> </indexterm> </term> <listitem> --- 7134,7141 ---- <varlistentry id="guc-autovacuum-vacuum-cost-delay" xreflabel="autovacuum_vacuum_cost_delay"> <term><varname>autovacuum_vacuum_cost_delay</varname> (<type>floating point</type>) <indexterm> ! <primary><varname>autovacuum_vacuum_cost_delay</varname></primary> ! <secondary>configuration parameter</secondary> </indexterm> </term> <listitem> *************** *** 7147,7153 **** COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv; <varlistentry id="guc-autovacuum-vacuum-cost-limit" xreflabel="autovacuum_vacuum_cost_limit"> <term><varname>autovacuum_vacuum_cost_limit</varname> (<type>integer</type>) <indexterm> ! <primary><varname>autovacuum_vacuum_cost_limit</varname> configuration parameter</primary> </indexterm> </term> <listitem> --- 7155,7162 ---- <varlistentry id="guc-autovacuum-vacuum-cost-limit" xreflabel="autovacuum_vacuum_cost_limit"> <term><varname>autovacuum_vacuum_cost_limit</varname> (<type>integer</type>) <indexterm> ! <primary><varname>autovacuum_vacuum_cost_limit</varname></primary> ! <secondary>configuration parameter</secondary> </indexterm> </term> <listitem> *** a/doc/src/sgml/ref/create_table.sgml --- b/doc/src/sgml/ref/create_table.sgml *************** *** 1316,1323 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM <variablelist> ! <varlistentry> ! <term><literal>fillfactor</literal> (<type>integer</type>)</term> <listitem> <para> The fillfactor for a table is a percentage between 10 and 100. --- 1316,1327 ---- <variablelist> ! <varlistentry id="reloption-fillfactor" xreflabel="fillfactor"> ! <term><varname>fillfactor</varname> (<type>integer</type>) ! <indexterm> ! <primary><varname>fillfactor</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> The fillfactor for a table is a percentage between 10 and 100. *************** *** 1334,1341 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>toast_tuple_target</literal> (<type>integer</type>)</term> <listitem> <para> The toast_tuple_target specifies the minimum tuple length required before --- 1338,1349 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-toast-tuple-target" xreflabel="toast_tuple_target"> ! <term><literal>toast_tuple_target</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>toast_tuple_target</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> The toast_tuple_target specifies the minimum tuple length required before *************** *** 1355,1362 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>parallel_workers</literal> (<type>integer</type>)</term> <listitem> <para> This sets the number of workers that should be used to assist a parallel --- 1363,1374 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-parallel-workers" xreflabel="parallel_workers"> ! <term><literal>parallel_workers</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>parallel_workers</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> This sets the number of workers that should be used to assist a parallel *************** *** 1368,1375 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_enabled</literal>, <literal>toast.autovacuum_enabled</literal> (<type>boolean</type>)</term> <listitem> <para> Enables or disables the autovacuum daemon for a particular table. --- 1380,1391 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-enabled" xreflabel="autovacuum_enabled"> ! <term><literal>autovacuum_enabled</literal>, <literal>toast.autovacuum_enabled</literal> (<type>boolean</type>) ! <indexterm> ! <primary><varname>autovacuum_enabled</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> Enables or disables the autovacuum daemon for a particular table. *************** *** 1389,1396 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>vacuum_index_cleanup</literal> (<type>boolean</type>)</term> <listitem> <para> Enables or disables index cleanup when <command>VACUUM</command> is --- 1405,1416 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-vacuum-index-cleanup" xreflabel="vacuum_index_cleanup"> ! <term><literal>vacuum_index_cleanup</literal> (<type>boolean</type>) ! <indexterm> ! <primary><varname>vacuum_index_cleanup</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> Enables or disables index cleanup when <command>VACUUM</command> is *************** *** 1404,1411 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>vacuum_truncate</literal>, <literal>toast.vacuum_truncate</literal> (<type>boolean</type>)</term> <listitem> <para> Enables or disables vacuum to try to truncate off any empty pages --- 1424,1435 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-vacuum-truncate" xreflabel="vacuum_truncate"> ! <term><literal>vacuum_truncate</literal>, <literal>toast.vacuum_truncate</literal> (<type>boolean</type>) ! <indexterm> ! <primary><varname>vacuum_truncate</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> Enables or disables vacuum to try to truncate off any empty pages *************** *** 1419,1426 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_vacuum_threshold</literal>, <literal>toast.autovacuum_vacuum_threshold</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-vacuum-threshold"/> --- 1443,1455 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-vacuum-threshold" xreflabel="autovacuum_vacuum_threshold"> ! <term><literal>autovacuum_vacuum_threshold</literal>, <literal>toast.autovacuum_vacuum_threshold</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_vacuum_threshold</varname></primary> ! <secondary>storage parameter</secondary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-vacuum-threshold"/> *************** *** 1429,1436 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_vacuum_scale_factor</literal>, <literal>toast.autovacuum_vacuum_scale_factor</literal> (<type>float4</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-vacuum-scale-factor"/> --- 1458,1470 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-vauum-scale-factor" xreflabel="autovacuum_vacuum_scale_factor"> ! <term><literal>autovacuum_vacuum_scale_factor</literal>, <literal>toast.autovacuum_vacuum_scale_factor</literal> (<type>float4</type>) ! <indexterm> ! <primary><varname>autovacuum_vacuum_scale_factor</varname> </primary> ! <secondary>storage parameter</secondary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-vacuum-scale-factor"/> *************** *** 1439,1446 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_analyze_threshold</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-analyze-threshold"/> --- 1473,1485 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-analyze-threshold" xreflabel="autovacuum_analyze_threshold"> ! <term><literal>autovacuum_analyze_threshold</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_analyze_threshold</varname></primary> ! <secondary>storage parameter</secondary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-analyze-threshold"/> *************** *** 1449,1456 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_analyze_scale_factor</literal> (<type>float4</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-analyze-scale-factor"/> --- 1488,1500 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-analyze-scale-factor" xreflabel="autovacuum_analyze_scale_factor"> ! <term><literal>autovacuum_analyze_scale_factor</literal> (<type>float4</type>) ! <indexterm> ! <primary><varname>autovacuum_analyze_scale_factor</varname></primary> ! <secondary>storage parameter</secondary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-analyze-scale-factor"/> *************** *** 1459,1466 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_vacuum_cost_delay</literal>, <literal>toast.autovacuum_vacuum_cost_delay</literal> (<type>floating point</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-vacuum-cost-delay"/> --- 1503,1515 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-vacuum-cost-delay" xreflabel="autovacuum_vacuum_cost_delay"> ! <term><literal>autovacuum_vacuum_cost_delay</literal>, <literal>toast.autovacuum_vacuum_cost_delay</literal> (<type>floating point</type>) ! <indexterm> ! <primary><varname>autovacuum_vacuum_cost_delay</varname></primary> ! <secondary>storage parameter</secondary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-vacuum-cost-delay"/> *************** *** 1469,1476 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_vacuum_cost_limit</literal>, <literal>toast.autovacuum_vacuum_cost_limit</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-vacuum-cost-limit"/> --- 1518,1530 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-vauum-cost-limit" xreflabel="autovacuum_vacuum_cost_limit"> ! <term><literal>autovacuum_vacuum_cost_limit</literal>, <literal>toast.autovacuum_vacuum_cost_limit</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_vacuum_cost_limit</varname></primary> ! <secondary>storage parameter</secondary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-vacuum-cost-limit"/> *************** *** 1479,1486 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_freeze_min_age</literal>, <literal>toast.autovacuum_freeze_min_age</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-vacuum-freeze-min-age"/> --- 1533,1544 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-freeze-min-age" xreflabel="autovacuum_freeze_min_age"> ! <term><literal>autovacuum_freeze_min_age</literal>, <literal>toast.autovacuum_freeze_min_age</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_freeze_min_age</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-vacuum-freeze-min-age"/> *************** *** 1492,1499 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_freeze_max_age</literal>, <literal>toast.autovacuum_freeze_max_age</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-freeze-max-age"/> --- 1550,1562 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-freeze-max-age" xreflabel="autovacuum_freeze_max_age"> ! <term><literal>autovacuum_freeze_max_age</literal>, <literal>toast.autovacuum_freeze_max_age</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_freeze_max_age</varname></primary> ! <secondary>storage parameter</secondary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-freeze-max-age"/> *************** *** 1504,1511 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_freeze_table_age</literal>, <literal>toast.autovacuum_freeze_table_age</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-vacuum-freeze-table-age"/> --- 1567,1578 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-freeze-table-age" xreflabel="autovacuum_freeze_table_age"> ! <term><literal>autovacuum_freeze_table_age</literal>, <literal>toast.autovacuum_freeze_table_age</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_freeze_table_age</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-vacuum-freeze-table-age"/> *************** *** 1514,1521 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_multixact_freeze_min_age</literal>, <literal>toast.autovacuum_multixact_freeze_min_age</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-vacuum-multixact-freeze-min-age"/> --- 1581,1592 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-multixact-freeze-min-age" xreflabel="autovacuum_multixact_freeze_min_age"> ! <term><literal>autovacuum_multixact_freeze_min_age</literal>, <literal>toast.autovacuum_multixact_freeze_min_age</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_multixact_freeze_min_age</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-vacuum-multixact-freeze-min-age"/> *************** *** 1528,1535 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_multixact_freeze_max_age</literal>, <literal>toast.autovacuum_multixact_freeze_max_age</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value --- 1599,1611 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-multixact-freeze-max-age" xreflabel="autovacuum_multixact_freeze_max_age"> ! <term><literal>autovacuum_multixact_freeze_max_age</literal>, <literal>toast.autovacuum_multixact_freeze_max_age</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_multixact_freeze_max_age</varname></primary> ! <secondary>storage parameter</secondary> ! </indexterm> ! </term> <listitem> <para> Per-table value *************** *** 1542,1549 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_multixact_freeze_table_age</literal>, <literal>toast.autovacuum_multixact_freeze_table_age</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value --- 1618,1629 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-multixact-freeze-table-age" xreflabel="autovacuum_multixact_freeze_table_age"> ! <term><literal>autovacuum_multixact_freeze_table_age</literal>, <literal>toast.autovacuum_multixact_freeze_table_age</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_multixact_freeze_table_age</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> Per-table value *************** *** 1552,1559 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>log_autovacuum_min_duration</literal>, <literal>toast.log_autovacuum_min_duration</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-log-autovacuum-min-duration"/> --- 1632,1644 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-log-autovacuum-min-duration" xreflabel="log_autovacuum_min_duration"> ! <term><literal>log_autovacuum_min_duration</literal>, <literal>toast.log_autovacuum_min_duration</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>log_autovacuum_min_duration</varname></primary> ! <secondary>storage parameter</secondary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-log-autovacuum-min-duration"/> *************** *** 1562,1569 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>user_catalog_table</literal> (<type>boolean</type>)</term> <listitem> <para> Declare the table as an additional catalog table for purposes of --- 1647,1658 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-user-catalog-table" xreflabel="user_catalog_table"> ! <term><literal>user_catalog_table</literal> (<type>boolean</type>) ! <indexterm> ! <primary><varname>user_catalog_table</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> Declare the table as an additional catalog table for purposes of
^ permalink raw reply [nested|flat] 17+ messages in thread

* Re: Mark a reloption as indexterm
  2019-04-09 18:54 Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
@ 2019-04-09 19:11 ` Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-12 03:33   ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  0 siblings, 1 reply; 17+ messages in thread

From: Alvaro Herrera @ 2019-04-09 19:11 UTC (permalink / raw)
  To: Fujii Masao <masao.fujii@gmail.com>; +Cc: pgsql-docs

On 2019-Apr-10, Fujii Masao wrote:

> Hi,
> 
> I'd like to propose to mark reloptions as indexterms, like GUC,
> so that users can more easily search the pages describing
> a reloption in document. Attached is the patch which does this.
> Is this helpful? Thought?

+1 for adding index entries to all reloptions.  I'm not sure what you're
achieving by splitting the text for some existing index entries in two
and putting two words in the <secondary> that were part of the
<primary>, though.  I'd just put the whole text in <primary> (obviously
the option name must be the first word of that).

-- 
Álvaro Herrera                https://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services





^ permalink  raw  reply  [nested|flat] 17+ messages in thread

* Re: Mark a reloption as indexterm
  2019-04-09 18:54 Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-09 19:11 ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
@ 2019-04-12 03:33   ` Fujii Masao <masao.fujii@gmail.com>
  2019-04-12 03:52     ` Re: Mark a reloption as indexterm Michael Paquier <michael@paquier.xyz>
  2019-04-12 03:54     ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  0 siblings, 2 replies; 17+ messages in thread

From: Fujii Masao @ 2019-04-12 03:33 UTC (permalink / raw)
  To: Alvaro Herrera <alvherre@2ndquadrant.com>; +Cc: pgsql-docs

On Wed, Apr 10, 2019 at 4:11 AM Alvaro Herrera <alvherre@2ndquadrant.com> wrote:
>
> On 2019-Apr-10, Fujii Masao wrote:
>
> > Hi,
> >
> > I'd like to propose to mark reloptions as indexterms, like GUC,
> > so that users can more easily search the pages describing
> > a reloption in document. Attached is the patch which does this.
> > Is this helpful? Thought?
>
> +1 for adding index entries to all reloptions.  I'm not sure what you're
> achieving by splitting the text for some existing index entries in two
> and putting two words in the <secondary> that were part of the
> <primary>, though.  I'd just put the whole text in <primary> (obviously
> the option name must be the first word of that).

Indeed. Attached is the updated version of the patch.

Regards,

-- 
Fujii Masao

Attachments:

reloption-doc-v2.patch (application/octet-stream, 18.2K) download *** a/doc/src/sgml/ref/create_table.sgml --- b/doc/src/sgml/ref/create_table.sgml *************** *** 1316,1323 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM <variablelist> ! <varlistentry> ! <term><literal>fillfactor</literal> (<type>integer</type>)</term> <listitem> <para> The fillfactor for a table is a percentage between 10 and 100. --- 1316,1327 ---- <variablelist> ! <varlistentry id="reloption-fillfactor" xreflabel="fillfactor"> ! <term><varname>fillfactor</varname> (<type>integer</type>) ! <indexterm> ! <primary><varname>fillfactor</varname> configuration parameter</primary> ! </indexterm> ! </term> <listitem> <para> The fillfactor for a table is a percentage between 10 and 100. *************** *** 1334,1341 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>toast_tuple_target</literal> (<type>integer</type>)</term> <listitem> <para> The toast_tuple_target specifies the minimum tuple length required before --- 1338,1349 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-toast-tuple-target" xreflabel="toast_tuple_target"> ! <term><literal>toast_tuple_target</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>toast_tuple_target</varname> configuration parameter</primary> ! </indexterm> ! </term> <listitem> <para> The toast_tuple_target specifies the minimum tuple length required before *************** *** 1355,1362 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>parallel_workers</literal> (<type>integer</type>)</term> <listitem> <para> This sets the number of workers that should be used to assist a parallel --- 1363,1374 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-parallel-workers" xreflabel="parallel_workers"> ! <term><literal>parallel_workers</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>parallel_workers</varname> configuration parameter</primary> ! </indexterm> ! </term> <listitem> <para> This sets the number of workers that should be used to assist a parallel *************** *** 1368,1375 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_enabled</literal>, <literal>toast.autovacuum_enabled</literal> (<type>boolean</type>)</term> <listitem> <para> Enables or disables the autovacuum daemon for a particular table. --- 1380,1391 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-enabled" xreflabel="autovacuum_enabled"> ! <term><literal>autovacuum_enabled</literal>, <literal>toast.autovacuum_enabled</literal> (<type>boolean</type>) ! <indexterm> ! <primary><varname>autovacuum_enabled</varname> configuration parameter</primary> ! </indexterm> ! </term> <listitem> <para> Enables or disables the autovacuum daemon for a particular table. *************** *** 1389,1396 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>vacuum_index_cleanup</literal> (<type>boolean</type>)</term> <listitem> <para> Enables or disables index cleanup when <command>VACUUM</command> is --- 1405,1416 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-vacuum-index-cleanup" xreflabel="vacuum_index_cleanup"> ! <term><literal>vacuum_index_cleanup</literal> (<type>boolean</type>) ! <indexterm> ! <primary><varname>vacuum_index_cleanup</varname> configuration parameter</primary> ! </indexterm> ! </term> <listitem> <para> Enables or disables index cleanup when <command>VACUUM</command> is *************** *** 1404,1411 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>vacuum_truncate</literal>, <literal>toast.vacuum_truncate</literal> (<type>boolean</type>)</term> <listitem> <para> Enables or disables vacuum to try to truncate off any empty pages --- 1424,1435 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-vacuum-truncate" xreflabel="vacuum_truncate"> ! <term><literal>vacuum_truncate</literal>, <literal>toast.vacuum_truncate</literal> (<type>boolean</type>) ! <indexterm> ! <primary><varname>vacuum_truncate</varname> configuration parameter</primary> ! </indexterm> ! </term> <listitem> <para> Enables or disables vacuum to try to truncate off any empty pages *************** *** 1419,1426 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_vacuum_threshold</literal>, <literal>toast.autovacuum_vacuum_threshold</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-vacuum-threshold"/> --- 1443,1454 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-vacuum-threshold" xreflabel="autovacuum_vacuum_threshold"> ! <term><literal>autovacuum_vacuum_threshold</literal>, <literal>toast.autovacuum_vacuum_threshold</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_vacuum_threshold</varname> configuration parameter</primary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-vacuum-threshold"/> *************** *** 1429,1436 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_vacuum_scale_factor</literal>, <literal>toast.autovacuum_vacuum_scale_factor</literal> (<type>float4</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-vacuum-scale-factor"/> --- 1457,1468 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-vauum-scale-factor" xreflabel="autovacuum_vacuum_scale_factor"> ! <term><literal>autovacuum_vacuum_scale_factor</literal>, <literal>toast.autovacuum_vacuum_scale_factor</literal> (<type>float4</type>) ! <indexterm> ! <primary><varname>autovacuum_vacuum_scale_factor</varname> configuration parameter</primary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-vacuum-scale-factor"/> *************** *** 1439,1446 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_analyze_threshold</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-analyze-threshold"/> --- 1471,1482 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-analyze-threshold" xreflabel="autovacuum_analyze_threshold"> ! <term><literal>autovacuum_analyze_threshold</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_analyze_threshold</varname> configuration parameter</primary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-analyze-threshold"/> *************** *** 1449,1456 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_analyze_scale_factor</literal> (<type>float4</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-analyze-scale-factor"/> --- 1485,1496 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-analyze-scale-factor" xreflabel="autovacuum_analyze_scale_factor"> ! <term><literal>autovacuum_analyze_scale_factor</literal> (<type>float4</type>) ! <indexterm> ! <primary><varname>autovacuum_analyze_scale_factor</varname> configuration parameter</primary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-analyze-scale-factor"/> *************** *** 1459,1466 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_vacuum_cost_delay</literal>, <literal>toast.autovacuum_vacuum_cost_delay</literal> (<type>floating point</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-vacuum-cost-delay"/> --- 1499,1510 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-vacuum-cost-delay" xreflabel="autovacuum_vacuum_cost_delay"> ! <term><literal>autovacuum_vacuum_cost_delay</literal>, <literal>toast.autovacuum_vacuum_cost_delay</literal> (<type>floating point</type>) ! <indexterm> ! <primary><varname>autovacuum_vacuum_cost_delay</varname> configuration parameter</primary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-vacuum-cost-delay"/> *************** *** 1469,1476 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_vacuum_cost_limit</literal>, <literal>toast.autovacuum_vacuum_cost_limit</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-vacuum-cost-limit"/> --- 1513,1524 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-vauum-cost-limit" xreflabel="autovacuum_vacuum_cost_limit"> ! <term><literal>autovacuum_vacuum_cost_limit</literal>, <literal>toast.autovacuum_vacuum_cost_limit</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_vacuum_cost_limit</varname> configuration parameter</primary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-vacuum-cost-limit"/> *************** *** 1479,1486 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_freeze_min_age</literal>, <literal>toast.autovacuum_freeze_min_age</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-vacuum-freeze-min-age"/> --- 1527,1538 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-freeze-min-age" xreflabel="autovacuum_freeze_min_age"> ! <term><literal>autovacuum_freeze_min_age</literal>, <literal>toast.autovacuum_freeze_min_age</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_freeze_min_age</varname> configuration parameter</primary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-vacuum-freeze-min-age"/> *************** *** 1492,1499 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_freeze_max_age</literal>, <literal>toast.autovacuum_freeze_max_age</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-freeze-max-age"/> --- 1544,1555 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-freeze-max-age" xreflabel="autovacuum_freeze_max_age"> ! <term><literal>autovacuum_freeze_max_age</literal>, <literal>toast.autovacuum_freeze_max_age</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_freeze_max_age</varname> configuration parameter</primary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-freeze-max-age"/> *************** *** 1504,1511 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_freeze_table_age</literal>, <literal>toast.autovacuum_freeze_table_age</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-vacuum-freeze-table-age"/> --- 1560,1571 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-freeze-table-age" xreflabel="autovacuum_freeze_table_age"> ! <term><literal>autovacuum_freeze_table_age</literal>, <literal>toast.autovacuum_freeze_table_age</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_freeze_table_age</varname> configuration parameter</primary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-vacuum-freeze-table-age"/> *************** *** 1514,1521 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_multixact_freeze_min_age</literal>, <literal>toast.autovacuum_multixact_freeze_min_age</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-vacuum-multixact-freeze-min-age"/> --- 1574,1585 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-multixact-freeze-min-age" xreflabel="autovacuum_multixact_freeze_min_age"> ! <term><literal>autovacuum_multixact_freeze_min_age</literal>, <literal>toast.autovacuum_multixact_freeze_min_age</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_multixact_freeze_min_age</varname> configuration parameter</primary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-vacuum-multixact-freeze-min-age"/> *************** *** 1528,1535 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_multixact_freeze_max_age</literal>, <literal>toast.autovacuum_multixact_freeze_max_age</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value --- 1592,1603 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-multixact-freeze-max-age" xreflabel="autovacuum_multixact_freeze_max_age"> ! <term><literal>autovacuum_multixact_freeze_max_age</literal>, <literal>toast.autovacuum_multixact_freeze_max_age</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_multixact_freeze_max_age</varname> configuration parameter</primary> ! </indexterm> ! </term> <listitem> <para> Per-table value *************** *** 1542,1549 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_multixact_freeze_table_age</literal>, <literal>toast.autovacuum_multixact_freeze_table_age</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value --- 1610,1621 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-multixact-freeze-table-age" xreflabel="autovacuum_multixact_freeze_table_age"> ! <term><literal>autovacuum_multixact_freeze_table_age</literal>, <literal>toast.autovacuum_multixact_freeze_table_age</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_multixact_freeze_table_age</varname> configuration parameter</primary> ! </indexterm> ! </term> <listitem> <para> Per-table value *************** *** 1552,1559 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>log_autovacuum_min_duration</literal>, <literal>toast.log_autovacuum_min_duration</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-log-autovacuum-min-duration"/> --- 1624,1635 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-log-autovacuum-min-duration" xreflabel="log_autovacuum_min_duration"> ! <term><literal>log_autovacuum_min_duration</literal>, <literal>toast.log_autovacuum_min_duration</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>log_autovacuum_min_duration</varname> configuration parameter</primary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-log-autovacuum-min-duration"/> *************** *** 1562,1569 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>user_catalog_table</literal> (<type>boolean</type>)</term> <listitem> <para> Declare the table as an additional catalog table for purposes of --- 1638,1649 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-user-catalog-table" xreflabel="user_catalog_table"> ! <term><literal>user_catalog_table</literal> (<type>boolean</type>) ! <indexterm> ! <primary><varname>user_catalog_table</varname> configuration parameter</primary> ! </indexterm> ! </term> <listitem> <para> Declare the table as an additional catalog table for purposes of
^ permalink raw reply [nested|flat] 17+ messages in thread

* Re: Mark a reloption as indexterm
  2019-04-09 18:54 Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-09 19:11 ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-12 03:33   ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
@ 2019-04-12 03:52     ` Michael Paquier <michael@paquier.xyz>
  2019-04-12 03:57       ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  1 sibling, 1 reply; 17+ messages in thread

From: Michael Paquier @ 2019-04-12 03:52 UTC (permalink / raw)
  To: Fujii Masao <masao.fujii@gmail.com>; +Cc: Alvaro Herrera <alvherre@2ndquadrant.com>; pgsql-docs

On Fri, Apr 12, 2019 at 12:33:45PM +0900, Fujii Masao wrote:
> Indeed. Attached is the updated version of the patch.

On top of what Alvaro has mentioned, it seems to me that we should
make the difference between table-level configuration parameter and
index-level configuration parameters, and also add <primary> markups
to create_index.sgml.  If you take the example of fillfactor, it
applies to both indexes and tables, but with your patch you just
define "configuration parameter", and point to only CREATE TABLE.
--
Michael

Attachments:

  signature.asc (application/pgp-signature, 832B) download

^ permalink  raw  reply  [nested|flat] 17+ messages in thread

* Re: Mark a reloption as indexterm
  2019-04-09 18:54 Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-09 19:11 ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-12 03:33   ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-12 03:52     ` Re: Mark a reloption as indexterm Michael Paquier <michael@paquier.xyz>
@ 2019-04-12 03:57       ` Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-12 04:09         ` Re: Mark a reloption as indexterm Michael Paquier <michael@paquier.xyz>
  0 siblings, 1 reply; 17+ messages in thread

From: Alvaro Herrera @ 2019-04-12 03:57 UTC (permalink / raw)
  To: Michael Paquier <michael@paquier.xyz>; +Cc: Fujii Masao <masao.fujii@gmail.com>; pgsql-docs

On 2019-Apr-12, Michael Paquier wrote:

> On Fri, Apr 12, 2019 at 12:33:45PM +0900, Fujii Masao wrote:
> > Indeed. Attached is the updated version of the patch.
> 
> On top of what Alvaro has mentioned, it seems to me that we should
> make the difference between table-level configuration parameter and
> index-level configuration parameters, and also add <primary> markups
> to create_index.sgml.  If you take the example of fillfactor, it
> applies to both indexes and tables, but with your patch you just
> define "configuration parameter", and point to only CREATE TABLE.

Are you suggesting that it should show "index storage parameters" and
"table storage parameters"?  I'm not sure about that myself ...
particularly considering that certain parameters might apply to some
index AMs and not others.

BTW what about the index-specific options such as, say, BRIN's
pages_per_range?  I know other AMs have their own reloptions ...

-- 
Álvaro Herrera                https://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services





^ permalink  raw  reply  [nested|flat] 17+ messages in thread

* Re: Mark a reloption as indexterm
  2019-04-09 18:54 Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-09 19:11 ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-12 03:33   ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-12 03:52     ` Re: Mark a reloption as indexterm Michael Paquier <michael@paquier.xyz>
  2019-04-12 03:57       ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
@ 2019-04-12 04:09         ` Michael Paquier <michael@paquier.xyz>
  2019-04-12 04:43           ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  0 siblings, 1 reply; 17+ messages in thread

From: Michael Paquier @ 2019-04-12 04:09 UTC (permalink / raw)
  To: Alvaro Herrera <alvherre@2ndquadrant.com>; +Cc: Fujii Masao <masao.fujii@gmail.com>; pgsql-docs

On Thu, Apr 11, 2019 at 11:57:32PM -0400, Alvaro Herrera wrote:
> Are you suggesting that it should show "index storage parameters" and
> "table storage parameters"?  I'm not sure about that myself ...
> particularly considering that certain parameters might apply to some
> index AMs and not others.

Yes, that's exactly what I was suggesting: putting all the
index-related parameters into an index bucket, without caring about
the AM involved.
--
Michael

Attachments:

  signature.asc (application/pgp-signature, 832B) download

^ permalink  raw  reply  [nested|flat] 17+ messages in thread

* Re: Mark a reloption as indexterm
  2019-04-09 18:54 Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-09 19:11 ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-12 03:33   ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-12 03:52     ` Re: Mark a reloption as indexterm Michael Paquier <michael@paquier.xyz>
  2019-04-12 03:57       ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-12 04:09         ` Re: Mark a reloption as indexterm Michael Paquier <michael@paquier.xyz>
@ 2019-04-12 04:43           ` Fujii Masao <masao.fujii@gmail.com>
  0 siblings, 0 replies; 17+ messages in thread

From: Fujii Masao @ 2019-04-12 04:43 UTC (permalink / raw)
  To: Michael Paquier <michael@paquier.xyz>; +Cc: Alvaro Herrera <alvherre@2ndquadrant.com>; pgsql-docs

On Fri, Apr 12, 2019 at 1:09 PM Michael Paquier <michael@paquier.xyz> wrote:
>
> On Thu, Apr 11, 2019 at 11:57:32PM -0400, Alvaro Herrera wrote:
> > Are you suggesting that it should show "index storage parameters" and
> > "table storage parameters"?  I'm not sure about that myself ...
> > particularly considering that certain parameters might apply to some
> > index AMs and not others.
>
> Yes, that's exactly what I was suggesting: putting all the
> index-related parameters into an index bucket, without caring about
> the AM involved.

+1

While reading the doc for index reloptins, I found that there is
no information about the type for each index reloption in the doc.
Probably it's worth adding that information, like the doc for table
reloptions have.

Regards,

-- 
Fujii Masao





^ permalink  raw  reply  [nested|flat] 17+ messages in thread

* Re: Mark a reloption as indexterm
  2019-04-09 18:54 Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-09 19:11 ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-12 03:33   ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
@ 2019-04-12 03:54     ` Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-12 04:37       ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  1 sibling, 1 reply; 17+ messages in thread

From: Alvaro Herrera @ 2019-04-12 03:54 UTC (permalink / raw)
  To: Fujii Masao <masao.fujii@gmail.com>; +Cc: pgsql-docs

On 2019-Apr-12, Fujii Masao wrote:

> On Wed, Apr 10, 2019 at 4:11 AM Alvaro Herrera <alvherre@2ndquadrant.com> wrote:
> >
> > On 2019-Apr-10, Fujii Masao wrote:
> >
> > > Hi,
> > >
> > > I'd like to propose to mark reloptions as indexterms, like GUC,
> > > so that users can more easily search the pages describing
> > > a reloption in document. Attached is the patch which does this.
> > > Is this helpful? Thought?
> >
> > +1 for adding index entries to all reloptions.  I'm not sure what you're
> > achieving by splitting the text for some existing index entries in two
> > and putting two words in the <secondary> that were part of the
> > <primary>, though.  I'd just put the whole text in <primary> (obviously
> > the option name must be the first word of that).
> 
> Indeed. Attached is the updated version of the patch.

Hmm, actually, I now see you were originally proposing the words
"storage parameter" for the fillfactor index entries, but for v2 you
instead copied the "configuration parameter" words that was in some
other of the older entries.  I think "configuration parameter" is wrong
(we use that for GUCs, and it seems to me that it would be confusing to
mix both things), and we should use the words "storage parameter" for
all of these, don't you think?

-- 
Álvaro Herrera                https://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services





^ permalink  raw  reply  [nested|flat] 17+ messages in thread

* Re: Mark a reloption as indexterm
  2019-04-09 18:54 Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-09 19:11 ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-12 03:33   ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-12 03:54     ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
@ 2019-04-12 04:37       ` Fujii Masao <masao.fujii@gmail.com>
  2019-04-12 16:30         ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  0 siblings, 1 reply; 17+ messages in thread

From: Fujii Masao @ 2019-04-12 04:37 UTC (permalink / raw)
  To: Alvaro Herrera <alvherre@2ndquadrant.com>; +Cc: pgsql-docs

On Fri, Apr 12, 2019 at 12:54 PM Alvaro Herrera
<alvherre@2ndquadrant.com> wrote:
>
> On 2019-Apr-12, Fujii Masao wrote:
>
> > On Wed, Apr 10, 2019 at 4:11 AM Alvaro Herrera <alvherre@2ndquadrant.com> wrote:
> > >
> > > On 2019-Apr-10, Fujii Masao wrote:
> > >
> > > > Hi,
> > > >
> > > > I'd like to propose to mark reloptions as indexterms, like GUC,
> > > > so that users can more easily search the pages describing
> > > > a reloption in document. Attached is the patch which does this.
> > > > Is this helpful? Thought?
> > >
> > > +1 for adding index entries to all reloptions.  I'm not sure what you're
> > > achieving by splitting the text for some existing index entries in two
> > > and putting two words in the <secondary> that were part of the
> > > <primary>, though.  I'd just put the whole text in <primary> (obviously
> > > the option name must be the first word of that).
> >
> > Indeed. Attached is the updated version of the patch.
>
> Hmm, actually, I now see you were originally proposing the words
> "storage parameter" for the fillfactor index entries, but for v2 you
> instead copied the "configuration parameter" words that was in some
> other of the older entries.  I think "configuration parameter" is wrong
> (we use that for GUCs, and it seems to me that it would be confusing to
> mix both things), and we should use the words "storage parameter" for
> all of these, don't you think?

So you are suggesting to use
    <primary><varname>xxx</varname> storage parameter</primary> for
reltoption and
    <primary><varname>xxx</varname> configuration parameter</primary> for GUC?

If we do that, the following two lines are in the index.

    xxx configuration parameter, XXX
    xxx storage parameter, Storage Parameter

OTOH, originally I thought that the following style is smarter.

    xxx
        configuration parameter, XXX
        storage parameter, Storage Parameter

Regards,

-- 
Fujii Masao





^ permalink  raw  reply  [nested|flat] 17+ messages in thread

* Re: Mark a reloption as indexterm
  2019-04-09 18:54 Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-09 19:11 ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-12 03:33   ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-12 03:54     ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-12 04:37       ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
@ 2019-04-12 16:30         ` Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-15 15:14           ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  0 siblings, 1 reply; 17+ messages in thread

From: Alvaro Herrera @ 2019-04-12 16:30 UTC (permalink / raw)
  To: Fujii Masao <masao.fujii@gmail.com>; +Cc: pgsql-docs

On 2019-Apr-12, Fujii Masao wrote:


> OTOH, originally I thought that the following style is smarter.
> 
>     xxx
>         configuration parameter, XXX
>         storage parameter, Storage Parameter

Ah.  Well, I like this style.  Let's do that.

-- 
Álvaro Herrera                https://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services





^ permalink  raw  reply  [nested|flat] 17+ messages in thread

* Re: Mark a reloption as indexterm
  2019-04-09 18:54 Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-09 19:11 ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-12 03:33   ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-12 03:54     ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-12 04:37       ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-12 16:30         ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
@ 2019-04-15 15:14           ` Fujii Masao <masao.fujii@gmail.com>
  2019-04-15 15:35             ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-16 03:26             ` Re: Mark a reloption as indexterm Michael Paquier <michael@paquier.xyz>
  0 siblings, 2 replies; 17+ messages in thread

From: Fujii Masao @ 2019-04-15 15:14 UTC (permalink / raw)
  To: Alvaro Herrera <alvherre@2ndquadrant.com>; +Cc: pgsql-docs

On Sat, Apr 13, 2019 at 1:30 AM Alvaro Herrera <alvherre@2ndquadrant.com> wrote:
>
> On 2019-Apr-12, Fujii Masao wrote:
>
>
> > OTOH, originally I thought that the following style is smarter.
> >
> >     xxx
> >         configuration parameter, XXX
> >         storage parameter, Storage Parameter
>
> Ah.  Well, I like this style.  Let's do that.

So I used <secondary> tag again for the above style if both reloption
and guc with the same parameter name exist. Attached is the updated
version of the patch. This patch also marks index-reloption as indexterm.

Barring any objections, I will commit this patch.

Regards,

-- 
Fujii Masao

Attachments:

reloption-doc-v3.patch (application/octet-stream, 33.2K) download *** a/doc/src/sgml/config.sgml --- b/doc/src/sgml/config.sgml *************** *** 6934,6940 **** COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv; <varlistentry id="guc-log-autovacuum-min-duration" xreflabel="log_autovacuum_min_duration"> <term><varname>log_autovacuum_min_duration</varname> (<type>integer</type>) <indexterm> ! <primary><varname>log_autovacuum_min_duration</varname> configuration parameter</primary> </indexterm> </term> <listitem> --- 6934,6941 ---- <varlistentry id="guc-log-autovacuum-min-duration" xreflabel="log_autovacuum_min_duration"> <term><varname>log_autovacuum_min_duration</varname> (<type>integer</type>) <indexterm> ! <primary><varname>log_autovacuum_min_duration</varname></primary> ! <secondary>configuration parameter</secondary> </indexterm> </term> <listitem> *************** *** 6993,6999 **** COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv; <varlistentry id="guc-autovacuum-vacuum-threshold" xreflabel="autovacuum_vacuum_threshold"> <term><varname>autovacuum_vacuum_threshold</varname> (<type>integer</type>) <indexterm> ! <primary><varname>autovacuum_vacuum_threshold</varname> configuration parameter</primary> </indexterm> </term> <listitem> --- 6994,7001 ---- <varlistentry id="guc-autovacuum-vacuum-threshold" xreflabel="autovacuum_vacuum_threshold"> <term><varname>autovacuum_vacuum_threshold</varname> (<type>integer</type>) <indexterm> ! <primary><varname>autovacuum_vacuum_threshold</varname></primary> ! <secondary>configuration parameter</secondary> </indexterm> </term> <listitem> *************** *** 7012,7018 **** COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv; <varlistentry id="guc-autovacuum-analyze-threshold" xreflabel="autovacuum_analyze_threshold"> <term><varname>autovacuum_analyze_threshold</varname> (<type>integer</type>) <indexterm> ! <primary><varname>autovacuum_analyze_threshold</varname> configuration parameter</primary> </indexterm> </term> <listitem> --- 7014,7021 ---- <varlistentry id="guc-autovacuum-analyze-threshold" xreflabel="autovacuum_analyze_threshold"> <term><varname>autovacuum_analyze_threshold</varname> (<type>integer</type>) <indexterm> ! <primary><varname>autovacuum_analyze_threshold</varname></primary> ! <secondary>configuration parameter</secondary> </indexterm> </term> <listitem> *************** *** 7031,7037 **** COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv; <varlistentry id="guc-autovacuum-vacuum-scale-factor" xreflabel="autovacuum_vacuum_scale_factor"> <term><varname>autovacuum_vacuum_scale_factor</varname> (<type>floating point</type>) <indexterm> ! <primary><varname>autovacuum_vacuum_scale_factor</varname> configuration parameter</primary> </indexterm> </term> <listitem> --- 7034,7041 ---- <varlistentry id="guc-autovacuum-vacuum-scale-factor" xreflabel="autovacuum_vacuum_scale_factor"> <term><varname>autovacuum_vacuum_scale_factor</varname> (<type>floating point</type>) <indexterm> ! <primary><varname>autovacuum_vacuum_scale_factor</varname></primary> ! <secondary>configuration parameter</secondary> </indexterm> </term> <listitem> *************** *** 7051,7057 **** COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv; <varlistentry id="guc-autovacuum-analyze-scale-factor" xreflabel="autovacuum_analyze_scale_factor"> <term><varname>autovacuum_analyze_scale_factor</varname> (<type>floating point</type>) <indexterm> ! <primary><varname>autovacuum_analyze_scale_factor</varname> configuration parameter</primary> </indexterm> </term> <listitem> --- 7055,7062 ---- <varlistentry id="guc-autovacuum-analyze-scale-factor" xreflabel="autovacuum_analyze_scale_factor"> <term><varname>autovacuum_analyze_scale_factor</varname> (<type>floating point</type>) <indexterm> ! <primary><varname>autovacuum_analyze_scale_factor</varname></primary> ! <secondary>configuration parameter</secondary> </indexterm> </term> <listitem> *************** *** 7071,7077 **** COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv; <varlistentry id="guc-autovacuum-freeze-max-age" xreflabel="autovacuum_freeze_max_age"> <term><varname>autovacuum_freeze_max_age</varname> (<type>integer</type>) <indexterm> ! <primary><varname>autovacuum_freeze_max_age</varname> configuration parameter</primary> </indexterm> </term> <listitem> --- 7076,7083 ---- <varlistentry id="guc-autovacuum-freeze-max-age" xreflabel="autovacuum_freeze_max_age"> <term><varname>autovacuum_freeze_max_age</varname> (<type>integer</type>) <indexterm> ! <primary><varname>autovacuum_freeze_max_age</varname></primary> ! <secondary>configuration parameter</secondary> </indexterm> </term> <listitem> *************** *** 7099,7105 **** COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv; <varlistentry id="guc-autovacuum-multixact-freeze-max-age" xreflabel="autovacuum_multixact_freeze_max_age"> <term><varname>autovacuum_multixact_freeze_max_age</varname> (<type>integer</type>) <indexterm> ! <primary><varname>autovacuum_multixact_freeze_max_age</varname> configuration parameter</primary> </indexterm> </term> <listitem> --- 7105,7112 ---- <varlistentry id="guc-autovacuum-multixact-freeze-max-age" xreflabel="autovacuum_multixact_freeze_max_age"> <term><varname>autovacuum_multixact_freeze_max_age</varname> (<type>integer</type>) <indexterm> ! <primary><varname>autovacuum_multixact_freeze_max_age</varname></primary> ! <secondary>configuration parameter</secondary> </indexterm> </term> <listitem> *************** *** 7127,7133 **** COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv; <varlistentry id="guc-autovacuum-vacuum-cost-delay" xreflabel="autovacuum_vacuum_cost_delay"> <term><varname>autovacuum_vacuum_cost_delay</varname> (<type>floating point</type>) <indexterm> ! <primary><varname>autovacuum_vacuum_cost_delay</varname> configuration parameter</primary> </indexterm> </term> <listitem> --- 7134,7141 ---- <varlistentry id="guc-autovacuum-vacuum-cost-delay" xreflabel="autovacuum_vacuum_cost_delay"> <term><varname>autovacuum_vacuum_cost_delay</varname> (<type>floating point</type>) <indexterm> ! <primary><varname>autovacuum_vacuum_cost_delay</varname></primary> ! <secondary>configuration parameter</secondary> </indexterm> </term> <listitem> *************** *** 7147,7153 **** COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv; <varlistentry id="guc-autovacuum-vacuum-cost-limit" xreflabel="autovacuum_vacuum_cost_limit"> <term><varname>autovacuum_vacuum_cost_limit</varname> (<type>integer</type>) <indexterm> ! <primary><varname>autovacuum_vacuum_cost_limit</varname> configuration parameter</primary> </indexterm> </term> <listitem> --- 7155,7162 ---- <varlistentry id="guc-autovacuum-vacuum-cost-limit" xreflabel="autovacuum_vacuum_cost_limit"> <term><varname>autovacuum_vacuum_cost_limit</varname> (<type>integer</type>) <indexterm> ! <primary><varname>autovacuum_vacuum_cost_limit</varname></primary> ! <secondary>configuration parameter</secondary> </indexterm> </term> <listitem> *************** *** 7746,7752 **** COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv; <varlistentry id="guc-vacuum-cleanup-index-scale-factor" xreflabel="vacuum_cleanup_index_scale_factor"> <term><varname>vacuum_cleanup_index_scale_factor</varname> (<type>floating point</type>) <indexterm> ! <primary><varname>vacuum_cleanup_index_scale_factor</varname> configuration parameter</primary> </indexterm> </term> <listitem> --- 7755,7762 ---- <varlistentry id="guc-vacuum-cleanup-index-scale-factor" xreflabel="vacuum_cleanup_index_scale_factor"> <term><varname>vacuum_cleanup_index_scale_factor</varname> (<type>floating point</type>) <indexterm> ! <primary><varname>vacuum_cleanup_index_scale_factor</varname></primary> ! <secondary>configuration parameter</secondary> </indexterm> </term> <listitem> *************** *** 7865,7871 **** SET XML OPTION { DOCUMENT | CONTENT }; <varlistentry id="guc-gin-pending-list-limit" xreflabel="gin_pending_list_limit"> <term><varname>gin_pending_list_limit</varname> (<type>integer</type>) <indexterm> ! <primary><varname>gin_pending_list_limit</varname> configuration parameter</primary> </indexterm> </term> <listitem> --- 7875,7882 ---- <varlistentry id="guc-gin-pending-list-limit" xreflabel="gin_pending_list_limit"> <term><varname>gin_pending_list_limit</varname> (<type>integer</type>) <indexterm> ! <primary><varname>gin_pending_list_limit</varname></primary> ! <secondary>configuration parameter</secondary> </indexterm> </term> <listitem> *** a/doc/src/sgml/ref/create_index.sgml --- b/doc/src/sgml/ref/create_index.sgml *************** *** 361,368 **** CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class= </para> <variablelist> ! <varlistentry> ! <term><literal>fillfactor</literal></term> <listitem> <para> The fillfactor for an index is a percentage that determines how full --- 361,372 ---- </para> <variablelist> ! <varlistentry id="index-reloption-fillfactor" xreflabel="fillfactor"> ! <term><literal>fillfactor</literal> ! <indexterm> ! <primary><varname>fillfactor</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> The fillfactor for an index is a percentage that determines how full *************** *** 388,395 **** CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class= </para> <variablelist> ! <varlistentry> ! <term><literal>vacuum_cleanup_index_scale_factor</literal></term> <listitem> <para> Per-index value for <xref linkend="guc-vacuum-cleanup-index-scale-factor"/>. --- 392,404 ---- </para> <variablelist> ! <varlistentry id="index-reloption-vacuum-cleanup-index-scale-factor" xreflabel="vacuum_cleanup_index_scale_factor"> ! <term><literal>vacuum_cleanup_index_scale_factor</literal> ! <indexterm> ! <primary><varname>vacuum_cleanup_index_scale_factor</varname></primary> ! <secondary>storage parameter</secondary> ! </indexterm> ! </term> <listitem> <para> Per-index value for <xref linkend="guc-vacuum-cleanup-index-scale-factor"/>. *************** *** 403,410 **** CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class= </para> <variablelist> ! <varlistentry> ! <term><literal>buffering</literal></term> <listitem> <para> Determines whether the buffering build technique described in --- 412,423 ---- </para> <variablelist> ! <varlistentry id="index-reloption-buffering" xreflabel="buffering"> ! <term><literal>buffering</literal> ! <indexterm> ! <primary><varname>buffering</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> Determines whether the buffering build technique described in *************** *** 422,429 **** CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class= </para> <variablelist> ! <varlistentry> ! <term><literal>fastupdate</literal></term> <listitem> <para> This setting controls usage of the fast update technique described in --- 435,446 ---- </para> <variablelist> ! <varlistentry id="index-reloption-fastupdate" xreflabel="fastupdate"> ! <term><literal>fastupdate</literal> ! <indexterm> ! <primary><varname>fastupdate</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> This setting controls usage of the fast update technique described in *************** *** 446,454 **** CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class= </listitem> </varlistentry> </variablelist> <variablelist> ! <varlistentry> ! <term><literal>gin_pending_list_limit</literal></term> <listitem> <para> Custom <xref linkend="guc-gin-pending-list-limit"/> parameter. --- 463,477 ---- </listitem> </varlistentry> </variablelist> + <variablelist> ! <varlistentry id="index-reloption-gin-pending-list-limit" xreflabel="gin_pending_list_limit"> ! <term><literal>gin_pending_list_limit</literal> ! <indexterm> ! <primary><varname>gin_pending_list_limit</varname></primary> ! <secondary>storage parameter</secondary> ! </indexterm> ! </term> <listitem> <para> Custom <xref linkend="guc-gin-pending-list-limit"/> parameter. *************** *** 463,470 **** CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class= </para> <variablelist> ! <varlistentry> ! <term><literal>pages_per_range</literal></term> <listitem> <para> Defines the number of table blocks that make up one block range for --- 486,497 ---- </para> <variablelist> ! <varlistentry id="index-reloption-pages-per-range" xreflabel="pages_per_range"> ! <term><literal>pages_per_range</literal> ! <indexterm> ! <primary><varname>pages_per_range</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> Defines the number of table blocks that make up one block range for *************** *** 474,481 **** CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class= </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autosummarize</literal></term> <listitem> <para> Defines whether a summarization run is invoked for the previous page --- 501,512 ---- </listitem> </varlistentry> ! <varlistentry id="index-reloption-autosummarize" xreflabel="autosummarize"> ! <term><literal>autosummarize</literal> ! <indexterm> ! <primary><varname>autosummarize</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> Defines whether a summarization run is invoked for the previous page *** a/doc/src/sgml/ref/create_table.sgml --- b/doc/src/sgml/ref/create_table.sgml *************** *** 1316,1323 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM <variablelist> ! <varlistentry> ! <term><literal>fillfactor</literal> (<type>integer</type>)</term> <listitem> <para> The fillfactor for a table is a percentage between 10 and 100. --- 1316,1327 ---- <variablelist> ! <varlistentry id="reloption-fillfactor" xreflabel="fillfactor"> ! <term><varname>fillfactor</varname> (<type>integer</type>) ! <indexterm> ! <primary><varname>fillfactor</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> The fillfactor for a table is a percentage between 10 and 100. *************** *** 1334,1341 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>toast_tuple_target</literal> (<type>integer</type>)</term> <listitem> <para> The toast_tuple_target specifies the minimum tuple length required before --- 1338,1349 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-toast-tuple-target" xreflabel="toast_tuple_target"> ! <term><literal>toast_tuple_target</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>toast_tuple_target</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> The toast_tuple_target specifies the minimum tuple length required before *************** *** 1355,1362 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>parallel_workers</literal> (<type>integer</type>)</term> <listitem> <para> This sets the number of workers that should be used to assist a parallel --- 1363,1374 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-parallel-workers" xreflabel="parallel_workers"> ! <term><literal>parallel_workers</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>parallel_workers</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> This sets the number of workers that should be used to assist a parallel *************** *** 1368,1375 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_enabled</literal>, <literal>toast.autovacuum_enabled</literal> (<type>boolean</type>)</term> <listitem> <para> Enables or disables the autovacuum daemon for a particular table. --- 1380,1391 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-enabled" xreflabel="autovacuum_enabled"> ! <term><literal>autovacuum_enabled</literal>, <literal>toast.autovacuum_enabled</literal> (<type>boolean</type>) ! <indexterm> ! <primary><varname>autovacuum_enabled</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> Enables or disables the autovacuum daemon for a particular table. *************** *** 1389,1396 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>vacuum_index_cleanup</literal> (<type>boolean</type>)</term> <listitem> <para> Enables or disables index cleanup when <command>VACUUM</command> is --- 1405,1416 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-vacuum-index-cleanup" xreflabel="vacuum_index_cleanup"> ! <term><literal>vacuum_index_cleanup</literal> (<type>boolean</type>) ! <indexterm> ! <primary><varname>vacuum_index_cleanup</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> Enables or disables index cleanup when <command>VACUUM</command> is *************** *** 1404,1411 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>vacuum_truncate</literal>, <literal>toast.vacuum_truncate</literal> (<type>boolean</type>)</term> <listitem> <para> Enables or disables vacuum to try to truncate off any empty pages --- 1424,1435 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-vacuum-truncate" xreflabel="vacuum_truncate"> ! <term><literal>vacuum_truncate</literal>, <literal>toast.vacuum_truncate</literal> (<type>boolean</type>) ! <indexterm> ! <primary><varname>vacuum_truncate</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> Enables or disables vacuum to try to truncate off any empty pages *************** *** 1419,1426 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_vacuum_threshold</literal>, <literal>toast.autovacuum_vacuum_threshold</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-vacuum-threshold"/> --- 1443,1455 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-vacuum-threshold" xreflabel="autovacuum_vacuum_threshold"> ! <term><literal>autovacuum_vacuum_threshold</literal>, <literal>toast.autovacuum_vacuum_threshold</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_vacuum_threshold</varname></primary> ! <secondary>storage parameter</secondary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-vacuum-threshold"/> *************** *** 1429,1436 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_vacuum_scale_factor</literal>, <literal>toast.autovacuum_vacuum_scale_factor</literal> (<type>float4</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-vacuum-scale-factor"/> --- 1458,1470 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-vauum-scale-factor" xreflabel="autovacuum_vacuum_scale_factor"> ! <term><literal>autovacuum_vacuum_scale_factor</literal>, <literal>toast.autovacuum_vacuum_scale_factor</literal> (<type>float4</type>) ! <indexterm> ! <primary><varname>autovacuum_vacuum_scale_factor</varname> </primary> ! <secondary>storage parameter</secondary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-vacuum-scale-factor"/> *************** *** 1439,1446 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_analyze_threshold</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-analyze-threshold"/> --- 1473,1485 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-analyze-threshold" xreflabel="autovacuum_analyze_threshold"> ! <term><literal>autovacuum_analyze_threshold</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_analyze_threshold</varname></primary> ! <secondary>storage parameter</secondary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-analyze-threshold"/> *************** *** 1449,1456 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_analyze_scale_factor</literal> (<type>float4</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-analyze-scale-factor"/> --- 1488,1500 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-analyze-scale-factor" xreflabel="autovacuum_analyze_scale_factor"> ! <term><literal>autovacuum_analyze_scale_factor</literal> (<type>float4</type>) ! <indexterm> ! <primary><varname>autovacuum_analyze_scale_factor</varname></primary> ! <secondary>storage parameter</secondary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-analyze-scale-factor"/> *************** *** 1459,1466 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_vacuum_cost_delay</literal>, <literal>toast.autovacuum_vacuum_cost_delay</literal> (<type>floating point</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-vacuum-cost-delay"/> --- 1503,1515 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-vacuum-cost-delay" xreflabel="autovacuum_vacuum_cost_delay"> ! <term><literal>autovacuum_vacuum_cost_delay</literal>, <literal>toast.autovacuum_vacuum_cost_delay</literal> (<type>floating point</type>) ! <indexterm> ! <primary><varname>autovacuum_vacuum_cost_delay</varname></primary> ! <secondary>storage parameter</secondary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-vacuum-cost-delay"/> *************** *** 1469,1476 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_vacuum_cost_limit</literal>, <literal>toast.autovacuum_vacuum_cost_limit</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-vacuum-cost-limit"/> --- 1518,1530 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-vauum-cost-limit" xreflabel="autovacuum_vacuum_cost_limit"> ! <term><literal>autovacuum_vacuum_cost_limit</literal>, <literal>toast.autovacuum_vacuum_cost_limit</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_vacuum_cost_limit</varname></primary> ! <secondary>storage parameter</secondary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-vacuum-cost-limit"/> *************** *** 1479,1486 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_freeze_min_age</literal>, <literal>toast.autovacuum_freeze_min_age</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-vacuum-freeze-min-age"/> --- 1533,1544 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-freeze-min-age" xreflabel="autovacuum_freeze_min_age"> ! <term><literal>autovacuum_freeze_min_age</literal>, <literal>toast.autovacuum_freeze_min_age</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_freeze_min_age</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-vacuum-freeze-min-age"/> *************** *** 1492,1499 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_freeze_max_age</literal>, <literal>toast.autovacuum_freeze_max_age</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-freeze-max-age"/> --- 1550,1562 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-freeze-max-age" xreflabel="autovacuum_freeze_max_age"> ! <term><literal>autovacuum_freeze_max_age</literal>, <literal>toast.autovacuum_freeze_max_age</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_freeze_max_age</varname></primary> ! <secondary>storage parameter</secondary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-autovacuum-freeze-max-age"/> *************** *** 1504,1511 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_freeze_table_age</literal>, <literal>toast.autovacuum_freeze_table_age</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-vacuum-freeze-table-age"/> --- 1567,1578 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-freeze-table-age" xreflabel="autovacuum_freeze_table_age"> ! <term><literal>autovacuum_freeze_table_age</literal>, <literal>toast.autovacuum_freeze_table_age</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_freeze_table_age</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-vacuum-freeze-table-age"/> *************** *** 1514,1521 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_multixact_freeze_min_age</literal>, <literal>toast.autovacuum_multixact_freeze_min_age</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-vacuum-multixact-freeze-min-age"/> --- 1581,1592 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-multixact-freeze-min-age" xreflabel="autovacuum_multixact_freeze_min_age"> ! <term><literal>autovacuum_multixact_freeze_min_age</literal>, <literal>toast.autovacuum_multixact_freeze_min_age</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_multixact_freeze_min_age</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-vacuum-multixact-freeze-min-age"/> *************** *** 1528,1535 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_multixact_freeze_max_age</literal>, <literal>toast.autovacuum_multixact_freeze_max_age</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value --- 1599,1611 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-multixact-freeze-max-age" xreflabel="autovacuum_multixact_freeze_max_age"> ! <term><literal>autovacuum_multixact_freeze_max_age</literal>, <literal>toast.autovacuum_multixact_freeze_max_age</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_multixact_freeze_max_age</varname></primary> ! <secondary>storage parameter</secondary> ! </indexterm> ! </term> <listitem> <para> Per-table value *************** *** 1542,1549 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>autovacuum_multixact_freeze_table_age</literal>, <literal>toast.autovacuum_multixact_freeze_table_age</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value --- 1618,1629 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-autovacuum-multixact-freeze-table-age" xreflabel="autovacuum_multixact_freeze_table_age"> ! <term><literal>autovacuum_multixact_freeze_table_age</literal>, <literal>toast.autovacuum_multixact_freeze_table_age</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>autovacuum_multixact_freeze_table_age</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> Per-table value *************** *** 1552,1559 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>log_autovacuum_min_duration</literal>, <literal>toast.log_autovacuum_min_duration</literal> (<type>integer</type>)</term> <listitem> <para> Per-table value for <xref linkend="guc-log-autovacuum-min-duration"/> --- 1632,1644 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-log-autovacuum-min-duration" xreflabel="log_autovacuum_min_duration"> ! <term><literal>log_autovacuum_min_duration</literal>, <literal>toast.log_autovacuum_min_duration</literal> (<type>integer</type>) ! <indexterm> ! <primary><varname>log_autovacuum_min_duration</varname></primary> ! <secondary>storage parameter</secondary> ! </indexterm> ! </term> <listitem> <para> Per-table value for <xref linkend="guc-log-autovacuum-min-duration"/> *************** *** 1562,1569 **** WITH ( MODULUS <replaceable class="parameter">numeric_literal</replaceable>, REM </listitem> </varlistentry> ! <varlistentry> ! <term><literal>user_catalog_table</literal> (<type>boolean</type>)</term> <listitem> <para> Declare the table as an additional catalog table for purposes of --- 1647,1658 ---- </listitem> </varlistentry> ! <varlistentry id="reloption-user-catalog-table" xreflabel="user_catalog_table"> ! <term><literal>user_catalog_table</literal> (<type>boolean</type>) ! <indexterm> ! <primary><varname>user_catalog_table</varname> storage parameter</primary> ! </indexterm> ! </term> <listitem> <para> Declare the table as an additional catalog table for purposes of
^ permalink raw reply [nested|flat] 17+ messages in thread

* Re: Mark a reloption as indexterm
  2019-04-09 18:54 Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-09 19:11 ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-12 03:33   ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-12 03:54     ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-12 04:37       ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-12 16:30         ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-15 15:14           ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
@ 2019-04-15 15:35             ` Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-15 16:13               ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  1 sibling, 1 reply; 17+ messages in thread

From: Alvaro Herrera @ 2019-04-15 15:35 UTC (permalink / raw)
  To: Fujii Masao <masao.fujii@gmail.com>; +Cc: pgsql-docs

On 2019-Apr-16, Fujii Masao wrote:

> On Sat, Apr 13, 2019 at 1:30 AM Alvaro Herrera <alvherre@2ndquadrant.com> wrote:
> >
> > On 2019-Apr-12, Fujii Masao wrote:
> >
> >
> > > OTOH, originally I thought that the following style is smarter.
> > >
> > >     xxx
> > >         configuration parameter, XXX
> > >         storage parameter, Storage Parameter
> >
> > Ah.  Well, I like this style.  Let's do that.
> 
> So I used <secondary> tag again for the above style if both reloption
> and guc with the same parameter name exist. Attached is the updated
> version of the patch. This patch also marks index-reloption as indexterm.

I checked the HTML output.  For autovacuum it says "configuration
parameters" rather than "configuration parameter".  Other than that, it
looks good to me.  (I didn't check that all storage options were covered.)

-- 
Álvaro Herrera                https://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services





^ permalink  raw  reply  [nested|flat] 17+ messages in thread

* Re: Mark a reloption as indexterm
  2019-04-09 18:54 Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-09 19:11 ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-12 03:33   ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-12 03:54     ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-12 04:37       ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-12 16:30         ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-15 15:14           ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-15 15:35             ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
@ 2019-04-15 16:13               ` Fujii Masao <masao.fujii@gmail.com>
  2019-04-15 16:15                 ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  0 siblings, 1 reply; 17+ messages in thread

From: Fujii Masao @ 2019-04-15 16:13 UTC (permalink / raw)
  To: Alvaro Herrera <alvherre@2ndquadrant.com>; +Cc: pgsql-docs

On Tue, Apr 16, 2019 at 12:35 AM Alvaro Herrera
<alvherre@2ndquadrant.com> wrote:
>
> On 2019-Apr-16, Fujii Masao wrote:
>
> > On Sat, Apr 13, 2019 at 1:30 AM Alvaro Herrera <alvherre@2ndquadrant.com> wrote:
> > >
> > > On 2019-Apr-12, Fujii Masao wrote:
> > >
> > >
> > > > OTOH, originally I thought that the following style is smarter.
> > > >
> > > >     xxx
> > > >         configuration parameter, XXX
> > > >         storage parameter, Storage Parameter
> > >
> > > Ah.  Well, I like this style.  Let's do that.
> >
> > So I used <secondary> tag again for the above style if both reloption
> > and guc with the same parameter name exist. Attached is the updated
> > version of the patch. This patch also marks index-reloption as indexterm.
>
> I checked the HTML output.

Thanks for the review!

> For autovacuum it says "configuration
> parameters" rather than "configuration parameter".  Other than that, it
> looks good to me.  (I didn't check that all storage options were covered.)

Good catch! Seems "configuration parameters" had been used for autovacuum
parameter since old version. I agree to replace it with "configuration
parameter"
for the sake of consistency. But I think that it's better to do that by
the separate patch because they are separate things.

Regards,

-- 
Fujii Masao





^ permalink  raw  reply  [nested|flat] 17+ messages in thread

* Re: Mark a reloption as indexterm
  2019-04-09 18:54 Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-09 19:11 ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-12 03:33   ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-12 03:54     ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-12 04:37       ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-12 16:30         ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-15 15:14           ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-15 15:35             ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-15 16:13               ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
@ 2019-04-15 16:15                 ` Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-16 14:41                   ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  0 siblings, 1 reply; 17+ messages in thread

From: Alvaro Herrera @ 2019-04-15 16:15 UTC (permalink / raw)
  To: Fujii Masao <masao.fujii@gmail.com>; +Cc: pgsql-docs

On 2019-Apr-16, Fujii Masao wrote:

> On Tue, Apr 16, 2019 at 12:35 AM Alvaro Herrera
> <alvherre@2ndquadrant.com> wrote:

> > For autovacuum it says "configuration
> > parameters" rather than "configuration parameter".  Other than that, it
> > looks good to me.  (I didn't check that all storage options were covered.)
> 
> Good catch! Seems "configuration parameters" had been used for autovacuum
> parameter since old version. I agree to replace it with "configuration
> parameter"
> for the sake of consistency. But I think that it's better to do that by
> the separate patch because they are separate things.

OK, no objection :-)

-- 
Álvaro Herrera                https://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services





^ permalink  raw  reply  [nested|flat] 17+ messages in thread

* Re: Mark a reloption as indexterm
  2019-04-09 18:54 Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-09 19:11 ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-12 03:33   ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-12 03:54     ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-12 04:37       ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-12 16:30         ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-15 15:14           ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-15 15:35             ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-15 16:13               ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-15 16:15                 ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
@ 2019-04-16 14:41                   ` Fujii Masao <masao.fujii@gmail.com>
  0 siblings, 0 replies; 17+ messages in thread

From: Fujii Masao @ 2019-04-16 14:41 UTC (permalink / raw)
  To: Alvaro Herrera <alvherre@2ndquadrant.com>; +Cc: pgsql-docs

On Tue, Apr 16, 2019 at 1:15 AM Alvaro Herrera <alvherre@2ndquadrant.com> wrote:
>
> On 2019-Apr-16, Fujii Masao wrote:
>
> > On Tue, Apr 16, 2019 at 12:35 AM Alvaro Herrera
> > <alvherre@2ndquadrant.com> wrote:
>
> > > For autovacuum it says "configuration
> > > parameters" rather than "configuration parameter".  Other than that, it
> > > looks good to me.  (I didn't check that all storage options were covered.)
> >
> > Good catch! Seems "configuration parameters" had been used for autovacuum
> > parameter since old version. I agree to replace it with "configuration
> > parameter"
> > for the sake of consistency. But I think that it's better to do that by
> > the separate patch because they are separate things.
>
> OK, no objection :-)

While reading config.sgml again, I found that there are both
"autovacuum configuration parameters" and "autovacuum configuration
parameter", i.e., the plural and the singular. The latter indicates
the autovacuum GUC itself. OTOH, the former seems to indicate
all the autovacuum-related GUC parameters. So the plural form is used.

So now I'm thinking that we would not need to fix that plural form of
the index term.

Regards,

-- 
Fujii Masao





^ permalink  raw  reply  [nested|flat] 17+ messages in thread

* Re: Mark a reloption as indexterm
  2019-04-09 18:54 Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-09 19:11 ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-12 03:33   ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-12 03:54     ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-12 04:37       ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-12 16:30         ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-15 15:14           ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
@ 2019-04-16 03:26             ` Michael Paquier <michael@paquier.xyz>
  2019-04-16 14:41               ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  1 sibling, 1 reply; 17+ messages in thread

From: Michael Paquier @ 2019-04-16 03:26 UTC (permalink / raw)
  To: Fujii Masao <masao.fujii@gmail.com>; +Cc: Alvaro Herrera <alvherre@2ndquadrant.com>; pgsql-docs

On Tue, Apr 16, 2019 at 12:14:01AM +0900, Fujii Masao wrote:
> So I used <secondary> tag again for the above style if both reloption
> and guc with the same parameter name exist. Attached is the updated
> version of the patch. This patch also marks index-reloption as indexterm.
> 
> Barring any objections, I will commit this patch.

Thanks Fujii-san.  This looks fine to me.
--
Michael

Attachments:

  signature.asc (application/pgp-signature, 832B) download

^ permalink  raw  reply  [nested|flat] 17+ messages in thread

* Re: Mark a reloption as indexterm
  2019-04-09 18:54 Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-09 19:11 ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-12 03:33   ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-12 03:54     ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-12 04:37       ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-12 16:30         ` Re: Mark a reloption as indexterm Alvaro Herrera <alvherre@2ndquadrant.com>
  2019-04-15 15:14           ` Re: Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
  2019-04-16 03:26             ` Re: Mark a reloption as indexterm Michael Paquier <michael@paquier.xyz>
@ 2019-04-16 14:41               ` Fujii Masao <masao.fujii@gmail.com>
  0 siblings, 0 replies; 17+ messages in thread

From: Fujii Masao @ 2019-04-16 14:41 UTC (permalink / raw)
  To: Michael Paquier <michael@paquier.xyz>; +Cc: Alvaro Herrera <alvherre@2ndquadrant.com>; pgsql-docs

On Tue, Apr 16, 2019 at 12:26 PM Michael Paquier <michael@paquier.xyz> wrote:
>
> On Tue, Apr 16, 2019 at 12:14:01AM +0900, Fujii Masao wrote:
> > So I used <secondary> tag again for the above style if both reloption
> > and guc with the same parameter name exist. Attached is the updated
> > version of the patch. This patch also marks index-reloption as indexterm.
> >
> > Barring any objections, I will commit this patch.
>
> Thanks Fujii-san.  This looks fine to me.

Thanks for the review! Committed!

Regards,

-- 
Fujii Masao





^ permalink  raw  reply  [nested|flat] 17+ messages in thread


end of thread, other threads:[~2019-04-16 14:41 UTC | newest]

Thread overview: 17+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2019-04-09 18:54 Mark a reloption as indexterm Fujii Masao <masao.fujii@gmail.com>
2019-04-09 19:11 ` Alvaro Herrera <alvherre@2ndquadrant.com>
2019-04-12 03:33   ` Fujii Masao <masao.fujii@gmail.com>
2019-04-12 03:52     ` Michael Paquier <michael@paquier.xyz>
2019-04-12 03:57       ` Alvaro Herrera <alvherre@2ndquadrant.com>
2019-04-12 04:09         ` Michael Paquier <michael@paquier.xyz>
2019-04-12 04:43           ` Fujii Masao <masao.fujii@gmail.com>
2019-04-12 03:54     ` Alvaro Herrera <alvherre@2ndquadrant.com>
2019-04-12 04:37       ` Fujii Masao <masao.fujii@gmail.com>
2019-04-12 16:30         ` Alvaro Herrera <alvherre@2ndquadrant.com>
2019-04-15 15:14           ` Fujii Masao <masao.fujii@gmail.com>
2019-04-15 15:35             ` Alvaro Herrera <alvherre@2ndquadrant.com>
2019-04-15 16:13               ` Fujii Masao <masao.fujii@gmail.com>
2019-04-15 16:15                 ` Alvaro Herrera <alvherre@2ndquadrant.com>
2019-04-16 14:41                   ` Fujii Masao <masao.fujii@gmail.com>
2019-04-16 03:26             ` Michael Paquier <michael@paquier.xyz>
2019-04-16 14:41               ` Fujii Masao <masao.fujii@gmail.com>

This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox