Skip to content

Commit c5b6db5

Browse files
committed
[Doc]: apply 1C docs patch
1 parent e7d63f8 commit c5b6db5

File tree

6 files changed

+57
-57
lines changed

6 files changed

+57
-57
lines changed

doc/src/sgml/fasttrun.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
<title>fasttrun</title>
33
<para>
44
The <literal>fasttrun</literal> module provides transaction unsafe
5-
function to truncate tempory tables without growing pg_class size.
5+
function to truncate temporary tables without growing pg_class size.
66
</para>
77
<para>
88
This module is required for 1C Enterprise support.
99
</para>
1010
<para>
1111
Fast truncate operation is not transactional, so its results cannot be
12-
rolled back and became immediately visible in all sessions regardless
12+
rolled back and become immediately visible in all sessions regardless
1313
of isolation level.
1414
</para>
1515
<sect2 id="fasttrun-function">
@@ -38,7 +38,7 @@ $$ language plpgsql;
3838
</programlisting>
3939
</para>
4040
</sect2>
41-
41+
4242
<sect2 id="fasttrun-authors">
4343
<title>Authors</title>
4444
<literallayout>

doc/src/sgml/fulleq.sgml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<title>fulleq</title>
33
<para>
44
The <literal>fulleq</literal> module provides additional equivalence
5-
operator to compatibility with Microsoft SQL Server.
5+
operator for compatibility with Microsoft SQL Server.
66
</para>
77
<para>
88
This module is required for 1C Enterprise support.
@@ -11,17 +11,17 @@
1111
<title>Overview</title>
1212
<para>
1313
The <productname>&productname;</productname> equivalence operator is
14-
defined to returns NULL when both operands are NULLs. However, the Microsoft
15-
SQL Servers family traditionaly defined other semantic for equivalence
14+
defined to return NULL when both operands are NULLs. However, the Microsoft
15+
SQL Servers family traditionaly defines other semantic for equivalence
1616
operator, where operator returns TRUE in the case of both nulled operands.
1717
This module provides such operator with MSSQL semantic.
1818
</para>
1919
</sect2>
20-
20+
2121
<sect2 id="fulleq-operator">
2222
<title>Operator fulleq</title>
2323
<para>
24-
This operator <emphasis>==</emphasis> is defined for following data
24+
The <literal>==</literal> operator is defined for the following data
2525
types:
2626
<itemizedlist>
2727
<listitem><para>bool</para></listitem>
@@ -52,9 +52,9 @@
5252
<listitem><para>interval</para></listitem>
5353
<listitem><para>timetz</para></listitem>
5454
</itemizedlist>
55-
</para>
55+
</para>
5656
</sect2>
57-
57+
5858
<sect2 id="fulleq-authors">
5959
<title>Authors</title>
6060
<literallayout>

doc/src/sgml/mchar.sgml

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,25 @@
22
<title>mchar</title>
33
<para>
44
The <literal>mchar</literal> module provides additional data types
5-
to compatibility with Microsoft SQL Server (MSSQL).
5+
for compatibility with Microsoft SQL Server (MSSQL).
66
</para>
7-
7+
88
<sect2 id="mchar-overview">
99
<title>Overview</title>
1010
<para>
11-
This module has been designed to imporving <application>1C Enterprise</application>
12-
support, most popular russian CRM and ERP systems.
11+
This module has been designed to improve <application>1C Enterprise</application>
12+
support, most popular Russian CRM and ERP system.
1313
</para>
1414
</sect2>
1515

