From 79ba540b78c69b9d91214899283a843ce40c52d5 Mon Sep 17 00:00:00 2001 From: Neil Conway Date: Tue, 15 May 2007 19:13:55 +0000 Subject: [PATCH] Various fixes for the SGML docs. Consistently use spaces before/after parentheses in syntax descriptions. Consistently use the present tense when describing the basic purpose of each "DROP" command. Add a few more hyperlinks. --- doc/src/sgml/catalogs.sgml | 15 ++++++++------- doc/src/sgml/ref/alter_index.sgml | 4 ++-- doc/src/sgml/ref/analyze.sgml | 15 ++++++++------- doc/src/sgml/ref/close.sgml | 6 +++--- doc/src/sgml/ref/drop_aggregate.sgml | 4 ++-- doc/src/sgml/ref/drop_domain.sgml | 8 ++++---- doc/src/sgml/ref/drop_language.sgml | 10 ++++------ doc/src/sgml/ref/drop_sequence.sgml | 5 +++-- doc/src/sgml/ref/drop_table.sgml | 4 ++-- doc/src/sgml/ref/drop_trigger.sgml | 4 ++-- doc/src/sgml/ref/drop_type.sgml | 4 ++-- doc/src/sgml/ref/execute.sgml | 4 ++-- doc/src/sgml/ref/pg_restore.sgml | 5 +++-- doc/src/sgml/ref/prepare.sgml | 4 ++-- doc/src/sgml/ref/select.sgml | 4 ++-- 15 files changed, 49 insertions(+), 47 deletions(-) diff --git a/doc/src/sgml/catalogs.sgml b/doc/src/sgml/catalogs.sgml index 2da4abc340..1bf95871c0 100644 --- a/doc/src/sgml/catalogs.sgml +++ b/doc/src/sgml/catalogs.sgml @@ -1,4 +1,4 @@ - + @@ -3984,12 +3984,13 @@ - The catalog pg_statistic stores statistical data - about the contents of the database. Entries are created by - ANALYZE and subsequently used by the query planner. - There is one entry for each table column that has been analyzed. - Note that all the statistical data is inherently approximate, - even assuming that it is up-to-date. + The catalog pg_statistic stores + statistical data about the contents of the database. Entries are + created by + and subsequently used by the query planner. There is one entry for + each table column that has been analyzed. Note that all the + statistical data is inherently approximate, even assuming that it + is up-to-date. diff --git a/doc/src/sgml/ref/alter_index.sgml b/doc/src/sgml/ref/alter_index.sgml index 813235fd60..93273c11d8 100644 --- a/doc/src/sgml/ref/alter_index.sgml +++ b/doc/src/sgml/ref/alter_index.sgml @@ -1,5 +1,5 @@ @@ -109,7 +109,7 @@ ALTER INDEX name RESET ( new_name - New name for the index. + The new name for the index. diff --git a/doc/src/sgml/ref/analyze.sgml b/doc/src/sgml/ref/analyze.sgml index 28c272179a..bb293af03c 100644 --- a/doc/src/sgml/ref/analyze.sgml +++ b/doc/src/sgml/ref/analyze.sgml @@ -1,5 +1,5 @@ @@ -20,7 +20,7 @@ PostgreSQL documentation -ANALYZE [ VERBOSE ] [ table [ (column [, ...] ) ] ] +ANALYZE [ VERBOSE ] [ table [ ( column [, ...] ) ] ] @@ -29,10 +29,11 @@ ANALYZE [ VERBOSE ] [ table [ ( ANALYZE collects statistics about the contents - of tables in the database, and stores the results in the system - table pg_statistic. Subsequently, the query - planner uses these statistics to help determine the most efficient - execution plans for queries. + of tables in the database, and stores the results in the pg_statistic + system catalog. Subsequently, the query planner uses these + statistics to help determine the most efficient execution plans for + queries. @@ -125,7 +126,7 @@ ANALYZE [ VERBOSE ] [ table [ (ANALYZE is run, even if the actual table contents did not change. This might result in small changes in the planner's estimated costs shown by - EXPLAIN. In rare situations, this + . In rare situations, this non-determinism will cause the query optimizer to choose a different query plan between runs of ANALYZE. To avoid this, raise the amount of statistics collected by diff --git a/doc/src/sgml/ref/close.sgml b/doc/src/sgml/ref/close.sgml index 2e5309ff0f..f4fada4ac7 100644 --- a/doc/src/sgml/ref/close.sgml +++ b/doc/src/sgml/ref/close.sgml @@ -1,5 +1,5 @@ @@ -88,8 +88,8 @@ CLOSE { name | ALL } - You can see all available cursors by querying the - pg_cursors system view. + You can see all available cursors by querying the pg_cursors system view. diff --git a/doc/src/sgml/ref/drop_aggregate.sgml b/doc/src/sgml/ref/drop_aggregate.sgml index ebb1466bc0..d73f14b2d8 100644 --- a/doc/src/sgml/ref/drop_aggregate.sgml +++ b/doc/src/sgml/ref/drop_aggregate.sgml @@ -1,5 +1,5 @@ @@ -28,7 +28,7 @@ DROP AGGREGATE [ IF EXISTS ] name ( Description - DROP AGGREGATE will delete an existing + DROP AGGREGATE removes an existing aggregate function. To execute this command the current user must be the owner of the aggregate function. diff --git a/doc/src/sgml/ref/drop_domain.sgml b/doc/src/sgml/ref/drop_domain.sgml index ebb7eb500b..2e7f9e37cd 100644 --- a/doc/src/sgml/ref/drop_domain.sgml +++ b/doc/src/sgml/ref/drop_domain.sgml @@ -1,5 +1,5 @@ @@ -20,7 +20,7 @@ PostgreSQL documentation -DROP DOMAIN [IF EXISTS ] name [, ...] [ CASCADE | RESTRICT ] +DROP DOMAIN [ IF EXISTS ] name [, ...] [ CASCADE | RESTRICT ] @@ -28,8 +28,8 @@ DROP DOMAIN [IF EXISTS ] name [, .. Description - DROP DOMAIN will remove a domain. Only the - owner of a domain can remove it. + DROP DOMAIN removes a domain. Only the owner of + a domain can remove it. diff --git a/doc/src/sgml/ref/drop_language.sgml b/doc/src/sgml/ref/drop_language.sgml index 1e3c960a72..ca0d667b6e 100644 --- a/doc/src/sgml/ref/drop_language.sgml +++ b/doc/src/sgml/ref/drop_language.sgml @@ -1,5 +1,5 @@ @@ -28,11 +28,9 @@ DROP [ PROCEDURAL ] LANGUAGE [ IF EXISTS ] nameDescription - DROP LANGUAGE will remove the definition - of the previously registered procedural language called - name. - You must be superuser or owner of the language to - use DROP LANGUAGE. + DROP LANGUAGE removes the definition of a + previously registered procedural language. You must be a superuser + or the owner of the language to use DROP LANGUAGE. diff --git a/doc/src/sgml/ref/drop_sequence.sgml b/doc/src/sgml/ref/drop_sequence.sgml index b0755ee188..58be47acb0 100644 --- a/doc/src/sgml/ref/drop_sequence.sgml +++ b/doc/src/sgml/ref/drop_sequence.sgml @@ -1,5 +1,5 @@ @@ -28,7 +28,8 @@ DROP SEQUENCE [ IF EXISTS ] name [, Description - DROP SEQUENCE removes sequence number generators. + DROP SEQUENCE removes sequence number + generators. A sequence can only be dropped by its owner or a superuser. diff --git a/doc/src/sgml/ref/drop_table.sgml b/doc/src/sgml/ref/drop_table.sgml index 46ee3ac9b0..287d6dbd99 100644 --- a/doc/src/sgml/ref/drop_table.sgml +++ b/doc/src/sgml/ref/drop_table.sgml @@ -1,5 +1,5 @@ @@ -29,7 +29,7 @@ DROP TABLE [ IF EXISTS ] name [, .. DROP TABLE removes tables from the database. - Only its owner can destroy a table. To empty a table of rows + Only its owner can drop a table. To empty a table of rows without destroying the table, use or . diff --git a/doc/src/sgml/ref/drop_trigger.sgml b/doc/src/sgml/ref/drop_trigger.sgml index a579d5794d..9b7103a926 100644 --- a/doc/src/sgml/ref/drop_trigger.sgml +++ b/doc/src/sgml/ref/drop_trigger.sgml @@ -1,5 +1,5 @@ @@ -28,7 +28,7 @@ DROP TRIGGER [ IF EXISTS ] name ON Description - DROP TRIGGER will remove an existing + DROP TRIGGER removes an existing trigger definition. To execute this command, the current user must be the owner of the table for which the trigger is defined. diff --git a/doc/src/sgml/ref/drop_type.sgml b/doc/src/sgml/ref/drop_type.sgml index 139690879f..4388433187 100644 --- a/doc/src/sgml/ref/drop_type.sgml +++ b/doc/src/sgml/ref/drop_type.sgml @@ -1,5 +1,5 @@ @@ -28,7 +28,7 @@ DROP TYPE [ IF EXISTS ] name [, ... Description - DROP TYPE will remove a user-defined data type. + DROP TYPE removes a user-defined data type. Only the owner of a type can remove it. diff --git a/doc/src/sgml/ref/execute.sgml b/doc/src/sgml/ref/execute.sgml index be3ba28a79..cc95860915 100644 --- a/doc/src/sgml/ref/execute.sgml +++ b/doc/src/sgml/ref/execute.sgml @@ -1,5 +1,5 @@ @@ -25,7 +25,7 @@ PostgreSQL documentation -EXECUTE name [ (parameter [, ...] ) ] +EXECUTE name [ ( parameter [, ...] ) ] diff --git a/doc/src/sgml/ref/pg_restore.sgml b/doc/src/sgml/ref/pg_restore.sgml index 8ed0a57b58..a311affc3c 100644 --- a/doc/src/sgml/ref/pg_restore.sgml +++ b/doc/src/sgml/ref/pg_restore.sgml @@ -1,4 +1,4 @@ - + @@ -11,7 +11,8 @@ pg_restore - restore a PostgreSQL database from an archive file created by pg_dump + restore a PostgreSQL database from an + archive file created by pg_dump diff --git a/doc/src/sgml/ref/prepare.sgml b/doc/src/sgml/ref/prepare.sgml index 62097152be..c7be790b71 100644 --- a/doc/src/sgml/ref/prepare.sgml +++ b/doc/src/sgml/ref/prepare.sgml @@ -1,5 +1,5 @@ @@ -25,7 +25,7 @@ PostgreSQL documentation -PREPARE name [ (datatype [, ...] ) ] AS statement +PREPARE name [ ( datatype [, ...] ) ] AS statement diff --git a/doc/src/sgml/ref/select.sgml b/doc/src/sgml/ref/select.sgml index 689a498566..0f1ada97cb 100644 --- a/doc/src/sgml/ref/select.sgml +++ b/doc/src/sgml/ref/select.sgml @@ -1,5 +1,5 @@ @@ -354,7 +354,7 @@ where from_item can be one of: - USING (join_column [, ...]) + USING ( join_column [, ...] ) A clause of the form USING ( a, b, ... ) is -- 2.40.0