Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit f7481d2

Browse files
committed
Documentation spell checking and markup improvements
1 parent 539f32b commit f7481d2

9 files changed

+28
-28
lines changed

doc/src/sgml/config.sgml

+2-2
Original file line numberDiff line numberDiff line change
@@ -2148,7 +2148,7 @@ include_dir 'conf.d'
21482148
pool of processes established by <xref
21492149
linkend="guc-max-worker-processes"/>, limited by <xref
21502150
linkend="guc-max-parallel-workers"/>. Note that the requested
2151-
number of workers may not actually be available at runtime.
2151+
number of workers may not actually be available at run time.
21522152
If this occurs, the utility operation will run with fewer
21532153
workers than expected. The default value is 2. Setting this
21542154
value to 0 disables the use of parallel workers by utility
@@ -8856,7 +8856,7 @@ LOG: CleanUpLock: deleting: lock(0xb7acd844) id(24688,24696,0,0,0,1)
88568856
<listitem>
88578857
<para>
88588858
Writes the generated <productname>LLVM</productname> IR out to the
8859-
filesystem, inside <xref linkend="guc-data-directory"/>. This is only
8859+
file system, inside <xref linkend="guc-data-directory"/>. This is only
88608860
useful for working on the internals of the JIT implementation.
88618861

88628862
The default setting is <literal>off</literal>, and it can only be

doc/src/sgml/func.sgml