1616
<sect2 id="mchar-types">
1717
<title>Additional types</title>
1818
<itemizedlist>
1919
<listitem>
20-
<para><type>mchar</type> - analog of the MSSQL char type</para>
20+
<para><type>mchar</type> &mdash; analog of the MSSQL char type</para>
2121
</listitem>
2222
<listitem>
23-
<para><type>mvarchar</type> - analog of the MSSQL varchar type</para>
23+
<para><type>mvarchar</type> &mdash; analog of the MSSQL varchar type</para>
2424
</listitem>
2525
</itemizedlist>
2626
</sect2>
@@ -29,47 +29,47 @@
2929
<title>MCHAR and MVARCHAR features</title>
3030
<itemizedlist>
3131
<listitem>
32-
<para>defined <function>length(str)</function> function</para>
32+
<para>Defines <function>length(str)</function> function</para>
3333
</listitem>
3434
<listitem>
35-
<para>defined <function>substr(str, pos[, length])</function> function</para>
35+
<para>Defines <function>substr(str, pos[, length])</function> function</para>
3636
</listitem>
3737
<listitem>
38-
<para>defined operator <emphasis>||</emphasis>, which would be applied to concatenation any (mchar and mvarchar) arguments</para>
38+
<para>Defines <literal>||</literal> operator, which would be applied to concatenate any (mchar and mvarchar) arguments</para>
3939
</listitem>
4040
<listitem>
41-
<para>defined set of operators: <emphasis>&lt; &lt;= = &gt;= &gt;</emphasis> to case-insensitive comparations (LibICU)</para>
41+
<para>Defines set of operators: <literal>&lt;</>, <literal>&lt;=</> <literal>=</>, <literal>&gt;=</>, <literal>&gt;</> for case-insensitive comparison (LibICU)</para>
4242
</listitem>
4343
<listitem>
44-
<para>defined set of operators: <emphasis>&amp;&lt; &amp;&lt;= &amp;= &amp;&gt;= &amp;&gt;</emphasis> to case-sensitive comparations (LibICU)</para>
44+
<para>Defines set of operators: <literal>&amp;&lt;</>, <literal>&amp;&lt;=</>, <literal>&amp;=</>, <literal>&amp;&gt;=</>, <literal>&amp;&gt;</> to case-sensitive comparison (LibICU)</para>
4545
</listitem>
4646
<listitem>
47-
<para>implicit casting between <type>mchar</type> and <type>mvarchar</type> types</para>
47+
<para>Implicit cast between <type>mchar</type> and <type>mvarchar</type> types</para>
4848
</listitem>
4949
<listitem>
5050
<para>B-tree and Hash-index support</para>
5151
</listitem>
5252
<listitem>
53-
<para>Operator <emphasis>LIKE [ESCAPE]</emphasis> support</para>
54-
</listitem>
53+
<para>The <literal>LIKE [ESCAPE]</literal> operator support</para>
54+
</listitem>
5555
<listitem>
56-
<para>Operator <emphasis>SIMILAR TO [ESCAPE]</emphasis> support</para>
56+
<para>The <literal>SIMILAR TO [ESCAPE]</literal> operator support</para>
5757
</listitem>
5858
<listitem>
59-
<para>Operator <emphasis>~</emphasis> (POSIX regexp) supoprt</para>
59+
<para>The <emphasis>~</emphasis> operator (POSIX regexp) support</para>
6060
</listitem>
6161
<listitem>
62-
<para>Index support for <emphasis>LIKE</emphasis> operator</para>
62+
<para>Index support for the <emphasis>LIKE</emphasis> operator</para>
6363
</listitem>
6464
</itemizedlist>
6565
</sect2>
66-
66+
6767
<sect2 id="mchar-authors">
6868
<title>Authors</title>
6969
<literallayout>
7070
Oleg Bartunov <email>oleg@sai.msu.ru</email>
7171
Teodor Sigaev <email>teodor@sigaev.ru</email>
7272
</literallayout>
7373
</sect2>
74-
74+
7575
</sect1>

doc/src/sgml/online-analyze.sgml

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,70 +2,70 @@
22
<title>online-analyze</title>
33
<para>
44
The <literal>online_analyze</literal> module provides set of
5-
changes, which immediately update stats after INSERT, UPDATE, DELETE
5+
features, which immediately update stats after INSERT, UPDATE, DELETE
66
or SELECT INTO operations applied for affected tables.
77
</para>
88

99
<sect2 id="online-analyze-loading">
1010
<title>Module loading</title>
1111
<para>
12-
To use <literal>online_analyze</literal> module the first thing you need to
12+
To use <literal>online_analyze</literal> module the first thing you need is to
1313
load shared library:
1414

1515
<programlisting>
1616
LOAD 'online_analyze';
1717
</programlisting>
18-
</para>
18+
</para>
1919
</sect2>
2020

2121
<sect2 id="online-analyze-configuration">
2222
<title>Module configuration</title>
2323

2424
<para>
25-
Custom variables (defaults values are shown):
26-
25+
Custom variables (default values are shown):
26+
2727
<itemizedlist>
2828
<listitem>
2929
<para>online_analyze.enable = on</para>
30-
<para>Enables on-line analyze</para>
30+
<para>Enables online analyze</para>
3131
</listitem>
3232
<listitem>
3333
<para>online_analyze.verbose = on</para>
3434
<para>Execute ANALYZE VERBOSE</para>
3535
</listitem>
3636
<listitem>
3737
<para>online_analyze.scale_factor = 0.1</para>
38-
<para>Fraction of table size to start on-line analyze (similar to autovacuum_analyze_scale_factor)</para>
38+
<para>Fraction of table size to start online analyze (similar to autovacuum_analyze_scale_factor)</para>
3939
</listitem>
4040

4141
<listitem>
4242
<para>online_analyze.threshold = 50</para>
43-
<para>Min number of row updates before on-line analyze (similar to autovacuum_analyze_threshold)</para>
43+
<para>Min number of row updates before online analyze (similar to autovacuum_analyze_threshold)</para>
4444
</listitem>
4545

