Documentation spell checking and markup improvements

petere · petere · commit bbaf9e8f840a · 2017-06-18T14:02:12.000-04:00
diff --git a/doc/src/sgml/adminpack.sgml b/doc/src/sgml/adminpack.sgml
@@ -152,7 +152,7 @@
      <entry><type>integer</type></entry>
      <entry>
       Alternate name for <function>pg_rotate_logfile()</>, but note that it
-      returns integer 0 or 1 rather than boolean
+      returns integer 0 or 1 rather than <type>boolean</type>
      </entry>
     </row>
    </tbody>
diff --git a/doc/src/sgml/amcheck.sgml b/doc/src/sgml/amcheck.sgml
@@ -215,15 +215,15 @@ ORDER BY c.relpages DESC LIMIT 10;
    </listitem>
    <listitem>
     <para>
-     Filesystem or storage subsystem faults where checksums happen to
+     File system or storage subsystem faults where checksums happen to
      simply not be enabled.
     </para>
     <para>
      Note that <filename>amcheck</> examines a page as represented in some
      shared memory buffer at the time of verification if there is only a
      shared buffer hit when accessing the block. Consequently,
      <filename>amcheck</> does not necessarily examine data read from the
-     filesystem at the time of verification. Note that when checksums are
+     file system at the time of verification. Note that when checksums are
      enabled, <filename>amcheck</> may raise an error due to a checksum
      failure when a corrupt block is read into a buffer.
     </para>
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
@@ -1908,10 +1908,10 @@ include_dir 'conf.d'
        <listitem>
         <para>
          Whenever more than <varname>bgwriter_flush_after</varname> bytes have
-         been written by the bgwriter, attempt to force the OS to issue these
+         been written by the background writer, attempt to force the OS to issue these
          writes to the underlying storage.  Doing so will limit the amount of
          dirty data in the kernel's page cache, reducing the likelihood of
-         stalls when an fsync is issued at the end of a checkpoint, or when
+         stalls when an <function>fsync</function> is issued at the end of a checkpoint, or when
          the OS writes data back in larger batches in the background.  Often
          that will result in greatly reduced transaction latency, but there
          also are some cases, especially with workloads that are bigger than
@@ -2029,7 +2029,7 @@ include_dir 'conf.d'
          pool of processes established by
          <xref linkend="guc-max-worker-processes">, limited by
          <xref linkend="guc-max-parallel-workers">.  Note that the requested
-         number of workers may not actually be available at runtime.  If this
+         number of workers may not actually be available at run time.  If this
          occurs, the plan will run with fewer workers than expected, which may
          be inefficient.  The default value is 2.  Setting this value to 0
          disables parallel query execution.
@@ -2090,7 +2090,7 @@ include_dir 'conf.d'
          been written by a single backend, attempt to force the OS to issue
          these writes to the underlying storage.  Doing so will limit the
          amount of dirty data in the kernel's page cache, reducing the
-         likelihood of stalls when an fsync is issued at the end of a
+         likelihood of stalls when an <function>fsync</function> is issued at the end of a
          checkpoint, or when the OS writes data back in larger batches in the
          background.  Often that will result in greatly reduced transaction
          latency, but there also are some cases, especially with workloads
@@ -2270,7 +2270,7 @@ include_dir 'conf.d'
         For reliable recovery when changing <varname>fsync</varname>
         off to on, it is necessary to force all modified buffers in the
         kernel to durable storage.  This can be done while the cluster
-        is shutdown or while fsync is on by running <command>initdb
+        is shutdown or while <varname>fsync</varname> is on by running <command>initdb
         --sync-only</command>, running <command>sync</>, unmounting the
         file system, or rebooting the server.
        </para>
@@ -2700,7 +2700,7 @@ include_dir 'conf.d'
         have been written while performing a checkpoint, attempt to force the
         OS to issue these writes to the underlying storage.  Doing so will
         limit the amount of dirty data in the kernel's page cache, reducing
