From 5baf6da71701abcb76487d9de68f7d7dc6c365e9 Mon Sep 17 00:00:00 2001 From: Peter Eisentraut Date: Fri, 8 Jun 2012 00:06:20 +0300 Subject: [PATCH] Documentation spell and markup checking --- doc/src/sgml/catalogs.sgml | 4 ++-- doc/src/sgml/docguide.sgml | 4 ++-- doc/src/sgml/ecpg.sgml | 6 +++--- doc/src/sgml/fdwhandler.sgml | 14 +++++++------- doc/src/sgml/file-fdw.sgml | 4 ++-- doc/src/sgml/func.sgml | 12 ++++++------ doc/src/sgml/gin.sgml | 6 +++--- doc/src/sgml/gist.sgml | 2 +- doc/src/sgml/indexam.sgml | 2 +- doc/src/sgml/libpq.sgml | 2 +- doc/src/sgml/maintenance.sgml | 4 ++-- doc/src/sgml/monitoring.sgml | 26 +++++++++++++------------- doc/src/sgml/perform.sgml | 28 ++++++++++++++-------------- doc/src/sgml/pgrowlocks.sgml | 8 ++++---- doc/src/sgml/pgtestfsync.sgml | 2 +- doc/src/sgml/pgtesttiming.sgml | 4 ++-- doc/src/sgml/protocol.sgml | 4 ++-- doc/src/sgml/rangetypes.sgml | 2 +- doc/src/sgml/ref/psql-ref.sgml | 20 ++++++++++---------- doc/src/sgml/rules.sgml | 6 +++--- doc/src/sgml/sepgsql.sgml | 4 ++-- doc/src/sgml/spgist.sgml | 10 +++++----- doc/src/sgml/textsearch.sgml | 4 ++-- doc/src/sgml/xfunc.sgml | 2 +- 24 files changed, 90 insertions(+), 90 deletions(-) diff --git a/doc/src/sgml/catalogs.sgml b/doc/src/sgml/catalogs.sgml index 0f0a10f63c..b00bcf0b6a 100644 --- a/doc/src/sgml/catalogs.sgml +++ b/doc/src/sgml/catalogs.sgml @@ -3886,7 +3886,7 @@ particular operator family is applicable to a particular indexable column data type. The set of operators from the family that are actually usable with the indexed column are whichever ones accept the column's data type - as their lefthand input. + as their left-hand input. @@ -4431,7 +4431,7 @@ The function has no side effects. No information about the arguments is conveyed except via the return value. Any function that might throw an error depending on the values of its arguments - is not leakproof. + is not leak-proof. diff --git a/doc/src/sgml/docguide.sgml b/doc/src/sgml/docguide.sgml index 8aaafb0a34..27fb3ef255 100644 --- a/doc/src/sgml/docguide.sgml +++ b/doc/src/sgml/docguide.sgml @@ -317,12 +317,12 @@ make install Some users have reported encountering a segmentation fault using - openjade 1.4devel to build the PDFs, with a message like: + OpenJade 1.4devel to build the PDFs, with a message like: openjade:./stylesheet.dsl:664:2:E: flow object not accepted by port; only display flow objects accepted make: *** [postgres-A4.tex-pdf] Segmentation fault - Downgrading to openjade 1.3 should get rid of this error. + Downgrading to OpenJade 1.3 should get rid of this error. diff --git a/doc/src/sgml/ecpg.sgml b/doc/src/sgml/ecpg.sgml index 2c5c330023..934ffe88dd 100644 --- a/doc/src/sgml/ecpg.sgml +++ b/doc/src/sgml/ecpg.sgml @@ -2752,7 +2752,7 @@ timestamp PGTYPEStimestamp_from_asc(char *str, char **endptr); In general, the input string can contain any combination of an allowed date specification, a whitespace character and an allowed time - specification. Note that timezones are not supported by ECPG. It can + specification. Note that time zones are not supported by ECPG. It can parse them but does not apply any calculation as the PostgreSQL server does for example. Timezone specifiers are silently discarded. @@ -9164,7 +9164,7 @@ int rtypwidth(int sqltype, int sqllen); int rsetnull(int t, char *ptr); The function receives an integer that indicates the type of the - variable and a pointer to the variable itself that is casted to a C + variable and a pointer to the variable itself that is cast to a C char* pointer. @@ -9249,7 +9249,7 @@ int risnull(int t, char *ptr); The function receives the type of the variable to test (t) as well a pointer to this variable (ptr). Note that the - latter needs to be casted to a char*. See the function for a list of possible variable types. diff --git a/doc/src/sgml/fdwhandler.sgml b/doc/src/sgml/fdwhandler.sgml index 2c75b80b30..8f1782882f 100644 --- a/doc/src/sgml/fdwhandler.sgml +++ b/doc/src/sgml/fdwhandler.sgml @@ -191,7 +191,7 @@ ExplainForeignScan (ForeignScanState *node, related functions to add fields to the EXPLAIN output. The flag fields in es can be used to determine what to print, and the state of the ForeignScanState node - can be inspected to provide runtime statistics in the EXPLAIN + can be inspected to provide run-time statistics in the EXPLAIN ANALYZE case. @@ -489,20 +489,20 @@ GetForeignServerByName(const char *name, bool missing_ok); The fdw_private list has no other restrictions and is not interpreted by the core backend in any way. The fdw_exprs list, if not NIL, is expected to contain - expression trees that are intended to be executed at runtime. These + expression trees that are intended to be executed at run time. These trees will undergo post-processing by the planner to make them fully executable. - In GetForeignPlan, generally the passed-in targetlist can + In GetForeignPlan, generally the passed-in target list can be copied into the plan node as-is. The passed scan_clauses list contains the same clauses as baserel->baserestrictinfo, but may be re-ordered for better execution efficiency. In simple cases the FDW can just strip RestrictInfo nodes from the scan_clauses list (using extract_actual_clauses) and put all the clauses into the plan node's qual list, which means that all the - clauses will be checked by the executor at runtime. More complex FDWs + clauses will be checked by the executor at run time. More complex FDWs may be able to check some of the clauses internally, in which case those clauses can be removed from the plan node's qual list so that the executor doesn't waste time rechecking them. @@ -523,9 +523,9 @@ GetForeignServerByName(const char *name, bool missing_ok); to ensure that it gets massaged into executable form. It would probably also put control information into the plan node's fdw_private field to tell the execution functions what - to do at runtime. The query transmitted to the remote server would + to do at run time. The query transmitted to the remote server would involve something like WHERE foreign_variable = - $1, with the parameter value obtained at runtime from + $1, with the parameter value obtained at run time from evaluation of the fdw_exprs expression tree. @@ -541,7 +541,7 @@ GetForeignServerByName(const char *name, bool missing_ok); required_outer and list the specific join clause(s) in param_clauses. In GetForeignPlan, the local_variable portion of the join clause would be added - to fdw_exprs, and then at runtime the case works the + to fdw_exprs, and then at run time the case works the same as for an ordinary restriction clause. diff --git a/doc/src/sgml/file-fdw.sgml b/doc/src/sgml/file-fdw.sgml index 35d344f5c8..889aa778d7 100644 --- a/doc/src/sgml/file-fdw.sgml +++ b/doc/src/sgml/file-fdw.sgml @@ -122,7 +122,7 @@ - This is a boolean option. If true, it specifies that values of the + This is a Boolean option. If true, it specifies that values of the column should not be matched against the null string (that is, the file-level null option). This has the same effect as listing the column in COPY's @@ -184,7 +184,7 @@ CREATE SERVER pglog FOREIGN DATA WRAPPER file_fdw; Now you are ready to create the foreign data table. Using the CREATE FOREIGN TABLE command, you will need to define - the columns for the table, the CSV filename, and its format: + the columns for the table, the CSV file name, and its format: CREATE FOREIGN TABLE pglog ( diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index 29538888cb..de13c7c476 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -9648,9 +9648,9 @@ table2-mapping array_to_json(anyarray [, pretty_bool]) - Returns the array as JSON. A Postgres multi-dimensional array + Returns the array as JSON. A PostgreSQL multidimensional array becomes a JSON array of arrays. Line feeds will be added between - dimension 1 elements if pretty_bool is true. + dimension 1 elements if pretty_bool is true. array_to_json('{{1,5},{99,100}}'::int[]) [[1,5],[99,100]] @@ -9664,7 +9664,7 @@ table2-mapping Returns the row as JSON. Line feeds will be added between level - 1 elements if pretty_bool is true. + 1 elements if pretty_bool is true. row_to_json(row(1,'foo')) {"f1":1,"f2":"foo"} @@ -13813,7 +13813,7 @@ SELECT pg_type_is_visible('myschema.widget'::regtype); pg_get_viewdef(view_name, pretty_bool) text get underlying SELECT command for view, - lines with fields are wrapped to 80 columns if pretty_bool is true (deprecated) + lines with fields are wrapped to 80 columns if pretty_bool is true (deprecated) pg_get_viewdef(view_oid) @@ -13824,7 +13824,7 @@ SELECT pg_type_is_visible('myschema.widget'::regtype); pg_get_viewdef(view_oid, pretty_bool) text get underlying SELECT command for view, - lines with fields are wrapped to 80 columns if pretty_bool is true + lines with fields are wrapped to 80 columns if pretty_bool is true pg_get_viewdef(view_oid, wrap_int) @@ -13845,7 +13845,7 @@ SELECT pg_type_is_visible('myschema.widget'::regtype); pg_tablespace_location(tablespace_oid) text - get the path in the filesystem that this tablespace is located in + get the path in the file system that this tablespace is located in pg_typeof(any) diff --git a/doc/src/sgml/gin.sgml b/doc/src/sgml/gin.sgml index 7b4d9c4e9e..ca7641a839 100644 --- a/doc/src/sgml/gin.sgml +++ b/doc/src/sgml/gin.sgml @@ -107,9 +107,9 @@ If any of the keys can be null, also palloc an array of *nkeys booleans, store its address at *nullFlags, and set these null flags as needed. - *nullFlags can be left NULL (its initial value) + *nullFlags can be left NULL (its initial value) if all keys are non-null. - The return value can be NULL if the item contains no keys. + The return value can be NULL if the item contains no keys. @@ -313,7 +313,7 @@ - Multi-column GIN indexes are implemented by building + Multicolumn GIN indexes are implemented by building a single B-tree over composite values (column number, key value). The key values for different columns can be of different types. diff --git a/doc/src/sgml/gist.sgml b/doc/src/sgml/gist.sgml index 73bf63fd3a..ed0bc54f52 100644 --- a/doc/src/sgml/gist.sgml +++ b/doc/src/sgml/gist.sgml @@ -665,7 +665,7 @@ my_distance(PG_FUNCTION_ARGS) a lot of random I/O. Beginning in version 9.2, PostgreSQL supports a more efficient method to build GiST indexes based on buffering, which can dramatically reduce the number of random I/Os needed for non-ordered data - sets. For well-ordered datasets the benefit is smaller or non-existent, + sets. For well-ordered data sets the benefit is smaller or non-existent, because only a small number of pages receive new tuples at a time, and those pages fit in cache even if the index as whole does not. diff --git a/doc/src/sgml/indexam.sgml b/doc/src/sgml/indexam.sgml index 28f2ae1627..e03ebc9368 100644 --- a/doc/src/sgml/indexam.sgml +++ b/doc/src/sgml/indexam.sgml @@ -363,7 +363,7 @@ amrescan (IndexScanDesc scan, ScanKey orderbys, int norderbys); - Start or restart an indexscan, possibly with new scan keys. (To restart + Start or restart an index scan, possibly with new scan keys. (To restart using previously-passed keys, NULL is passed for keys and/or orderbys.) Note that it is not allowed for the number of keys or order-by operators to be larger than diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml index ef1d95ed20..5c5dd68db3 100644 --- a/doc/src/sgml/libpq.sgml +++ b/doc/src/sgml/libpq.sgml @@ -805,7 +805,7 @@ postgresql:///mydb?host=localhost&port=5433 - The host part may be either hostname or an IP address. To specify an + The host part may be either host name or an IP address. To specify an IPv6 host address, enclose it in square brackets: postgresql://[2001:db8::1234]/database diff --git a/doc/src/sgml/maintenance.sgml b/doc/src/sgml/maintenance.sgml index cc33e5f76b..fb705b2cbb 100644 --- a/doc/src/sgml/maintenance.sgml +++ b/doc/src/sgml/maintenance.sgml @@ -865,10 +865,10 @@ pg_ctl start | rotatelogs /var/log/pgsql_log 86400 - pgFouine + pgFouine is an external project that does sophisticated log file analysis. check_postgres + url="http://bucardo.org/wiki/Check_postgres">check_postgres provides Nagios alerts when important messages appear in the log files, as well as detection of many other extraordinary conditions. diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml index 830f6217d2..39ccfbb843 100644 --- a/doc/src/sgml/monitoring.sgml +++ b/doc/src/sgml/monitoring.sgml @@ -210,7 +210,7 @@ postgres: user database host PGSTAT_STAT_INTERVAL - milliseconds (500 msec unless altered while building the server). So the + milliseconds (500 ms unless altered while building the server). So the displayed information lags behind actual activity. However, current-query information collected by track_activities is always up-to-date. @@ -472,7 +472,7 @@ postgres: user database host - pg_stat_activity view + <structname>pg_stat_activity</structname> View @@ -649,7 +649,7 @@ postgres: user database host - pg_stat_bgwriter view + <structname>pg_stat_bgwriter</structname> View @@ -736,7 +736,7 @@ postgres: user database host
- pg_stat_database view + <structname>pg_stat_database</structname> View @@ -787,7 +787,7 @@ postgres: user database host bigint Number of times disk blocks were found already in the buffer cache, so that a read was not necessary (this only includes hits in the - PostgreSQL buffer cache, not the operating system's filesystem cache) + PostgreSQL buffer cache, not the operating system's file system cache) @@ -873,7 +873,7 @@ postgres: user database host
- pg_stat_all_tables view + <structname>pg_stat_all_tables</structname> View @@ -1011,7 +1011,7 @@ postgres: user database host
- pg_stat_all_indexes view + <structname>pg_stat_all_indexes</structname> View @@ -1104,7 +1104,7 @@ postgres: user database host
- pg_statio_all_tables view + <structname>pg_statio_all_tables</structname> View @@ -1185,7 +1185,7 @@ postgres: user database host
- pg_statio_all_indexes view + <structname>pg_statio_all_indexes</structname> View @@ -1246,7 +1246,7 @@ postgres: user database host
- pg_statio_all_sequences view + <structname>pg_statio_all_sequences</structname> View @@ -1293,7 +1293,7 @@ postgres: user database host
- pg_stat_user_functions view + <structname>pg_stat_user_functions</structname> View @@ -1348,7 +1348,7 @@ postgres: user database host
- pg_stat_replication view + <structname>pg_stat_replication</structname> View @@ -1462,7 +1462,7 @@ postgres: user database host
- pg_stat_database_conflicts view + <structname>pg_stat_database_conflicts</structname> View diff --git a/doc/src/sgml/perform.sgml b/doc/src/sgml/perform.sgml index 5a8c6fc7dc..1e7544afeb 100644 --- a/doc/src/sgml/perform.sgml +++ b/doc/src/sgml/perform.sgml @@ -265,7 +265,7 @@ EXPLAIN SELECT * FROM tenk1 WHERE unique1 < 100 AND stringu1 = 'xxx'; The added condition stringu1 = 'xxx' reduces the - output-rowcount estimate, but not the cost because we still have to visit + output row count estimate, but not the cost because we still have to visit the same set of rows. Notice that the stringu1 clause cannot be applied as an index condition, since this index is only on the unique1 column. Instead it is applied as a filter on @@ -385,7 +385,7 @@ WHERE t1.unique1 < 10 AND t1.unique2 = t2.unique2; SELECT ... WHERE t2.unique2 = constant case. (The estimated cost is actually a bit lower than what was seen above, as a result of caching that's expected to occur during the repeated - indexscans on t2.) The + index scans on t2.) The costs of the loop node are then set on the basis of the cost of the outer scan, plus one repetition of the inner scan for each outer row (10 * 7.87, here), plus a little CPU time for join processing. @@ -489,8 +489,8 @@ WHERE t1.unique1 < 100 AND t1.unique2 = t2.unique2; the rows in the correct order, but a sequential scan and sort is preferred for onek, because there are many more rows to be visited in that table. - (Seqscan-and-sort frequently beats an indexscan for sorting many rows, - because of the nonsequential disk access required by the indexscan.) + (Sequential-scan-and-sort frequently beats an index scan for sorting many rows, + because of the nonsequential disk access required by the index scan.) @@ -499,7 +499,7 @@ WHERE t1.unique1 < 100 AND t1.unique2 = t2.unique2; flags described in . (This is a crude tool, but useful. See also .) - For example, if we're unconvinced that seqscan-and-sort is the best way to + For example, if we're unconvinced that sequential-scan-and-sort is the best way to deal with table onek in the previous example, we could try @@ -519,7 +519,7 @@ WHERE t1.unique1 < 100 AND t1.unique2 = t2.unique2; which shows that the planner thinks that sorting onek by - indexscanning is about 12% more expensive than seqscan-and-sort. + index-scanning is about 12% more expensive than sequential-scan-and-sort. Of course, the next question is whether it's right about that. We can investigate that using EXPLAIN ANALYZE, as discussed below. @@ -573,7 +573,7 @@ WHERE t1.unique1 < 10 AND t1.unique2 = t2.unique2; comparable with the way that the cost estimates are shown. Multiply by the loops value to get the total time actually spent in the node. In the above example, we spent a total of 0.480 milliseconds - executing the indexscans on tenk2. + executing the index scans on tenk2. @@ -634,7 +634,7 @@ EXPLAIN ANALYZE SELECT * FROM tenk1 WHERE ten < 7; A case similar to filter conditions occurs with lossy - indexscans. For example, consider this search for polygons containing a + index scans. For example, consider this search for polygons containing a specific point: @@ -649,9 +649,9 @@ EXPLAIN ANALYZE SELECT * FROM polygon_tbl WHERE f1 @> polygon '(0.5,2.0)'; The planner thinks (quite correctly) that this sample table is too small - to bother with an indexscan, so we have a plain sequential scan in which + to bother with an index scan, so we have a plain sequential scan in which all the rows got rejected by the filter condition. But if we force an - indexscan to be used, we see: + index scan to be used, we see: SET enable_seqscan TO off; @@ -808,9 +808,9 @@ EXPLAIN ANALYZE SELECT * FROM tenk1 WHERE unique1 < 100 AND unique2 > 9000 Total runtime: 2.857 ms - the estimated cost and rowcount for the Index Scan node are shown as + the estimated cost and row count for the Index Scan node are shown as though it were run to completion. But in reality the Limit node stopped - requesting rows after it got two, so the actual rowcount is only 2 and + requesting rows after it got two, so the actual row count is only 2 and the runtime is less than the cost estimate would suggest. This is not an estimation error, only a discrepancy in the way the estimates and true values are displayed. @@ -827,13 +827,13 @@ EXPLAIN ANALYZE SELECT * FROM tenk1 WHERE unique1 < 100 AND unique2 > 9000 the inner (second) child is backed up and rescanned for the portion of its rows matching that key value. EXPLAIN ANALYZE counts these repeated emissions of the same inner rows as if they were real additional - rows. When there are many outer duplicates, the reported actual rowcount + rows. When there are many outer duplicates, the reported actual row count for the inner child plan node can be significantly larger than the number of rows that are actually in the inner relation. - BitmapAnd and BitmapOr nodes always report their actual rowcounts as zero, + BitmapAnd and BitmapOr nodes always report their actual row counts as zero, due to implementation limitations. diff --git a/doc/src/sgml/pgrowlocks.sgml b/doc/src/sgml/pgrowlocks.sgml index db1cf5e863..390fa236d3 100644 --- a/doc/src/sgml/pgrowlocks.sgml +++ b/doc/src/sgml/pgrowlocks.sgml @@ -52,22 +52,22 @@ pgrowlocks(text) returns setof record locker xid - Transaction ID of locker, or multixact ID if multi-transaction + Transaction ID of locker, or multixact ID if multitransaction multi boolean - True if locker is a multi-transaction + True if locker is a multitransaction xids xid[] - Transaction IDs of lockers (more than one if multi-transaction) + Transaction IDs of lockers (more than one if multitransaction) pids integer[] - Process IDs of locking backends (more than one if multi-transaction) + Process IDs of locking backends (more than one if multitransaction) diff --git a/doc/src/sgml/pgtestfsync.sgml b/doc/src/sgml/pgtestfsync.sgml index ad5ddeb228..d8c0c45808 100644 --- a/doc/src/sgml/pgtestfsync.sgml +++ b/doc/src/sgml/pgtestfsync.sgml @@ -31,7 +31,7 @@ idea of what the fastest is on your specific system, as well as supplying diagnostic information in the event of an - identified I/O problem. However, differences shown by pg_test_fsync + identified I/O problem. However, differences shown by pg_test_fsync might not make any difference in real database throughput, especially since many database servers are not speed-limited by their transaction logs. diff --git a/doc/src/sgml/pgtesttiming.sgml b/doc/src/sgml/pgtesttiming.sgml index 784f866b8d..486be83123 100644 --- a/doc/src/sgml/pgtesttiming.sgml +++ b/doc/src/sgml/pgtesttiming.sgml @@ -101,7 +101,7 @@ Histogram of timing durations: When the query executor is running a statement using EXPLAIN ANALYZE, individual operations are timed as well as showing a summary. The overhead of your system can be checked by - counting rows with the psql program: + counting rows with the psql program: CREATE TABLE t AS SELECT * FROM generate_series(1,100000); @@ -226,7 +226,7 @@ Histogram of timing durations: reliable. There are several ways that TSC can fail to provide an accurate timing source, making it unreliable. Older systems can have a TSC clock that varies based on the CPU temperature, making it unusable for timing. Trying - to use TSC on some older multi-core CPUs can give a reported time that's + to use TSC on some older multicore CPUs can give a reported time that's inconsistent among multiple cores. This can result in the time going backwards, a problem this program checks for. And even the newest systems can fail to provide accurate TSC timing with very aggressive power saving diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml index 71c40cc592..e72556303a 100644 --- a/doc/src/sgml/protocol.sgml +++ b/doc/src/sgml/protocol.sgml @@ -1783,13 +1783,13 @@ The commands accepted in walsender mode are: pg_xlog, including subdirectories. If the backup is run - with wal files included, a synthesized version of pg_xlog will be + with WAL files included, a synthesized version of pg_xlog will be included, but it will only contain the files necessary for the backup to work, not the rest of the contents. - Owner, group and file mode are set if the underlying filesystem on + Owner, group and file mode are set if the underlying file system on the server supports it. diff --git a/doc/src/sgml/rangetypes.sgml b/doc/src/sgml/rangetypes.sgml index 87acca19ea..dcaa4ecf6c 100644 --- a/doc/src/sgml/rangetypes.sgml +++ b/doc/src/sgml/rangetypes.sgml @@ -473,7 +473,7 @@ with existing key (during)=([ 2010-01-01 14:30:00, 2010-01-01 15:30:00 )). You can use the btree_gist - extension to define exclusion constraints on plain scalar datatypes, which + extension to define exclusion constraints on plain scalar data types, which can then be combined with range exclusions for maximum flexibility. For example, after btree_gist is installed, the following constraint will reject overlapping ranges only if the meeting room numbers diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml index 969548ffd0..54890a1db5 100644 --- a/doc/src/sgml/ref/psql-ref.sgml +++ b/doc/src/sgml/ref/psql-ref.sgml @@ -249,7 +249,7 @@ PostgreSQL documentation - Do not use readline for line editing and do not use the history. + Do not use readline for line editing and do not use the history. This can be useful to turn off tab expansion when cutting and pasting. @@ -289,7 +289,7 @@ PostgreSQL documentation Specifies printing options, in the style of \pset. Note that here you have to separate name and value with an equal sign instead of a - space. For example, to set the output format to LaTeX, you could write + space. For example, to set the output format to LaTeX, you could write -P format=latex. @@ -607,7 +607,7 @@ PostgreSQL documentation $ psql "service=myservice sslmode=require" $ psql postgresql://dbmaster:5433/mydb?sslmode=require - This way you can also use LDAP for connection parameter lookup as + This way you can also use LDAP for connection parameter lookup as described in . See for more information on all the available connection options. @@ -1670,9 +1670,9 @@ Tue Oct 26 21:40:57 CEST 1999 The \ir command is similar to \i, but resolves - relative pathnames differently. When executing in interactive mode, + relative file names differently. When executing in interactive mode, the two commands behave identically. However, when invoked from a - script, \ir interprets pathnames relative to the + script, \ir interprets file names relative to the directory in which the script is located, rather than the current working directory. @@ -2001,7 +2001,7 @@ lo_import 152801 formats put out tables that are intended to be included in documents using the respective mark-up language. They are not complete documents! (This might not be - so dramatic in HTML, but in LaTeX you must + so dramatic in HTML, but in LaTeX you must have a complete document wrapper.) @@ -3031,7 +3031,7 @@ testdb=> \set content `cat my_file.txt` testdb=> INSERT INTO my_table VALUES (:'content'); (Note that this still won't work if my_file.txt contains NUL bytes. - psql does not support embedded NUL bytes in variable values.) + psql does not support embedded NUL bytes in variable values.) @@ -3370,7 +3370,7 @@ PSQL_EDITOR_LINENUMBER_ARG='--line ' - Alternative location for the command history file. Tilde ("~") expansion is performed. + Alternative location for the command history file. Tilde (~) expansion is performed. @@ -3380,7 +3380,7 @@ PSQL_EDITOR_LINENUMBER_ARG='--line ' - Alternative location of the user's .psqlrc file. Tilde ("~") expansion is performed. + Alternative location of the user's .psqlrc file. Tilde (~) expansion is performed. @@ -3445,7 +3445,7 @@ PSQL_EDITOR_LINENUMBER_ARG='--line ' Both the system-wide psqlrc file and the user's - ~/.psqlrc file can be made psql-version-specific + ~/.psqlrc file can be made psql-version-specific by appending a dash and the PostgreSQL major or minor psql release number, for example ~/.psqlrc-9.2 or diff --git a/doc/src/sgml/rules.sgml b/doc/src/sgml/rules.sgml index 59a32a8e18..cc02ada7c7 100644 --- a/doc/src/sgml/rules.sgml +++ b/doc/src/sgml/rules.sgml @@ -1892,7 +1892,7 @@ CREATE VIEW phone_number WITH (security_barrier) AS The query planner has more flexibility when dealing with functions that - have no side effects. Such functions are referred to as LEAKPROOF, and + have no side effects. Such functions are referred to as LEAKPROOF, and include many simple, commonly used operators, such as many equality operators. The query planner can safely allow such functions to be evaluated at any point in the query execution process, since invoking them on rows @@ -1910,11 +1910,11 @@ CREATE VIEW phone_number WITH (security_barrier) AS in the limited sense that the contents of the invisible tuples will not be passed to possibly-insecure functions. The user may well have other means of making inferences about the unseen data; for example, they can see the - query plan using EXPLAIN, or measure the runtime of + query plan using EXPLAIN, or measure the run time of queries against the view. A malicious attacker might be able to infer something about the amount of unseen data, or even gain some information about the data distribution or most common values (since these things may - affect the runtime of the plan; or even, since they are also reflected in + affect the run time of the plan; or even, since they are also reflected in the optimizer statistics, the choice of plan). If these types of "covert channel" attacks are of concern, it is probably unwise to grant any access to the data at all. diff --git a/doc/src/sgml/sepgsql.sgml b/doc/src/sgml/sepgsql.sgml index 730521a521..ff083a0659 100644 --- a/doc/src/sgml/sepgsql.sgml +++ b/doc/src/sgml/sepgsql.sgml @@ -178,7 +178,7 @@ $ for DBNAME in template0 template1 postgres; do Once built, install this policy package using the semodule command, which loads supplied policy packages into the kernel. If the package is correctly installed, - semodule -l should list sepgsql-regtest as an + semodule -l should list sepgsql-regtest as an available policy package: @@ -467,7 +467,7 @@ UPDATE t1 SET x = 2, y = md5sum(y) WHERE z = 100; Trusted Procedures - Trusted procedures are similar to security definer functions or set-uid + Trusted procedures are similar to security definer functions or setuid commands. SELinux provides a feature to allow trusted code to run using a security label different from that of the client, generally for the purpose of providing highly controlled access to diff --git a/doc/src/sgml/spgist.sgml b/doc/src/sgml/spgist.sgml index fd312cf436..cec40b8172 100644 --- a/doc/src/sgml/spgist.sgml +++ b/doc/src/sgml/spgist.sgml @@ -102,12 +102,12 @@ - The SP-GiST core code takes care of NULL entries. + The SP-GiST core code takes care of null entries. Although SP-GiST indexes do store entries for nulls in indexed columns, this is hidden from the index operator class code: no null index entries or search conditions will ever be passed to the operator class methods. (It is assumed that SP-GiST - operators are strict and so cannot succeed for NULL values.) NULLs + operators are strict and so cannot succeed for null values.) Null values are therefore not discussed further here. @@ -136,7 +136,7 @@ Returns static information about the index implementation, including - the datatype OIDs of the prefix and node label data types. + the data type OIDs of the prefix and node label data types. The SQL declaration of the function must look like this: @@ -163,7 +163,7 @@ typedef struct spgConfigOut attType is passed in order to support polymorphic - index operator classes; for ordinary fixed-data-type opclasses, it + index operator classes; for ordinary fixed-data-type operator classes, it will always have the same value and so can be ignored. @@ -626,7 +626,7 @@ typedef struct spgLeafConsistentOut This section covers implementation details and other tricks that are - useful for implementors of SP-GiST operator classes to + useful for implementers of SP-GiST operator classes to know. diff --git a/doc/src/sgml/textsearch.sgml b/doc/src/sgml/textsearch.sgml index 46db103cb8..978aa545cf 100644 --- a/doc/src/sgml/textsearch.sgml +++ b/doc/src/sgml/textsearch.sgml @@ -2292,8 +2292,8 @@ SELECT ts_lexize('public.simple_dict','The'); word with a synonym. Phrases are not supported (use the thesaurus template () for that). A synonym dictionary can be used to overcome linguistic problems, for example, to - prevent an English stemmer dictionary from reducing the word 'Paris' to - 'pari'. It is enough to have a Paris paris line in the + prevent an English stemmer dictionary from reducing the word Paris to + pari. It is enough to have a Paris paris line in the synonym dictionary and put it before the english_stem dictionary. For example: diff --git a/doc/src/sgml/xfunc.sgml b/doc/src/sgml/xfunc.sgml index 58df90e30f..e2b10703ee 100644 --- a/doc/src/sgml/xfunc.sgml +++ b/doc/src/sgml/xfunc.sgml @@ -1768,7 +1768,7 @@ typedef struct Finally, all variable-length types must also be passed by reference. All variable-length types must begin with an opaque length field of exactly 4 bytes, which will be set - by SET_VARSIZE; never set this field directly! All data to + by SET_VARSIZE; never set this field directly! All data to be stored within that type must be located in the memory immediately following that length field. The length field contains the total length of the structure,