+2-2
Original file line numberDiff line numberDiff line change
@@ -9737,10 +9737,10 @@ CREATE TYPE rainbow AS ENUM ('red', 'orange', 'yellow', 'green', 'blue', 'purple
97379737
<entry>
97389738
reduce each value in the document, specified by <replaceable class="parameter">filter</replaceable> to a <type>tsvector</type>,
97399739
and then concatenate those in document order to produce a single <type>tsvector</type>.
9740-
<replaceable class="parameter">filter</replaceable> is a jsonb array, that enumerates what kind of elements need to be included
9740+
<replaceable class="parameter">filter</replaceable> is a <type>jsonb</type> array, that enumerates what kind of elements need to be included
97419741
into the resulting <type>tsvector</type>. Possible values for <replaceable class="parameter">filter</replaceable> are
97429742
<literal>"string"</literal> (to include all string values), <literal>"numeric"</literal> (to include all numeric values in the string format),
9743-
<literal>"boolean"</literal> (to include all boolean values in the string format "true"/"false"),
9743+
<literal>"boolean"</literal> (to include all Boolean values in the string format <literal>"true"</literal>/<literal>"false"</literal>),
97449744
<literal>"key"</literal> (to include all keys) or <literal>"all"</literal> (to include all above). These values
97459745
can be combined together to include, e.g. all string and numeric values.
97469746
</entry>

doc/src/sgml/jit.sgml

+12-12
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<para>
2424
Just-in-time compilation (<acronym>JIT</acronym>) is the process of turning
2525
some form of interpreted program evaluation into a native program, and
26-
doing so at runtime.
26+
doing so at run time.
2727

2828
For example, instead of using a facility that can evaluate arbitrary SQL
2929
expressions to evaluate an SQL predicate like <literal>WHERE a.col =
@@ -81,7 +81,7 @@
8181
<title>Inlining</title>
8282
<para>
8383
<productname>PostgreSQL</productname> is very extensible and allows new
84-
datatypes, functions, operators and other database objects to be defined;
84+
data types, functions, operators and other database objects to be defined;
8585
see <xref linkend="extend"/>. In fact the built-in ones are implemented
8686
using nearly the same mechanisms. This extensibility implies some
8787
overhead, for example due to function calls (see <xref linkend="xfunc"/>).
@@ -110,18 +110,18 @@
110110
</para>
111111

112112
<para>
113-
The cost of the query will be compared with <xref
114-
linkend="guc-jit-above-cost"/> GUC. If the cost is higher,
113+
The cost of the query will be compared with the setting of <xref
114+
linkend="guc-jit-above-cost"/>. If the cost is higher,
115115
<acronym>JIT</acronym> compilation will be performed.
116116
</para>
117117

118118
<para>
119119
If the planner, based on the above criterion, decided that
120120
<acronym>JIT</acronym> compilation is beneficial, two further decisions are
121-
made. Firstly, if the query is more costly than the <xref
122-
linkend="guc-jit-optimize-above-cost"/> GUC, expensive optimizations are
121+
made. Firstly, if the query is more costly than the setting of <xref
122+
linkend="guc-jit-optimize-above-cost"/>, expensive optimizations are
123123
used to improve the generated code. Secondly, if the query is more costly
124-
than the <xref linkend="guc-jit-inline-above-cost"/> GUC, short functions
124+
than the setting of <xref linkend="guc-jit-inline-above-cost"/>, short functions
125125
and operators used in the query will be inlined. Both of these operations
126126
increase the <acronym>JIT</acronym> overhead, but can reduce query
127127
execution time considerably.
@@ -131,7 +131,7 @@
131131
This cost based decision will be made at plan time, not execution
132132
time. This means that when prepared statements are in use, and the generic
133133
plan is used (see <xref linkend="sql-prepare-notes"/>), the values of the
134-
GUCs set at prepare time take effect, not the settings at execution time.
134+
configuration parameters set at prepare time take effect, not the settings at execution time.
135135
</para>
136136

137137
<note>
@@ -208,7 +208,7 @@ SET
208208
</para>
209209

210210
<para>
211-
For development and debugging purposes a few additional GUCs exist. <xref
211+
For development and debugging purposes a few additional configuration parameters exist. <xref
212212
linkend="guc-jit-dump-bitcode"/> allows the generated bitcode to be
213213
inspected. <xref linkend="guc-jit-debugging-support"/> allows GDB to see
214214
generated functions. <xref linkend="guc-jit-profiling-support"/> emits
@@ -245,7 +245,7 @@ SET
245245
to <filename>$pkglibdir/bitcode/$extension.index.bc</filename>, where
246246
<literal>$pkglibdir</literal> is the directory returned by
247247
<literal>pg_config --pkglibdir</literal> and <literal>$extension</literal>
248-
the basename of the extension's shared library.
248+
the base name of the extension's shared library.
249249

250250
<note>
251251
<para>
@@ -264,8 +264,8 @@ SET
264264
<productname>PostgreSQL</productname> provides a <acronym>JIT</acronym>
265265
implementation based on <productname>LLVM</productname>. The interface to
266266
the <acronym>JIT</acronym> provider is pluggable and the provider can be
267-
changed without recompiling. The provider is chosen via the <xref
268-
linkend="guc-jit-provider"/> <acronym>GUC</acronym>.
267+
changed without recompiling. The provider is chosen via the setting <xref
268+
linkend="guc-jit-provider"/>.
269269
</para>
270270

271271
<sect3>

doc/src/sgml/libpq.sgml

+2-2
Original file line numberDiff line numberDiff line change
@@ -923,12 +923,12 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname
923923
<para>
924924
In the connection URI format, you can list multiple <literal>host:port</literal> pairs
925925
separated by commas, in the <literal>host</literal> component of the URI. In either
926-
format, a single hostname can also translate to multiple network addresses. A
926+
format, a single host name can also translate to multiple network addresses. A
927927
common example of this is a host that has both an IPv4 and an IPv6 address.
928928
</para>
929929

930930
<para>
931-
When multiple hosts are specified, or when a single hostname is
931+
When multiple hosts are specified, or when a single host name is
932932
translated to multiple addresses, all the hosts and addresses will be
933933
tried in order, until one succeeds. If none of the hosts can be reached,
934934
the connection fails. If a connection is established successfully, but

doc/src/sgml/ref/create_statistics.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ EXPLAIN ANALYZE SELECT * FROM t1 WHERE (a = 1) AND (b = 0);
161161
multiply their selectivities together to arrive at a much-too-small
162162
row count estimate.
163163
With such statistics, the planner recognizes that the <literal>WHERE</literal>
164-
conditions are redundant and does not underestimate the rowcount.
164+
conditions are redundant and does not underestimate the row count.
165165
</para>
166166

167167
</refsect1>

doc/src/sgml/ref/pgbench.sgml

+5-5
Original file line numberDiff line numberDiff line change
@@ -511,7 +511,7 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d
511511
<listitem>
512512
<para>
513513
Show progress report every <replaceable>sec</replaceable> seconds. The report
514-
includes the time since the beginning of the run, the tps since the
514+
includes the time since the beginning of the run, the TPS since the
515515
last report, and the transaction latency average and standard
516516
deviation since the last report. Under throttling (<option>-R</option>),
517517
the latency is computed with respect to the transaction scheduled
@@ -727,9 +727,9 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d
727727
</para>
728728
<para>
729729
Remember to take the sampling rate into account when processing the
730-
log file. For example, when computing tps values, you need to multiply
730+
log file. For example, when computing TPS values, you need to multiply
731731
the numbers accordingly (e.g. with 0.01 sample rate, you'll only get
732-
1/100 of the actual tps).
732+
1/100 of the actual TPS).
733733
</para>
734734
</listitem>
735735
</varlistentry>
@@ -967,7 +967,7 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d
967967
Sets variable <replaceable>varname</replaceable> to a value calculated
968968
from <replaceable>expression</replaceable>.
969969
The expression may contain the <literal>NULL</literal> constant,
970-
boolean constants <literal>TRUE</literal> and <literal>FALSE</literal>,
970+
Boolean constants <literal>TRUE</literal> and <literal>FALSE</literal>,
971971
integer constants such as <literal>5432</literal>,
972972
double constants such as <literal>3.14159</literal>,
973973
references to variables <literal>:</literal><replaceable>variablename</replaceable>,
@@ -1485,7 +1485,7 @@ f(x) = PHI(2.0 * parameter * (x - mu) / (max - min + 1)) /
14851485
</listitem>
14861486
<listitem>
14871487
<para>
1488-
<literal>random_zipfian</literal> generates an approximated bounded zipfian
1488+
<literal>random_zipfian</literal> generates an approximated bounded Zipfian
14891489
distribution. For <replaceable>parameter</replaceable> in (0, 1), an
14901490
approximated algorithm is taken from
14911491
"Quickly Generating Billion-Record Synthetic Databases",