-        the likelihood of stalls when an fsync is issued at the end of the
+        the likelihood of stalls when an <function>fsync</function> is issued at the end of the
         checkpoint, or when the OS writes data back in larger batches in the
         background.  Often that will result in greatly reduced transaction
         latency, but there also are some cases, especially with workloads
@@ -3460,7 +3460,7 @@ ANY <replaceable class="parameter">num_sync</replaceable> ( <replaceable class="
       <listitem>
        <para>
         Maximum number of synchronization workers per subscription. This
-        parameter controls the amount of paralelism of the initial data copy
+        parameter controls the amount of parallelism of the initial data copy
         during the subscription initialization or when new tables are added.
        </para>
        <para>
@@ -7356,7 +7356,7 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
         limit, while negative values
         mean <xref linkend="guc-max-pred-locks-per-transaction"> divided by
         the absolute value of this setting.  The default is -2, which keeps
-        the behaviour from previous versions of <productname>PostgreSQL</>.
+        the behavior from previous versions of <productname>PostgreSQL</>.
         This parameter can only be set in the <filename>postgresql.conf</>
         file or on the server command line.
        </para>
diff --git a/doc/src/sgml/ddl.sgml b/doc/src/sgml/ddl.sgml
@@ -1769,13 +1769,13 @@ UPDATE 1
   <para>
    All of the policies constructed thus far have been permissive policies,
    meaning that when multiple policies are applied they are combined using
-   the "OR" boolean operator.  While permissive policies can be constructed
+   the <quote>OR</quote> Boolean operator.  While permissive policies can be constructed
    to only allow access to rows in the intended cases, it can be simpler to
    combine permissive policies with restrictive policies (which the records
-   must pass and which are combined using the "AND" boolean operator).
+   must pass and which are combined using the <quote>AND</quote> Boolean operator).
    Building on the example above, we add a restrictive policy to require
-   the administrator to be connected over a local unix socket to access the
-   records of the passwd table:
+   the administrator to be connected over a local Unix socket to access the
+   records of the <literal>passwd</literal> table:
   </para>
 
 <programlisting>
@@ -2971,7 +2971,8 @@ VALUES ('Albany', NULL, NULL, 'NY');
        <command>CREATE TABLE</> nor is it possible to add columns to
        partitions after-the-fact using <command>ALTER TABLE</>.  Tables may be
        added as a partition with <command>ALTER TABLE ... ATTACH PARTITION</>
-       only if their columns exactly match the parent, including oids.
+       only if their columns exactly match the parent, including any
+       <literal>oid</literal> column.
       </para>
      </listitem>
 
diff --git a/doc/src/sgml/extend.sgml b/doc/src/sgml/extend.sgml
@@ -1207,7 +1207,7 @@ include $(PGXS)
       <term><varname>NO_INSTALLCHECK</varname></term>
       <listitem>
        <para>
-        don't define an installcheck target, useful e.g. if tests require special configuration, or don't use pg_regress
+        don't define an <literal>installcheck</literal> target, useful e.g. if tests require special configuration, or don't use <application>pg_regress</application>
        </para>
       </listitem>
      </varlistentry>
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
@@ -1302,7 +1302,7 @@
     transformation functions <literal><function>radians()</function></literal>
     and <literal><function>degrees()</function></literal> shown earlier.
     However, using the degree-based trigonometric functions is preferred,
-    as that way avoids roundoff error for special cases such
+    as that way avoids round-off error for special cases such
     as <literal>sind(30)</>.
    </para>
   </note>
