From: Peter Eisentraut Date: Fri, 29 Jun 2018 19:26:41 +0000 (+0200) Subject: Documentation spell checking and markup improvements X-Git-Tag: REL_11_BETA3~121 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=f7481d2c3c52042030269b91bfeb00f120adb618;p=postgresql Documentation spell checking and markup improvements --- diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml index cc2873f536..5b913f00c1 100644 --- a/doc/src/sgml/config.sgml +++ b/doc/src/sgml/config.sgml @@ -2148,7 +2148,7 @@ include_dir 'conf.d' pool of processes established by , limited by . Note that the requested - number of workers may not actually be available at runtime. + number of workers may not actually be available at run time. If this occurs, the utility operation will run with fewer workers than expected. The default value is 2. Setting this 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) Writes the generated LLVM IR out to the - filesystem, inside . This is only + file system, inside . This is only useful for working on the internals of the JIT implementation. The default setting is off, and it can only be diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index 5dce8ef178..edc9be92a6 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -9737,10 +9737,10 @@ CREATE TYPE rainbow AS ENUM ('red', 'orange', 'yellow', 'green', 'blue', 'purple reduce each value in the document, specified by filter to a tsvector, and then concatenate those in document order to produce a single tsvector. - filter is a jsonb array, that enumerates what kind of elements need to be included + filter is a jsonb array, that enumerates what kind of elements need to be included into the resulting tsvector. Possible values for filter are "string" (to include all string values), "numeric" (to include all numeric values in the string format), - "boolean" (to include all boolean values in the string format "true"/"false"), + "boolean" (to include all Boolean values in the string format "true"/"false"), "key" (to include all keys) or "all" (to include all above). These values can be combined together to include, e.g. all string and numeric values. diff --git a/doc/src/sgml/jit.sgml b/doc/src/sgml/jit.sgml index 1abec1ef42..61cfd59473 100644 --- a/doc/src/sgml/jit.sgml +++ b/doc/src/sgml/jit.sgml @@ -23,7 +23,7 @@ Just-in-time compilation (JIT) is the process of turning some form of interpreted program evaluation into a native program, and - doing so at runtime. + doing so at run time. For example, instead of using a facility that can evaluate arbitrary SQL expressions to evaluate an SQL predicate like WHERE a.col = @@ -81,7 +81,7 @@ Inlining PostgreSQL is very extensible and allows new - datatypes, functions, operators and other database objects to be defined; + data types, functions, operators and other database objects to be defined; see . In fact the built-in ones are implemented using nearly the same mechanisms. This extensibility implies some overhead, for example due to function calls (see ). @@ -110,18 +110,18 @@ - The cost of the query will be compared with GUC. If the cost is higher, + The cost of the query will be compared with the setting of . If the cost is higher, JIT compilation will be performed. If the planner, based on the above criterion, decided that JIT compilation is beneficial, two further decisions are - made. Firstly, if the query is more costly than the GUC, expensive optimizations are + made. Firstly, if the query is more costly than the setting of , expensive optimizations are used to improve the generated code. Secondly, if the query is more costly - than the GUC, short functions + than the setting of , short functions and operators used in the query will be inlined. Both of these operations increase the JIT overhead, but can reduce query execution time considerably. @@ -131,7 +131,7 @@ This cost based decision will be made at plan time, not execution time. This means that when prepared statements are in use, and the generic plan is used (see ), the values of the - GUCs set at prepare time take effect, not the settings at execution time. + configuration parameters set at prepare time take effect, not the settings at execution time. @@ -208,7 +208,7 @@ SET - For development and debugging purposes a few additional GUCs exist. allows the generated bitcode to be inspected. allows GDB to see generated functions. emits @@ -245,7 +245,7 @@ SET to $pkglibdir/bitcode/$extension.index.bc, where $pkglibdir is the directory returned by pg_config --pkglibdir and $extension - the basename of the extension's shared library. + the base name of the extension's shared library. @@ -264,8 +264,8 @@ SET PostgreSQL provides a JIT implementation based on LLVM. The interface to the JIT provider is pluggable and the provider can be - changed without recompiling. The provider is chosen via the GUC. + changed without recompiling. The provider is chosen via the setting . diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml index 498b8df988..515bcb6779 100644 --- a/doc/src/sgml/libpq.sgml +++ b/doc/src/sgml/libpq.sgml @@ -923,12 +923,12 @@ postgresql://%2Fvar%2Flib%2Fpostgresql/dbname In the connection URI format, you can list multiple host:port pairs separated by commas, in the host component of the URI. In either - format, a single hostname can also translate to multiple network addresses. A + format, a single host name can also translate to multiple network addresses. A common example of this is a host that has both an IPv4 and an IPv6 address. - When multiple hosts are specified, or when a single hostname is + When multiple hosts are specified, or when a single host name is translated to multiple addresses, all the hosts and addresses will be tried in order, until one succeeds. If none of the hosts can be reached, the connection fails. If a connection is established successfully, but diff --git a/doc/src/sgml/ref/create_statistics.sgml b/doc/src/sgml/ref/create_statistics.sgml index 382a1eb64b..539f5bded5 100644 --- a/doc/src/sgml/ref/create_statistics.sgml +++ b/doc/src/sgml/ref/create_statistics.sgml @@ -161,7 +161,7 @@ EXPLAIN ANALYZE SELECT * FROM t1 WHERE (a = 1) AND (b = 0); multiply their selectivities together to arrive at a much-too-small row count estimate. With such statistics, the planner recognizes that the WHERE - conditions are redundant and does not underestimate the rowcount. + conditions are redundant and does not underestimate the row count. diff --git a/doc/src/sgml/ref/pgbench.sgml b/doc/src/sgml/ref/pgbench.sgml index 7f92c7755e..88cf8b3933 100644 --- a/doc/src/sgml/ref/pgbench.sgml +++ b/doc/src/sgml/ref/pgbench.sgml @@ -511,7 +511,7 @@ pgbench options d Show progress report every sec seconds. The report - includes the time since the beginning of the run, the tps since the + includes the time since the beginning of the run, the TPS since the last report, and the transaction latency average and standard deviation since the last report. Under throttling (), the latency is computed with respect to the transaction scheduled @@ -727,9 +727,9 @@ pgbench options d Remember to take the sampling rate into account when processing the - log file. For example, when computing tps values, you need to multiply + log file. For example, when computing TPS values, you need to multiply the numbers accordingly (e.g. with 0.01 sample rate, you'll only get - 1/100 of the actual tps). + 1/100 of the actual TPS). @@ -967,7 +967,7 @@ pgbench options d Sets variable varname to a value calculated from expression. The expression may contain the NULL constant, - boolean constants TRUE and FALSE, + Boolean constants TRUE and FALSE, integer constants such as 5432, double constants such as 3.14159, references to variables :variablename, @@ -1485,7 +1485,7 @@ f(x) = PHI(2.0 * parameter * (x - mu) / (max - min + 1)) / - random_zipfian generates an approximated bounded zipfian + random_zipfian generates an approximated bounded Zipfian distribution. For parameter in (0, 1), an approximated algorithm is taken from "Quickly Generating Billion-Record Synthetic Databases", diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml index 10b97950ec..b17039d60f 100644 --- a/doc/src/sgml/ref/psql-ref.sgml +++ b/doc/src/sgml/ref/psql-ref.sgml @@ -558,7 +558,7 @@ EOF Set the field separator for unaligned output to a zero byte. This is - equvalent to \pset fieldsep_zero. + equivalent to \pset fieldsep_zero. diff --git a/doc/src/sgml/release-11.sgml b/doc/src/sgml/release-11.sgml index 53b600b453..51a5501482 100644 --- a/doc/src/sgml/release-11.sgml +++ b/doc/src/sgml/release-11.sgml @@ -1233,7 +1233,7 @@ same commits as above - Specifically, "ldapsearchfilter" allows pattern matching using + Specifically, ldapsearchfilter allows pattern matching using combinations of LDAP attributes. @@ -2673,7 +2673,7 @@ same commits as above --> - Speed up lookups of builtin function names matching oids (Andres + Speed up lookups of built-in function names matching OIDs (Andres Freund) diff --git a/doc/src/sgml/user-manag.sgml b/doc/src/sgml/user-manag.sgml index 81b44a8c41..6106244d32 100644 --- a/doc/src/sgml/user-manag.sgml +++ b/doc/src/sgml/user-manag.sgml @@ -565,7 +565,7 @@ DROP ROLE doomed_role; pg_execute_server_program roles are intended to allow administrators to have trusted, but non-superuser, roles which are able to access files and run programs on the database server as the user the database runs as. As these roles are able to access any file on - the server filesystem, they bypass all database-level permission checks when accessing files + the server file system, they bypass all database-level permission checks when accessing files directly and they could be used to gain superuser-level access, therefore care should be taken when granting these roles to users.