doc/src/sgml/ref/psql-ref.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -558,7 +558,7 @@ EOF
558558
<listitem>
559559
<para>
560560
Set the field separator for unaligned output to a zero byte. This is
561-
equvalent to <command>\pset fieldsep_zero</command>.
561+
equivalent to <command>\pset fieldsep_zero</command>.
562562
</para>
563563
</listitem>
564564
</varlistentry>

doc/src/sgml/release-11.sgml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1233,7 +1233,7 @@ same commits as above
12331233
</para>
12341234

12351235
<para>
1236-
Specifically, "ldapsearchfilter" allows pattern matching using
1236+
Specifically, <literal>ldapsearchfilter</literal> allows pattern matching using
12371237
combinations of <acronym>LDAP</acronym> attributes.
12381238
</para>
12391239
</listitem>
@@ -2673,7 +2673,7 @@ same commits as above
26732673
-->
26742674

26752675
<para>
2676-
Speed up lookups of builtin function names matching oids (Andres
2676+
Speed up lookups of built-in function names matching OIDs (Andres
26772677
Freund)
26782678
</para>
26792679

doc/src/sgml/user-manag.sgml

+1-1
Original file line numberDiff line numberDiff line change
@@ -565,7 +565,7 @@ DROP ROLE doomed_role;
565565
<literal>pg_execute_server_program</literal> roles are intended to allow administrators to have
566566
trusted, but non-superuser, roles which are able to access files and run programs on the
567567
database server as the user the database runs as. As these roles are able to access any file on
568-
the server filesystem, they bypass all database-level permission checks when accessing files
568+
the server file system, they bypass all database-level permission checks when accessing files
569569
directly and they could be used to gain superuser-level access, therefore care should be taken
570570
when granting these roles to users.
571571
</para>

0 commit comments

Comments
 (0)