@@ -9571,7 +9571,7 @@ CREATE TYPE rainbow AS ENUM ('red', 'orange', 'yellow', 'green', 'blue', 'purple
         <entry><type>tsvector</type></entry>
         <entry>
           reduce each string value in the document to a <type>tsvector</>, and then
-          concatentate those in document order to produce a single <type>tsvector</>
+          concatenate those in document order to produce a single <type>tsvector</>
         </entry>
         <entry><literal>to_tsvector('english', '{"a": "The Fat Rats"}'::json)</literal></entry>
         <entry><literal>'fat':2 'rat':3</literal></entry>
@@ -9744,7 +9744,7 @@ CREATE TYPE rainbow AS ENUM ('red', 'orange', 'yellow', 'green', 'blue', 'purple
          <literal><function>unnest(<type>tsvector</>, OUT <replaceable class="PARAMETER">lexeme</> <type>text</>, OUT <replaceable class="PARAMETER">positions</> <type>smallint[]</>, OUT <replaceable class="PARAMETER">weights</> <type>text</>)</function></literal>
         </entry>
         <entry><type>setof record</type></entry>
-        <entry>expand a tsvector to a set of rows</entry>
+        <entry>expand a <type>tsvector</type> to a set of rows</entry>
         <entry><literal>unnest('fat:2,4 cat:3 rat:5A'::tsvector)</literal></entry>
         <entry><literal>(cat,{3},{D}) ...</literal></entry>
        </row>
@@ -17675,7 +17675,7 @@ SELECT collation for ('foo' COLLATE "de_DE");
       <row>
        <entry><literal><function>txid_current_if_assigned()</function></literal></entry>
        <entry><type>bigint</type></entry>
-       <entry>same as <function>txid_current()</function> but returns null instead of assigning an xid if none is already assigned</entry>
+       <entry>same as <function>txid_current()</function> but returns null instead of assigning a new transaction ID if none is already assigned</entry>
       </row>
       <row>
        <entry><literal><function>txid_current_snapshot()</function></literal></entry>
@@ -17705,7 +17705,7 @@ SELECT collation for ('foo' COLLATE "de_DE");
       <row>
        <entry><literal><function>txid_status(<parameter>bigint</parameter>)</function></literal></entry>
        <entry><type>txid_status</type></entry>
-       <entry>report the status of the given xact - <literal>committed</literal>, <literal>aborted</literal>, <literal>in progress</literal>, or NULL if the txid is too old</entry>
+       <entry>report the status of the given transaction: <literal>committed</literal>, <literal>aborted</literal>, <literal>in progress</literal>, or null if the transaction ID is too old</entry>
       </row>
      </tbody>
     </tgroup>
@@ -18592,7 +18592,7 @@ postgres=# select pg_start_backup('label_goes_here');
     the <filename>backup_label</> and <filename>tablespace_map</> are returned
     in the result of the function, and should be written to files in the
     backup (and not in the data directory).  There is an optional second
-    parameter of type boolean.  If false, the <function>pg_stop_backup</>
+    parameter of type <type>boolean</type>.  If false, the <function>pg_stop_backup</>
     will return immediately after the backup is completed without waiting for
     WAL to be archived.  This behavior is only useful for backup
     software which independently monitors WAL archiving. Otherwise, WAL
diff --git a/doc/src/sgml/generic-wal.sgml b/doc/src/sgml/generic-wal.sgml
@@ -35,7 +35,7 @@
       &mdash; register a buffer to be modified within the current generic WAL
       record.  This function returns a pointer to a temporary copy of the
       buffer's page, where modifications should be made.  (Do not modify the
-      buffer's contents directly.)  The third argument is a bitmask of flags
+      buffer's contents directly.)  The third argument is a bit mask of flags
       applicable to the operation.  Currently the only such flag is
       <literal>GENERIC_XLOG_FULL_IMAGE</>, which indicates that a full-page
       image rather than a delta update should be included in the WAL record.
diff --git a/doc/src/sgml/maintenance.sgml b/doc/src/sgml/maintenance.sgml
@@ -594,7 +594,7 @@ SELECT datname, age(datfrozenxid) FROM pg_database;
     scans every page in the table that is not already all-frozen, it should
     set <literal>age(relfrozenxid)</> to a value just a little more than the
     <varname>vacuum_freeze_min_age</> setting
-    that was used (more by the number of transcations started since the
+    that was used (more by the number of transactions started since the
     <command>VACUUM</> started).  If no <structfield>relfrozenxid</>-advancing
     <command>VACUUM</> is issued on the table until
     <varname>autovacuum_freeze_max_age</> is reached, an autovacuum will soon
diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml
@@ -1143,7 +1143,7 @@ postgres   27093  0.0  0.0  30096  2752 ?        Ss   11:34   0:00 postgres: ser
         </row>
         <row>
          <entry><literal>userlock</></entry>
-         <entry>Waiting to acquire a userlock.</entry>
+         <entry>Waiting to acquire a user lock.</entry>
         </row>
         <row>
          <entry><literal>advisory</></entry>
@@ -1244,7 +1244,7 @@ postgres   27093  0.0  0.0  30096  2752 ?        Ss   11:34   0:00 postgres: ser
         </row>
         <row>
          <entry><literal>BtreePage</></entry>
-         <entry>Waiting for the page number needed to continue a parallel btree scan to become available.</entry>
+         <entry>Waiting for the page number needed to continue a parallel B-tree scan to become available.</entry>
         </row>
         <row>
          <entry><literal>ExecuteGather</></entry>
diff --git a/doc/src/sgml/perform.sgml b/doc/src/sgml/perform.sgml
@@ -1214,7 +1214,7 @@ SELECT * FROM zipcodes WHERE city = 'San Francisco' AND zip = '90210';
      <para>
       In many practical situations, this assumption is usually satisfied;
       for example, there might be a GUI in the application that only allows
-      selecting compatible city and zipcode values to use in a query.
+      selecting compatible city and ZIP code values to use in a query.
       But if that's not the case, functional dependencies may not be a viable
       option.
      </para>
diff --git a/doc/src/sgml/plperl.sgml b/doc/src/sgml/plperl.sgml
@@ -1335,7 +1335,7 @@ DO 'elog(WARNING, join ", ", sort keys %INC)' LANGUAGE plperl;
 </programlisting>
        </para>
        <para>
-        Initialization will happen in the postmaster if the plperl library is
+        Initialization will happen in the postmaster if the <literal>plperl</literal> library is
         included in <xref linkend="guc-shared-preload-libraries">, in which
         case extra consideration should be given to the risk of destabilizing
         the postmaster.  The principal reason for making use of this feature
diff --git a/doc/src/sgml/pltcl.sgml b/doc/src/sgml/pltcl.sgml
@@ -882,7 +882,7 @@ CREATE EVENT TRIGGER tcl_a_snitch ON ddl_command_start EXECUTE PROCEDURE tclsnit
      first word identifies the subsystem or library reporting the error;
      beyond that the contents are left to the individual subsystem or
      library.  For database errors reported by PL/Tcl commands, the first
-     word is <literal>POSTGRES</literal>, the second word is the Postgres
+     word is <literal>POSTGRES</literal>, the second word is the PostgreSQL
      version number, and additional words are field name/value pairs
      providing detailed information about the error.
      Fields <varname>SQLSTATE</>, <varname>condition</>,
diff --git a/doc/src/sgml/ref/create_policy.sgml b/doc/src/sgml/ref/create_policy.sgml
@@ -126,7 +126,7 @@ CREATE POLICY <replaceable class="parameter">name</replaceable> ON <replaceable
      <para>
       Specify that the policy is to be created as a permissive policy.
       All permissive policies which are applicable to a given query will
-      be combined together using the boolean "OR" operator.  By creating
+      be combined together using the Boolean <quote>OR</quote> operator.  By creating
       permissive policies, administrators can add to the set of records
       which can be accessed.  Policies are permissive by default.
      </para>
@@ -139,7 +139,7 @@ CREATE POLICY <replaceable class="parameter">name</replaceable> ON <replaceable
      <para>
       Specify that the policy is to be created as a restrictive policy.
       All restrictive policies which are applicable to a given query will
-      be combined together using the boolean "AND" operator.  By creating
+      be combined together using the Boolean <quote>AND</quote> operator.  By creating
       restrictive policies, administrators can reduce the set of records
       which can be accessed as all restrictive policies must be passed for
       each record.
diff --git a/doc/src/sgml/ref/create_statistics.sgml b/doc/src/sgml/ref/create_statistics.sgml
@@ -152,14 +152,14 @@ CREATE STATISTICS s1 (dependencies) ON a, b FROM t1;
 
 ANALYZE t1;
 
--- now the rowcount estimate is more accurate:
+-- now the row count estimate is more accurate:
 EXPLAIN ANALYZE SELECT * FROM t1 WHERE (a = 1) AND (b = 0);
 </programlisting>
 
    Without functional-dependency statistics, the planner would assume
    that the two <literal>WHERE</> conditions are independent, and would
    multiply their selectivities together to arrive at a much-too-small
-   rowcount estimate.
+   row count estimate.
    With such statistics, the planner recognizes that the <literal>WHERE</>
    conditions are redundant and does not underestimate the rowcount.
   </para>
diff --git a/doc/src/sgml/ref/create_table.sgml b/doc/src/sgml/ref/create_table.sgml
@@ -443,8 +443,8 @@ FROM ( { <replaceable class="PARAMETER">numeric_literal</replaceable> | <replace
       include multiple columns or expressions (up to 32, but this limit can
       altered when building <productname>PostgreSQL</productname>.), but for
       list partitioning, the partition key must consist of a single column or
-      expression.  If no btree operator class is specified when creating a
-      partitioned table, the default btree operator class for the datatype will
+      expression.  If no B-tree operator class is specified when creating a
+      partitioned table, the default B-tree operator class for the datatype will
       be used.  If there is none, an error will be reported.
      </para>
 
diff --git a/doc/src/sgml/ref/explain.sgml b/doc/src/sgml/ref/explain.sgml
@@ -201,7 +201,7 @@ ROLLBACK;
     <term><literal>SUMMARY</literal></term>
     <listitem>
      <para>
-      Include summary information (eg: totalled timing information) after the
+      Include summary information (e.g., totaled timing information) after the
       query plan.  Summary information is included by default when
       <literal>ANALYZE</literal> is used but otherwise is not included by
       default, but can be enabled using this option.  Planning time in
diff --git a/doc/src/sgml/ref/pg_dumpall.sgml b/doc/src/sgml/ref/pg_dumpall.sgml
@@ -345,11 +345,14 @@ PostgreSQL documentation
       <term><option>--no-role-passwords</option></term>
       <listitem>
        <para>
-        Do not dump passwords for roles. When restored, roles will have a NULL
-        password and authentication will always fail until the password is reset.
-        Since password values aren't needed when this option is specified we
-        use the catalog view pg_roles in preference to pg_authid, since access
-        to pg_authid may be restricted by security policy.
+        Do not dump passwords for roles.  When restored, roles will have a
+        null password, and password authentication will always fail until the
+        password is set.  Since password values aren't needed when this option
+        is specified, the role information is read from the catalog
+        view <structname>pg_roles</structname> instead
+        of <structname>pg_authid</structname>.  Therefore, this option also
+        helps if access to <structname>pg_authid</structname> is restricted by
+        some security policy.
        </para>
       </listitem>
      </varlistentry>
diff --git a/doc/src/sgml/release-10.sgml b/doc/src/sgml/release-10.sgml
diff --git a/doc/src/sgml/user-manag.sgml b/doc/src/sgml/user-manag.sgml
diff --git a/doc/src/sgml/xfunc.sgml b/doc/src/sgml/xfunc.sgml