4646
<listitem>
4747
<para>online_analyze.min_interval = 10000</para>
4848
<para>Minimum time interval between analyze call per table (in milliseconds)</para>
4949
</listitem>
50-
50+
5151
<listitem>
5252
<para>online_analyze.table_type = "all"</para>
53-
<para>Type(s) of table for online analyze: all, persistent, temporary, none</para>
53+
<para>Type(s) of tables for online analyze: all, persistent, temporary, none</para>
5454
</listitem>
5555

5656
<listitem>
5757
<para>online_analyze.exclude_tables = ""</para>
58-
<para>List of tables which will not online analyze</para>
58+
<para>List of tables to exclude from online analyze</para>
5959
</listitem>
60-
60+
6161
<listitem>
6262
<para>online_analyze.include_tables = ""</para>
63-
<para>List of tables which will online analyze online_analyze.include_tables overwrites online_analyze.exclude_tables.</para>
63+
<para>List of tables to include in online analyze (online_analyze.include_tables overrides online_analyze.exclude_tables).</para>
6464
</listitem>
6565
</itemizedlist>
6666
</para>
6767
</sect2>
68-
68+
6969
<sect2 id="online-analyze-authors">
7070
<title>Authors</title>
7171
<literallayout>

doc/src/sgml/plantuner.sgml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,40 +2,40 @@
22
<title>plantuner</title>
33
<para>
44
The <literal>plantuner</literal> module provides hits for planner,
5-
which can do disable or enable indexes for query execution.
5+
which can disable or enable indexes for query execution.
66
</para>
77

88
<sect2 id="plantuner-motivation">
99
<title>Motivation</title>
1010
<para>
1111
Whether somebody think it's bad or not, but sometime it's very
12-
interesting to be able to control planner (provide hints, which tells
12+
interesting to be able to control planner (provide hints, which tell
1313
optimizer to ignore its algorithm in part), which is currently
14-
impossible in PostgreSQL. Oracle, for example, has over 120 hints, SQL
15-
Server also provides hints.
14+
impossible in PostgreSQL. Oracle, for example, has over 120 hints,
15+
and Microsoft SQL Server also supports hints.
1616
</para>
1717
<para>
1818
This first version of plantuner provides a possibility to hide
19-
specified indexes from PostgreSQL planner, so it will not use them.
19+
specified indexes from PostgreSQL planner, so it will not use them.
2020
</para>
2121
<para>
22-
There are many situation, when developer want to temporarily disable
22+
There are many situations when developer want to temporarily disable
2323
specific index(es), without dropping them, or to instruct planner to
2424
use specific index.
2525
</para>
2626
<para>
2727
Next, for some workload PostgreSQL could be too pessimistic for
2828
newly created tables and assumes much more rows in table than
2929
it actually has. If plantuner.fix_empty_table GUC variable is set
30-
to true then module will set to zero number of pages/tuples of
31-
table which hasn't blocks in file.
30+
to true then module will set to zero the number of pages/tuples of
31+
table which hasn't blocks in a file.
3232
</para>
3333
</sect2>
3434

3535
<sect2 id="plantuner-syntax">
3636
<title>Syntax</title>
37-
<para>plantuner.disable_index - List of indexes invisible to planner</para>
38-
<para>plantuner.enable_index - List of indexes visible to planner even they are hided by plantuner.disable_index.</para>
37+
<para>plantuner.disable_index &mdash; List of indexes invisible to planner</para>
38+
<para>plantuner.enable_index &mdash; List of indexes visible to planner even they are hidden by plantuner.disable_index.</para>
3939
</sect2>
4040

4141
<sect2 id="plantuner-usage-example">
@@ -94,11 +94,11 @@ Indexes:
9494
</programlisting>
9595
</para>
9696
</sect2>
97-
97+
9898
<sect2 id="plantuner-authors">
9999
<title>Authors</title>
100100
<para>All work was done by Teodor Sigaev (teodor@sigaev.ru) and Oleg Bartunov (oleg@sai.msu.su).</para>
101-
<para>Sponsor: Nomao project (http://www.nomao.com)</para>
101+
<para>The work sponsored by Nomao project (http://www.nomao.com).</para>
102102
</sect2>
103103

104104
</sect1>

doc/src/sgml/release-pro-9.6.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
9.6.1.1 and upstream PostgreSQL patches.</para>
1313
<para>Major enhancements over <productname>Postgres Pro</productname>
1414
9.6.1.1 include:</para>
15-
<para>Added several modules to support 1C Enterprise:</para>
15+
<para>Several modules to support 1C Enterprise added:</para>
1616
<itemizedlist>
1717
<listitem>
1818
<para><application>mchar</application> (See <xref linkend="mchar">)</para>
@@ -30,7 +30,7 @@
3030
<para><application>plantuner</application> (See <xref linkend="plantuner">)</para>
3131
</listitem>
3232
</itemizedlist>
33-
<para>Also, following core changes were added to support 1C</para>
33+
<para>Also, following core changes were added to support 1C:</para>
3434
<itemizedlist>
3535
<listitem>
3636
<para>Application level locks</para>

0 commit comments

Comments
 (0)