From 5ec30faee6ad9e97366579fe578d2cbe0d36413c Mon Sep 17 00:00:00 2001 From: Peter Eisentraut Date: Mon, 13 Dec 2004 18:05:10 +0000 Subject: [PATCH] Spell checker run --- doc/src/sgml/array.sgml | 8 ++-- doc/src/sgml/backup.sgml | 24 +++++------ doc/src/sgml/catalogs.sgml | 8 ++-- doc/src/sgml/ddl.sgml | 4 +- doc/src/sgml/external-projects.sgml | 20 +++------ doc/src/sgml/func.sgml | 6 +-- doc/src/sgml/installation.sgml | 6 +-- doc/src/sgml/libpq.sgml | 4 +- doc/src/sgml/maintenance.sgml | 6 +-- doc/src/sgml/manage-ag.sgml | 8 ++-- doc/src/sgml/plperl.sgml | 4 +- doc/src/sgml/plpgsql.sgml | 4 +- doc/src/sgml/protocol.sgml | 4 +- doc/src/sgml/ref/alter_user.sgml | 4 +- doc/src/sgml/ref/copy.sgml | 4 +- doc/src/sgml/ref/create_cast.sgml | 8 ++-- doc/src/sgml/ref/create_table.sgml | 7 +-- doc/src/sgml/ref/create_table_as.sgml | 10 ++--- doc/src/sgml/ref/psql-ref.sgml | 8 ++-- doc/src/sgml/release.sgml | 52 +++++++++++------------ doc/src/sgml/rowtypes.sgml | 8 ++-- doc/src/sgml/runtime.sgml | 58 ++++++++++++------------- doc/src/sgml/sources.sgml | 80 +++++++++++++++++------------------ doc/src/sgml/spi.sgml | 10 ++--- doc/src/sgml/syntax.sgml | 4 +- doc/src/sgml/trigger.sgml | 8 ++-- doc/src/sgml/xfunc.sgml | 10 ++--- 27 files changed, 183 insertions(+), 194 deletions(-) diff --git a/doc/src/sgml/array.sgml b/doc/src/sgml/array.sgml index ff8d6be531..ec6805f064 100644 --- a/doc/src/sgml/array.sgml +++ b/doc/src/sgml/array.sgml @@ -1,4 +1,4 @@ - + Arrays @@ -547,8 +547,8 @@ SELECT * FROM sal_emp WHERE 10000 = ALL (pay_by_quarter); equal to one, an additional decoration that indicates the actual array dimensions will precede the array structure decoration. The decoration consists of square braces ([ and ]) - around each array dimension's lower and upper bound indicies, plus - a colon (:) delimiter character inbetween. Delimiting the + around each array dimension's lower and upper bound indices, plus + a colon (:) delimiter character in between. Delimiting the array dimension decoration from the array structure decoration is a single assignment operator (=). For example: @@ -569,7 +569,7 @@ SELECT ARRAY[1,2] || ARRAY[[3,4]] AS array; - In a similar fashion, an array with non-default indicies may be specified + In a similar fashion, an array with non-default indices may be specified using the same literal syntax. For example: SELECT f1[1][-2][3] AS e1, f1[1][-1][5] AS e2 diff --git a/doc/src/sgml/backup.sgml b/doc/src/sgml/backup.sgml index c50f2deb49..bdfae16869 100644 --- a/doc/src/sgml/backup.sgml +++ b/doc/src/sgml/backup.sgml @@ -1,5 +1,5 @@ Backup and Restore @@ -317,7 +317,7 @@ tar -cf backup.tar /usr/local/pgsql/data get a usable backup. Half-way measures such as disallowing all connections will not work (mainly because tar and similar tools do not take an - atomic snapshot of the state of the filesystem at a point in + atomic snapshot of the state of the file system at a point in time). Information about stopping the server can be found in . Needless to say that you also need to shut down the server before restoring the data. @@ -365,7 +365,7 @@ tar -cf backup.tar /usr/local/pgsql/data If your database is spread across multiple volumes (for example, data files and WAL log on different disks) there may not be any way to obtain exactly-simultaneous frozen snapshots of all the volumes. - Read your filesystem documentation very carefully before trusting + Read your file system documentation very carefully before trusting to the consistent-snapshot technique in such situations. @@ -402,7 +402,7 @@ tar -cf backup.tar /usr/local/pgsql/data database can be restored to consistency by replaying the log entries made since the last checkpoint. However, the existence of the log makes it possible to use a third strategy for backing up - databases: we can combine a filesystem-level backup with backup of + databases: we can combine a file-system-level backup with backup of the WAL files. If recovery is needed, we restore the backup and then replay from the backed-up WAL files to bring the backup up to current time. This approach is more complex to administer than @@ -414,7 +414,7 @@ tar -cf backup.tar /usr/local/pgsql/data We do not need a perfectly consistent backup as the starting point. Any internal inconsistency in the backup will be corrected by log replay (this is not significantly different from what happens during - crash recovery). So we don't need filesystem snapshot capability, + crash recovery). So we don't need file system snapshot capability, just tar or a similar archiving tool. @@ -449,7 +449,7 @@ tar -cf backup.tar /usr/local/pgsql/data - As with the plain filesystem-backup technique, this method can only + As with the plain file-system-backup technique, this method can only support restoration of an entire database cluster, not a subset. Also, it requires a lot of archival storage: the base backup may be bulky, and a busy system will generate many megabytes of WAL traffic that @@ -618,7 +618,7 @@ archive_command = 'test ! -f .../%f && cp %p .../%f' postgresql.conf, pg_hba.conf and pg_ident.conf) after the initial base backup. You may wish to keep the configuration files in a location that will - be backed up by your regular filesystem backup procedures. + be backed up by your regular file system backup procedures. @@ -655,7 +655,7 @@ SELECT pg_start_backup('label'); - Perform the backup, using any convenient filesystem-backup tool + Perform the backup, using any convenient file-system-backup tool such as tar or cpio. It is neither necessary nor desirable to stop normal operation of the database while you do this. @@ -867,7 +867,7 @@ restore_command = 'cp /mnt/server/archivedir/%f %p' It is important that the command return nonzero exit status on failure. The command will be asked for log files that are not present in the archive; it must return nonzero when so asked. This is not an - error condition. Be aware also that the basename of the %p + error condition. Be aware also that the base name of the %p path will be different from %f; do not expect them to be interchangeable. @@ -948,7 +948,7 @@ restore_command = 'copy /mnt/server/archivedir/%f "%p"' # Windows - This parameter specifies the timestamp up to which recovery + This parameter specifies the time stamp up to which recovery will proceed. At most one of recovery_target_time and can be specified. @@ -1098,7 +1098,7 @@ restore_command = 'copy /mnt/server/archivedir/%f "%p"' # Windows - Operations on non-btree indexes (hash, R-tree, and GiST indexes) are + Operations on non-B-tree indexes (hash, R-tree, and GiST indexes) are not presently WAL-logged, so replay will not update these index types. The recommended workaround is to manually REINDEX each such index after completing a recovery operation. @@ -1196,7 +1196,7 @@ psql template1 < backup You will always need a SQL dump (pg_dump dump) for - migrating to a new release. Filesystem-level backups (including + migrating to a new release. File-system-level backups (including on-line backups) will not work, for the same reason that you can't just do the update in-place: the file formats won't necessarily be compatible across major releases. diff --git a/doc/src/sgml/catalogs.sgml b/doc/src/sgml/catalogs.sgml index 92382c620a..554d75adb2 100644 --- a/doc/src/sgml/catalogs.sgml +++ b/doc/src/sgml/catalogs.sgml @@ -1,6 +1,6 @@ @@ -980,7 +980,7 @@ represents converting from one type to another and applying a length coercion in a single step. When no such entry is available, coercion to a type that uses a type modifier involves two steps, one to - convert between datatypes and a second to apply the modifier. + convert between data types and a second to apply the modifier. @@ -1037,7 +1037,7 @@ oid pg_type.oid - The OID of the data type that corresponds to this table's rowtype, + The OID of the data type that corresponds to this table's row type, if any (zero for indexes, which have no pg_type entry) @@ -2010,7 +2010,7 @@ indclass oidvector - pg_opclass.oid + pg_opclass.oid For each column in the index key this contains the OID of the operator class to use. See diff --git a/doc/src/sgml/ddl.sgml b/doc/src/sgml/ddl.sgml index fd18cd2a9e..4f6b86dbe0 100644 --- a/doc/src/sgml/ddl.sgml +++ b/doc/src/sgml/ddl.sgml @@ -1,4 +1,4 @@ - + Data Definition @@ -1148,7 +1148,7 @@ WHERE c.altitude > 500 and c.tableoid = p.oid; UNIQUE or a PRIMARY KEY, this would not stop the capitals table from having rows with names duplicating rows in cities. And those duplicate rows would by - default show up in SELECTs from cities. In fact, by + default show up in queries from cities. In fact, by default capitals would have no unique constraint at all, and so could contain multiple rows with the same name. You could add a unique constraint to capitals, but this diff --git a/doc/src/sgml/external-projects.sgml b/doc/src/sgml/external-projects.sgml index ab12a36af0..bcef777329 100644 --- a/doc/src/sgml/external-projects.sgml +++ b/doc/src/sgml/external-projects.sgml @@ -1,5 +1,5 @@ @@ -44,16 +44,6 @@ $PostgreSQL: pgsql/doc/src/sgml/external-projects.sgml,v 1.4 2004/12/03 06:30:40 - ODBC - - - This is the most common interface for Windows - applications. - - - - - psqlODBC @@ -155,7 +145,7 @@ $PostgreSQL: pgsql/doc/src/sgml/external-projects.sgml,v 1.4 2004/12/03 06:30:40 separate projects. pgFoundry at http://pgfoundry.org contains even more projects. Other projects are not even hosted on these - servers and you will have to do an internet search to find them. + servers and you will have to do an Internet search to find them. @@ -171,21 +161,21 @@ $PostgreSQL: pgsql/doc/src/sgml/external-projects.sgml,v 1.4 2004/12/03 06:30:40 PostgreSQL was designed from the start to be extensible. For this reason, extensions loaded into the database can function just like features that are packaged with the database. The - /contrib directory shipped with the source code + contrib/ directory shipped with the source code contains a large number of extensions. The README file in that directory contains a summary. They include conversion tools, full-text indexing, XML tools, and additional data types and indexing methods. Other extensions are developed independently, like PostGIS. Even PostgreSQL replication solutions are developed externally. For example, - Slony is a popular master/slave replication solution + Slony-I is a popular master/slave replication solution that is developed independently from the main projects. There are several administration tools available for PostgreSQL. The most popular is - pgadmin, and there are several commercially + pgAdmin, and there are several commercially available ones. diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index 5222b33c27..15774a3a00 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -1,5 +1,5 @@ @@ -8553,7 +8553,7 @@ SELECT pg_type_is_visible('myschema.widget'::regtype); pg_get_serial_sequence(table_name, column_name) text - get name of the sequence that a serial or bigserial column + get name of the sequence that a serial or bigserial column uses @@ -8801,7 +8801,7 @@ SELECT set_config('log_statement_stats', 'off', false); This function returns 1 if successful, 0 if not successful. The process ID (pid) of an active backend can be found from the procpid column in the - pg_stat_activity view, or by listing the postgres + pg_stat_activity view, or by listing the postgres processes on the server with ps. diff --git a/doc/src/sgml/installation.sgml b/doc/src/sgml/installation.sgml index 492c840b52..9e151f8aea 100644 --- a/doc/src/sgml/installation.sgml +++ b/doc/src/sgml/installation.sgml @@ -1,4 +1,4 @@ - + <![%standalone-include[<productname>PostgreSQL</>]]> @@ -173,8 +173,8 @@ su - postgres <para> To build the <application>PL/Python</> server programming language, you need a <productname>Python</productname> - installation with the header files and the distutils module. - The distutils module is included by default with + installation with the header files and the <application>distutils</application> module. + The <application>distutils</application> module is included by default with <productname>Python</productname> 1.6 and later; users of earlier versions of <productname>Python</productname> will need to install it. diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml index cfcc7c9656..b2112d8957 100644 --- a/doc/src/sgml/libpq.sgml +++ b/doc/src/sgml/libpq.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/libpq.sgml,v 1.170 2004/12/02 15:32:52 momjian Exp $ +$PostgreSQL: pgsql/doc/src/sgml/libpq.sgml,v 1.171 2004/12/13 18:05:08 petere Exp $ --> <chapter id="libpq"> @@ -1203,7 +1203,7 @@ about such errors. </para> <para> -At present, there is no way to determine the actual datatype inferred for +At present, there is no way to determine the actual data type inferred for any parameters whose types are not specified in <parameter>paramTypes[]</>. This is a <application>libpq</> omission that will probably be rectified in a future release. diff --git a/doc/src/sgml/maintenance.sgml b/doc/src/sgml/maintenance.sgml index 081c8fb697..02db43f049 100644 --- a/doc/src/sgml/maintenance.sgml +++ b/doc/src/sgml/maintenance.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/maintenance.sgml,v 1.38 2004/11/15 06:32:14 neilc Exp $ +$PostgreSQL: pgsql/doc/src/sgml/maintenance.sgml,v 1.39 2004/12/13 18:05:08 petere Exp $ --> <chapter id="maintenance"> @@ -183,7 +183,7 @@ $PostgreSQL: pgsql/doc/src/sgml/maintenance.sgml,v 1.38 2004/11/15 06:32:14 neil basis, consider doing it with <command>TRUNCATE</command> rather than using <command>DELETE</command> followed by <command>VACUUM</command>. <command>TRUNCATE</command> removes the - entire content of the table immediately, without recquiring a + entire content of the table immediately, without requiring a subsequent <command>VACUUM</command> or <command>VACUUM FULL</command> to reclaim the now-unused disk space. </para> @@ -502,7 +502,7 @@ pg_ctl start | rotatelogs /var/log/pgsql_log 86400 just when you need them the most. Also, on <productname>linux</>, <application>syslog</> will sync each message to disk, yielding poor performance. (You can use a <literal>-</> at the start of the file name - in the <application>syslog</> config file to disable this behavior.) + in the <application>syslog</> configuration file to disable this behavior.) </para> <para> diff --git a/doc/src/sgml/manage-ag.sgml b/doc/src/sgml/manage-ag.sgml index 5f01b66ac7..c78b8fefb8 100644 --- a/doc/src/sgml/manage-ag.sgml +++ b/doc/src/sgml/manage-ag.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/manage-ag.sgml,v 2.37 2004/12/02 19:28:48 tgl Exp $ +$PostgreSQL: pgsql/doc/src/sgml/manage-ag.sgml,v 2.38 2004/12/13 18:05:08 petere Exp $ --> <chapter id="managing-databases"> @@ -379,10 +379,10 @@ CREATE TABLESPACE fastspace LOCATION '/mnt/sda1/postgresql/data'; <note> <para> There is usually not much point in making more than one - tablespace per logical filesystem, since you cannot control the location - of individual files within a logical filesystem. However, + tablespace per logical file system, since you cannot control the location + of individual files within a logical file system. However, <productname>PostgreSQL</> does not enforce any such limitation, and - indeed it is not directly aware of the filesystem boundaries on your + indeed it is not directly aware of the file system boundaries on your system. It just stores files in the directories you tell it to use. </para> </note> diff --git a/doc/src/sgml/plperl.sgml b/doc/src/sgml/plperl.sgml index a1653a3ac7..376761c53b 100644 --- a/doc/src/sgml/plperl.sgml +++ b/doc/src/sgml/plperl.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/plperl.sgml,v 2.33 2004/12/11 20:03:37 petere Exp $ +$PostgreSQL: pgsql/doc/src/sgml/plperl.sgml,v 2.34 2004/12/13 18:05:08 petere Exp $ --> <chapter id="plperl"> @@ -295,7 +295,7 @@ $$ LANGUAGE plperl; <para> Here is an example of a PL/Perl function returning a row set of a composite type. Since a row set is always a reference to an array - and a composite type is always a reference to a hash, a rowset of a + and a composite type is always a reference to a hash, a row set of a composite type is a reference to an array of hash references. <programlisting> CREATE TYPE testsetperl AS (f1 integer, f2 text, f3 text); diff --git a/doc/src/sgml/plpgsql.sgml b/doc/src/sgml/plpgsql.sgml index 15499720f3..443d82f63f 100644 --- a/doc/src/sgml/plpgsql.sgml +++ b/doc/src/sgml/plpgsql.sgml @@ -1,5 +1,5 @@ <!-- -$PostgreSQL: pgsql/doc/src/sgml/plpgsql.sgml,v 1.50 2004/12/03 17:12:09 momjian Exp $ +$PostgreSQL: pgsql/doc/src/sgml/plpgsql.sgml,v 1.51 2004/12/13 18:05:08 petere Exp $ --> <chapter id="plpgsql"> @@ -2576,7 +2576,7 @@ CREATE TRIGGER emp_stamp BEFORE INSERT OR UPDATE ON emp <para> This example trigger ensures that any insert, update or delete of a row - in the emp table is recorded (i.e. audited) in the emp_audit table. + in the <literal>emp</literal> table is recorded (i.e., audited) in the <literal>emp_audit</literal> table. The current time and user name are stamped into the row, together with the type of operation performed on it. </para> diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml index 15e03c3d36..0818e053b6 100644 --- a/doc/src/sgml/protocol.sgml +++ b/doc/src/sgml/protocol.sgml @@ -1,4 +1,4 @@ -<!-- $PostgreSQL: pgsql/doc/src/sgml/protocol.sgml,v 1.55 2004/11/15 06:32:14 neilc Exp $ --> +<!-- $PostgreSQL: pgsql/doc/src/sgml/protocol.sgml,v 1.56 2004/12/13 18:05:08 petere Exp $ --> <chapter id="protocol"> <title>Frontend/Backend Protocol @@ -902,7 +902,7 @@ The function call was completed and returned the result given in the message. (Note that the Function Call protocol can only handle a single - scalar result, not a rowtype or set of results.) + scalar result, not a row type or set of results.) diff --git a/doc/src/sgml/ref/alter_user.sgml b/doc/src/sgml/ref/alter_user.sgml index e74da13c87..f552fe01a2 100644 --- a/doc/src/sgml/ref/alter_user.sgml +++ b/doc/src/sgml/ref/alter_user.sgml @@ -1,5 +1,5 @@ @@ -57,7 +57,7 @@ ALTER USER name RESET The second variant changes the name of the user. Only a database superuser can rename user accounts. The session user cannot be renamed. (Connect as a different user if you need to do that.) - Because MD5-encrypted passwords use the username as + Because MD5-encrypted passwords use the user name as cryptographic salt, renaming a user clears their MD5 password. diff --git a/doc/src/sgml/ref/copy.sgml b/doc/src/sgml/ref/copy.sgml index 96e0caecb8..ba82f4f1c2 100644 --- a/doc/src/sgml/ref/copy.sgml +++ b/doc/src/sgml/ref/copy.sgml @@ -1,5 +1,5 @@ @@ -231,7 +231,7 @@ COPY tablename [ ( In CSV COPY FROM mode, process each - specified column as though it were quoted and hance not a + specified column as though it were quoted and hence not a NULL value. For the default null string in CSV mode (''), this causes a missing values to be input as a zero-length strings. diff --git a/doc/src/sgml/ref/create_cast.sgml b/doc/src/sgml/ref/create_cast.sgml index c36f12675b..a6461a6525 100644 --- a/doc/src/sgml/ref/create_cast.sgml +++ b/doc/src/sgml/ref/create_cast.sgml @@ -1,4 +1,4 @@ - + @@ -198,7 +198,7 @@ SELECT 'The time is ' || CAST(now() AS text); (Bizarrely, the SQL spec demands different behaviors for explicit and implicit casts in some cases. This argument is supplied for functions that must implement such casts. It is not recommended that you design - your own datatypes so that this matters.) + your own data types so that this matters.) @@ -219,7 +219,7 @@ SELECT 'The time is ' || CAST(now() AS text); represents converting from one type to another and applying a length coercion in a single step. When no such entry is available, coercion to a type that uses a type modifier involves two steps, one to - convert between datatypes and a second to apply the modifier. + convert between data types and a second to apply the modifier. @@ -251,7 +251,7 @@ SELECT 'The time is ' || CAST(now() AS text); While not required, it is recommended that you continue to follow this old convention of naming cast implementation functions after the target data - type. Many users are used to being able to cast datatypes using a + type. Many users are used to being able to cast data types using a function-style notation, that is typename(x). This notation is in fact nothing more nor less than a call of the cast implementation function; it diff --git a/doc/src/sgml/ref/create_table.sgml b/doc/src/sgml/ref/create_table.sgml index 68cce936db..344efa52e6 100644 --- a/doc/src/sgml/ref/create_table.sgml +++ b/doc/src/sgml/ref/create_table.sgml @@ -1,5 +1,5 @@ @@ -974,11 +974,12 @@ CREATE TABLE cinemas ( - TABLESPACE and USING INDEX TABLESPACE + Tablespaces The PostgreSQL concept of tablespaces is not - standard. + part of the standard. Hence, the clauses TABLESPACE + and USING INDEX TABLESPACE are extensions. diff --git a/doc/src/sgml/ref/create_table_as.sgml b/doc/src/sgml/ref/create_table_as.sgml index 8565b13d01..3e5869c01f 100644 --- a/doc/src/sgml/ref/create_table_as.sgml +++ b/doc/src/sgml/ref/create_table_as.sgml @@ -1,5 +1,5 @@ @@ -136,7 +136,7 @@ CREATE [ [ GLOBAL | LOCAL ] { TEMPORARY | TEMP } ] TABLE table_name linkend="sql-selectinto" endterm="sql-selectinto-title">, but it is preferred since it is less likely to be confused with other uses of the SELECT INTO syntax. Furthermore, CREATE - TABLE AS offers a superset of the functionality offerred + TABLE AS offers a superset of the functionality offered by SELECT INTO. @@ -150,13 +150,13 @@ CREATE [ [ GLOBAL | LOCAL ] { TEMPORARY | TEMP } ] TABLE table_name frequently executed, the OID counter would be rapidly incremented. As of PostgresSQL 8.0, the CREATE TABLE AS command allows the user to - explicitely specify whether OIDs should be included. If the - presence of OIDs is not explicitely specified, + explicitly specify whether OIDs should be included. If the + presence of OIDs is not explicitly specified, the configuration variable is used. While this variable currently defaults to true, the default value may be changed in the future. Therefore, applications that require OIDs in the table created by CREATE TABLE - AS should explicitely specify WITH + AS should explicitly specify WITH OIDS to ensure compatibility with future versions of PostgreSQL. diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml index 02c298f91a..babba041d3 100644 --- a/doc/src/sgml/ref/psql-ref.sgml +++ b/doc/src/sgml/ref/psql-ref.sgml @@ -1,5 +1,5 @@ @@ -493,7 +493,7 @@ PostgreSQL documentation these options are required, defaults do apply. If you omit the host name, psql will connect via a Unix domain socket to a server on the local host, or via TCP/IP to localhost on machines - that don't have unix domain sockets. The default port number is compile-time determined. + that don't have Unix domain sockets. The default port number is compile-time determined. Since the database server uses the same default, you will not have to specify the port in most cases. The default user name is your Unix user name, as is the default database name. Note that you can't @@ -1603,7 +1603,7 @@ lo_import 152801 class="parameter">filename is omitted, the history is written to the standard output. This option is only available if psql is configured to use the - GNU readline (or history) library. + GNU Readline library. @@ -2368,7 +2368,7 @@ testdb=> \set content '\'' `sed -e "s/'/\\\\\\'/g" < my_file.txt` '\' Prompts may contain terminal control characters which, for example, change the color, background, or style of the prompt text, or change the title of the terminal window. In order for - the line editing features of readline to work properly, these + the line editing features of Readline to work properly, these non-printing control characters must be designated as invisible by surrounding them with %[ and %]. Multiple pairs of these may occur within diff --git a/doc/src/sgml/release.sgml b/doc/src/sgml/release.sgml index 3a59781039..4240149cea 100644 --- a/doc/src/sgml/release.sgml +++ b/doc/src/sgml/release.sgml @@ -1,5 +1,5 @@ @@ -519,7 +519,7 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.315 2004/12/01 19:00:27 tgl Exp - Improve btree index performance for duplicate keys (Dmitry Tkach, Tom) + Improve B-tree index performance for duplicate keys (Dmitry Tkach, Tom) This improves the way indexes are scanned when many duplicate @@ -1244,7 +1244,7 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.315 2004/12/01 19:00:27 tgl Exp and CHECKPOINT (Tom) - In 7.3 and 7.4, a long-running btree index build could block concurrent + In 7.3 and 7.4, a long-running B-tree index build could block concurrent CHECKPOINTs from completing, thereby causing WAL bloat because the WAL log could not be recycled. @@ -1426,8 +1426,8 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.315 2004/12/01 19:00:27 tgl Exp - Make netmask() and hostmask() functions - return maximum-length masklen (Tom) + Make netmask and hostmask functions + return maximum-length mask length (Tom) @@ -1810,7 +1810,7 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.315 2004/12/01 19:00:27 tgl Exp - Add global psql config file, psqlrc.sample + Add global psql configuration file, psqlrc.sample (Bruce) @@ -1983,7 +1983,7 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.315 2004/12/01 19:00:27 tgl Exp - Many ecpg improvements, including SET DESCRIPTOR (Michael) + Many ECPG improvements, including SET DESCRIPTOR (Michael) @@ -2076,7 +2076,7 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.315 2004/12/01 19:00:27 tgl Exp - Decouple platform tests from cpu spinlock code (Bruce, Tom) + Decouple platform tests from CPU spinlock code (Bruce, Tom) @@ -2224,7 +2224,7 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.315 2004/12/01 19:00:27 tgl Exp - Make libpq and ecpg build as proper shared libraries on OS X (Tom) + Make libpq and ECPG build as proper shared libraries on OS X (Tom) @@ -2238,74 +2238,74 @@ $PostgreSQL: pgsql/doc/src/sgml/release.sgml,v 1.315 2004/12/01 19:00:27 tgl Exp - Overhaul of /contrib/dblink (Joe) + Overhaul of contrib/dblink (Joe) - /contrib/dbmirror improvements (Steven Singer) + contrib/dbmirror improvements (Steven Singer) - New /contrib/xml2 (John Gray, Torchbox) + New contrib/xml2 (John Gray, Torchbox) - Update /contrib/mysql + Updated contrib/mysql - New version of /contrib/btree_gist (Teodor) + New version of contrib/btree_gist (Teodor) - New /contrib/trgm, trigram matching for + New contrib/trgm, trigram matching for PostgreSQL (Teodor) - Many /contrib/tsearch2 improvements (Teodor) + Many contrib/tsearch2 improvements (Teodor) - Add double metaphone to /contrib/fuzzystrmatch (Andrew) + Add double metaphone to contrib/fuzzystrmatch (Andrew) - Allow /contrib/pg_autovacuum to run as a Windows service (Dave Page) + Allow contrib/pg_autovacuum to run as a Windows service (Dave Page) - Add functions to /contrib/dbsize (Andreas Pflug) + Add functions to contrib/dbsize (Andreas Pflug) - Remove contrib/pg_logger + Removed contrib/pg_logger - Remove contrib/rserv: obsoleted by various separate projects + Removed contrib/rserv: obsoleted by various separate projects @@ -2355,7 +2355,7 @@ left-side rows given just the right data distribution. This is to guard against any possible security issues. -Avoid using temp files in /tmp in make_oidjoins_check +Avoid using temp files in /tmp in make_oidjoins_check This has been reported as a security issue, though it's hardly worthy of concern since there is no reason for non-developers to use this script anyway. @@ -2366,7 +2366,7 @@ result In rare cases, a client might think that its last command had succeeded when it really had been aborted by forced database shutdown. -Repair bug in pg_stat_get_backend_idset() +Repair bug in pg_stat_get_backend_idset This could lead to misbehavior in some of the system-statistics views. @@ -2410,9 +2410,9 @@ ECPG prepare statement Changes -Repair possible crash during concurrent btree index insertions +Repair possible crash during concurrent B-tree index insertions -This patch fixes a rare case in which concurrent insertions into a btree index +This patch fixes a rare case in which concurrent insertions into a B-tree index could result in a server panic. No permanent damage would result, but it's still worth a re-release. The bug does not exist in pre-7.4 releases. @@ -2456,7 +2456,7 @@ since PostgreSQL 7.1. Check HAVING restriction before evaluating result list of an aggregate plan -Avoid crash when session's current userID is deleted +Avoid crash when session's current user ID is deleted Fix hashed crosstab for zero-rows case (Joe) Force cache update after renaming a column in a foreign key Pretty-print UNION queries correctly diff --git a/doc/src/sgml/rowtypes.sgml b/doc/src/sgml/rowtypes.sgml index 264b4c59a0..29bdfe9ff4 100644 --- a/doc/src/sgml/rowtypes.sgml +++ b/doc/src/sgml/rowtypes.sgml @@ -1,4 +1,4 @@ - + Composite Types @@ -13,7 +13,7 @@ A composite type describes the structure of a row or record; - it is in essence just a list of field names and their datatypes. + it is in essence just a list of field names and their data types. PostgreSQL allows values of composite types to be used in many of the same ways that simple types can be used. For example, a column of a table can be declared to be of a composite type. @@ -238,7 +238,7 @@ INSERT INTO mytab (complex_col.r, complex_col.i) VALUES(1.1, 2.2); Had we not supplied values for all the subfields of the column, the - remaining subfields would have been filled with NULLs. + remaining subfields would have been filled with null values. @@ -253,7 +253,7 @@ INSERT INTO mytab (complex_col.r, complex_col.i) VALUES(1.1, 2.2); around the whole value, plus commas (,) between adjacent items. Whitespace outside the parentheses is ignored, but within the parentheses it is considered part of the field value, and may or may not be - significant depending on the input conversion rules for the field datatype. + significant depending on the input conversion rules for the field data type. For example, in '( 42)' diff --git a/doc/src/sgml/runtime.sgml b/doc/src/sgml/runtime.sgml index f73625fd6e..4c130b4947 100644 --- a/doc/src/sgml/runtime.sgml +++ b/doc/src/sgml/runtime.sgml @@ -1,5 +1,5 @@ @@ -1946,11 +1946,11 @@ archive_command = 'copy "%p" /mnt/server/archivedir/"%f"' # Windows - Controls the tradeoff between planning time and query plan + Controls the trade off between planning time and query plan efficiency in GEQO. This variable must be an integer in the range from 1 to 10. The default value is 5. Larger values increase the time spent doing query planning, but also - increase the likelyhood that an efficient query plan will be + increase the likelihood that an efficient query plan will be chosen. @@ -2643,7 +2643,7 @@ archive_command = 'copy "%p" /mnt/server/archivedir/"%f"' # Windows only recognised by session processes, and do not apply to background processes such as the postmaster. Syslog produces its own - timestamp and process ID information, so you probably do not want to + time stamp and process ID information, so you probably do not want to use those escapes if you are using syslog. This option can only be set at server start or in the postgresql.conf configuration file. @@ -2660,71 +2660,69 @@ archive_command = 'copy "%p" /mnt/server/archivedir/"%f"' # Windows %u - User Name - Yes + User name + yes %d - Database Name - Yes + Database name + yes %r - Remote Hostname or IP address, and Remote Port - Yes + Remote host name or IP address, and remote port + yes %p Process ID - No + no %t - Timestamp - No + Time stamp + no %i - Command Tag. This is the command which generated the log - line. - Yes + Command tag: This is the command that generated the log line. + yes %c - Session ID. A unique identifier for each session. + Session ID: A unique identifier for each session. It is 2 4-byte hexadecimal numbers (without leading zeros) separated by a dot. The numbers - are the Session Start Time and the Process ID, so this can also + are the session start time and the process ID, so this can also be used as a space saving way of printing these items. - Yes + yes %l - Number of the log line for each process, - starting at 1 - No + Number of the log line for each process, starting at 1 + no %s - Session Start Timestamp - Yes + Session start time stamp + yes %x Transaction ID - Yes + yes %q Does not produce any output, but tells non-session processes to stop at this point in the string. Ignored by session processes. - No + no %% Literal % - No + no @@ -4477,7 +4475,7 @@ sysctl -w kern.sysv.shmall It may, however, be necessary to modify the global ulimit information in /etc/security/limits, as the default hard - limits for filesizes (fsize) and numbers of + limits for file sizes (fsize) and numbers of files (nofiles) may be too low. @@ -4668,7 +4666,7 @@ Out of Memory: Killed process 12345 (postmaster). On Linux 2.6 and later, a better solution is to modify the kernel's behavior so that it will not overcommit memory. This is - done by selecting strict overcommit mode via sysctl: + done by selecting strict overcommit mode via sysctl: sysctl -w vm.overcommit_memory=2 @@ -4680,7 +4678,7 @@ sysctl -w vm.overcommit_memory=2 Some vendors' Linux 2.4 kernels are reported to have early versions - of the 2.6 overcommit sysctl. However, setting + of the 2.6 overcommit sysctl parameter. However, setting vm.overcommit_memory to 2 on a kernel that does not have the relevant code will make things worse not better. It is recommended that you inspect diff --git a/doc/src/sgml/sources.sgml b/doc/src/sgml/sources.sgml index 6745599579..0d51db1a4c 100644 --- a/doc/src/sgml/sources.sgml +++ b/doc/src/sgml/sources.sgml @@ -1,5 +1,5 @@ @@ -109,9 +109,9 @@ less -x4 A typical call to ereport might look like this: - ereport(ERROR, - (errcode(ERRCODE_DIVISION_BY_ZERO), - errmsg("division by zero"))); +ereport(ERROR, + (errcode(ERRCODE_DIVISION_BY_ZERO), + errmsg("division by zero"))); This specifies error severity level ERROR (a run-of-the-mill error). The errcode call specifies the SQLSTATE error code @@ -124,13 +124,13 @@ less -x4 Here is a more complex example: - ereport(ERROR, - (errcode(ERRCODE_AMBIGUOUS_FUNCTION), - errmsg("function %s is not unique", - func_signature_string(funcname, nargs, - actual_arg_types)), - errhint("Unable to choose a best candidate function. " - "You may need to add explicit typecasts."))); +ereport(ERROR, + (errcode(ERRCODE_AMBIGUOUS_FUNCTION), + errmsg("function %s is not unique", + func_signature_string(funcname, nargs, + actual_arg_types)), + errhint("Unable to choose a best candidate function. " + "You may need to add explicit typecasts."))); This illustrates the use of format codes to embed run-time values into a message text. Also, an optional hint message is provided. @@ -141,7 +141,7 @@ less -x4 - errcode(sqlerrcode) specifies the SQLSTATE error identifier + errcode(sqlerrcode) specifies the SQLSTATE error identifier code for the condition. If this routine is not called, the error identifier defaults to ERRCODE_INTERNAL_ERROR when the error severity level is @@ -149,12 +149,12 @@ less -x4 error level is WARNING, otherwise (for NOTICE and below) ERRCODE_SUCCESSFUL_COMPLETION. While these defaults are often convenient, always think whether they - are appropriate before omitting the errcode() call. + are appropriate before omitting the errcode() call. - errmsg(const char *msg, ...) specifies the primary error + errmsg(const char *msg, ...) specifies the primary error message text, and possibly run-time values to insert into it. Insertions are specified by sprintf-style format codes. In addition to the standard format codes accepted by sprintf, the format @@ -177,7 +177,7 @@ less -x4 - errmsg_internal(const char *msg, ...) is the same as + errmsg_internal(const char *msg, ...) is the same as errmsg, except that the message string will not be included in the internationalization message dictionary. This should be used for can't happen cases that are probably @@ -186,7 +186,7 @@ less -x4 - errdetail(const char *msg, ...) supplies an optional + errdetail(const char *msg, ...) supplies an optional detail message; this is to be used when there is additional information that seems inappropriate to put in the primary message. The message string is processed in just the same way as for @@ -195,7 +195,7 @@ less -x4 - errhint(const char *msg, ...) supplies an optional + errhint(const char *msg, ...) supplies an optional hint message; this is to be used when offering suggestions about how to fix the problem, as opposed to factual details about what went wrong. @@ -205,7 +205,7 @@ less -x4 - errcontext(const char *msg, ...) is not normally called + errcontext(const char *msg, ...) is not normally called directly from an ereport message site; rather it is used in error_context_stack callback functions to provide information about the context in which an error occurred, such as the @@ -218,7 +218,7 @@ less -x4 - errposition(int cursorpos) specifies the textual location + errposition(int cursorpos) specifies the textual location of an error within a query string. Currently it is only useful for errors detected in the lexical and syntactic analysis phases of query processing. @@ -226,7 +226,7 @@ less -x4 - errcode_for_file_access() is a convenience function that + errcode_for_file_access() is a convenience function that selects an appropriate SQLSTATE error identifier for a failure in a file-access-related system call. It uses the saved errno to determine which error code to generate. @@ -236,7 +236,7 @@ less -x4 - errcode_for_socket_access() is a convenience function that + errcode_for_socket_access() is a convenience function that selects an appropriate SQLSTATE error identifier for a failure in a socket-related system call. @@ -248,11 +248,11 @@ less -x4 There is an older function elog that is still heavily used. An elog call - elog(level, "format string", ...); +elog(level, "format string", ...); is exactly equivalent to - ereport(level, (errmsg_internal("format string", ...))); +ereport(level, (errmsg_internal("format string", ...))); Notice that the SQLSTATE errcode is always defaulted, and the message string is not included in the internationalization message dictionary. @@ -297,14 +297,14 @@ less -x4 For example, instead of - IpcMemoryCreate: shmget(key=%d, size=%u, 0%o) failed: %m - (plus a long addendum that is basically a hint) +IpcMemoryCreate: shmget(key=%d, size=%u, 0%o) failed: %m +(plus a long addendum that is basically a hint) -write + write - Primary: could not create shared memory segment: %m - Detail: Failed syscall was shmget(key=%d, size=%u, 0%o). - Hint: the addendum +Primary: could not create shared memory segment: %m +Detail: Failed syscall was shmget(key=%d, size=%u, 0%o). +Hint: the addendum @@ -461,11 +461,11 @@ write There is a nontrivial semantic difference between sentences of the form - could not open file "%s": %m +could not open file "%s": %m and - cannot open file "%s" +cannot open file "%s" The first one means that the attempt to open the file failed. The message should give a reason, such as disk full or @@ -525,7 +525,7 @@ and When a message includes text that is generated elsewhere, embed it in this style: - could not open file %s: %m +could not open file %s: %m @@ -546,8 +546,8 @@ and Messages should always state the reason why an error occurred. For example: - BAD: could not open file %s - BETTER: could not open file %s (I/O failure) +BAD: could not open file %s +BETTER: could not open file %s (I/O failure) If no reason is known you better fix the code. @@ -563,8 +563,8 @@ and not helpful information. If the error text doesn't make as much sense without the function name, reword it. - BAD: pg_atoi: error in "z": can't parse "z" - BETTER: invalid input syntax for integer: "z" +BAD: pg_atoi: error in "z": can't parse "z" +BETTER: invalid input syntax for integer: "z" @@ -572,8 +572,8 @@ and Avoid mentioning called function names, either; instead say what the code was trying to do: - BAD: open() failed: %m - BETTER: could not open file %s: %m +BAD: open() failed: %m +BETTER: could not open file %s: %m If it really seems necessary, mention the system call in the detail message. (In some cases, providing the actual values passed to the @@ -622,8 +622,8 @@ and it's erroneous? Unrecognized is often a better choice. Also, be sure to include the value being complained of. - BAD: unknown node type - BETTER: unrecognized node type: 42 +BAD: unknown node type +BETTER: unrecognized node type: 42 diff --git a/doc/src/sgml/spi.sgml b/doc/src/sgml/spi.sgml index a5a832d2e7..29624e5eca 100644 --- a/doc/src/sgml/spi.sgml +++ b/doc/src/sgml/spi.sgml @@ -1,5 +1,5 @@ @@ -825,7 +825,7 @@ int SPI_getargcount(void * plan) SPI_getargtypeid - returns the expected typeid for the specified argument of + returns the expected typeid for the specified argument of a plan prepared by SPI_prepare @@ -841,7 +841,7 @@ Oid SPI_getargtypeid(void * plan, int argIndex Description - SPI_getargtypeid returns the Oid representing the type + SPI_getargtypeid returns the OID representing the type id for the argIndex'th argument of a plan prepared by SPI_prepare. First argument is at index zero. @@ -2482,8 +2482,8 @@ HeapTupleHeader SPI_returntuple(HeapTuple row, TupleDesc SPI_returntuple makes a copy of a row in - the upper executor context, returning it in the form of a rowtype Datum. - The returned pointer need only be converted to Datum via PointerGetDatum + the upper executor context, returning it in the form of a row type Datum. + The returned pointer need only be converted to Datum via PointerGetDatum before returning. diff --git a/doc/src/sgml/syntax.sgml b/doc/src/sgml/syntax.sgml index 30e344f8a8..8cbfd4afa2 100644 --- a/doc/src/sgml/syntax.sgml +++ b/doc/src/sgml/syntax.sgml @@ -1,5 +1,5 @@ @@ -1547,7 +1547,7 @@ SELECT ROW(1,2.5,'this is a test'); By default, the value created by a ROW expression is of an anonymous record type. If necessary, it can be cast to a named - composite type — either the rowtype of a table, or a composite type + composite type — either the row type of a table, or a composite type created with CREATE TYPE AS. An explicit cast may be needed to avoid ambiguity. For example: diff --git a/doc/src/sgml/trigger.sgml b/doc/src/sgml/trigger.sgml index 942eb0c128..fdecf5483b 100644 --- a/doc/src/sgml/trigger.sgml +++ b/doc/src/sgml/trigger.sgml @@ -1,5 +1,5 @@ @@ -434,7 +434,7 @@ typedef struct Trigger tg_trigtuplebuf - The buffer containing tg_trigtuple, or InvalidBuffer if there + The buffer containing tg_trigtuple, or InvalidBuffer if there is no such tuple or it is not stored in a disk buffer. @@ -444,7 +444,7 @@ typedef struct Trigger tg_newtuplebuf - The buffer containing tg_newtuple, or InvalidBuffer if there + The buffer containing tg_newtuple, or InvalidBuffer if there is no such tuple or it is not stored in a disk buffer. @@ -456,7 +456,7 @@ typedef struct Trigger A trigger function must return either a HeapTuple pointer or a NULL pointer - (not a SQL NULL, that is, do not set isNull true). + (not an SQL null value, that is, do not set isNull true). Be careful to return either tg_trigtuple or tg_newtuple, as appropriate, if you don't want to modify the row being operated on. diff --git a/doc/src/sgml/xfunc.sgml b/doc/src/sgml/xfunc.sgml index 231e4bcec7..4a2dac06e0 100644 --- a/doc/src/sgml/xfunc.sgml +++ b/doc/src/sgml/xfunc.sgml @@ -1,5 +1,5 @@ @@ -1930,7 +1930,7 @@ CREATE FUNCTION c_overpaid(emp, integer) RETURNS boolean There are two ways you can build a composite data value (henceforth a tuple): you can build it from an array of Datum values, or from an array of C strings that can be passed to the input - conversion functions of the tuple's column datatypes. In either + conversion functions of the tuple's column data types. In either case, you first need to obtain or construct a TupleDesc descriptor for the tuple structure. When working with Datums, you pass the TupleDesc to BlessTupleDesc, @@ -2494,10 +2494,10 @@ CREATE FUNCTION test(int, int) RETURNS int for all calls within a single surrounding query. This category allows the optimizer to optimize away multiple calls of the function within a single query. In particular, it is safe to use an expression - containing such a function in an indexscan condition. (Since an - indexscan will evaluate the comparison value only once, not once at + containing such a function in an index scan condition. (Since an + index scan will evaluate the comparison value only once, not once at each row, it is not valid to use a VOLATILE function in - an indexscan condition.) + an index scan condition.) -- 2.11.0