Documentation spell and markup checking

Author: petere

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.
   </para>
 
   <para>
@@ -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.
       </entry>
      </row>
 

doc/src/sgml/docguide.sgml

@@ -317,12 +317,12 @@ make install
        <note>
        <para>
         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:
 <screen>
 openjade:./stylesheet.dsl:664:2:E: flow object not accepted by port; only display flow objects accepted
 make: *** [postgres-A4.tex-pdf] Segmentation fault
 </screen>
-        Downgrading to openjade 1.3 should get rid of this error.
+        Downgrading to OpenJade 1.3 should get rid of this error.
        </para>
        </note>
 

doc/src/sgml/ecpg.sgml

@@ -2752,7 +2752,7 @@ timestamp PGTYPEStimestamp_from_asc(char *str, char **endptr);
        <para>
         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
         <productname>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);
 </synopsis>
         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.
        </para>
        <para>
@@ -9249,7 +9249,7 @@ int risnull(int t, char *ptr);
 </synopsis>
         The function receives the type of the variable to test (<literal>t</>)
         as well a pointer to this variable (<literal>ptr</>). Note that the
-        latter needs to be casted to a char*. See the function <xref
+        latter needs to be cast to a char*. See the function <xref
         linkend="rsetnull"> for a list of possible variable types.
        </para>
        <para>

doc/src/sgml/fdwhandler.sgml

@@ -191,7 +191,7 @@ ExplainForeignScan (ForeignScanState *node,
      related functions to add fields to the <command>EXPLAIN</> output.
      The flag fields in <literal>es</> can be used to determine what to
      print, and the state of the <structname>ForeignScanState</> node
-     can be inspected to provide runtime statistics in the <command>EXPLAIN
+     can be inspected to provide run-time statistics in the <command>EXPLAIN
      ANALYZE</> case.
     </para>
 
@@ -489,20 +489,20 @@ GetForeignServerByName(const char *name, bool missing_ok);
      The <structfield>fdw_private</> list has no other restrictions and is
      not interpreted by the core backend in any way.  The
      <structfield>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.
     </para>
 
     <para>
-     In <function>GetForeignPlan</>, generally the passed-in targetlist can
+     In <function>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 <literal>baserel-&gt;baserestrictinfo</>,
      but may be re-ordered for better execution efficiency.  In simple cases
      the FDW can just strip <structname>RestrictInfo</> nodes from the
      scan_clauses list (using <function>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
      <structfield>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 <literal>WHERE <replaceable>foreign_variable</> =
-     $1</literal>, with the parameter value obtained at runtime from
+     $1</literal>, with the parameter value obtained at run time from
      evaluation of the <structfield>fdw_exprs</> expression tree.
     </para>
 
@@ -541,7 +541,7 @@ GetForeignServerByName(const char *name, bool missing_ok);
      <literal>required_outer</> and list the specific join clause(s) in
      <literal>param_clauses</>.  In <function>GetForeignPlan</>, the
      <replaceable>local_variable</> portion of the join clause would be added
-     to <structfield>fdw_exprs</>, and then at runtime the case works the
+     to <structfield>fdw_exprs</>, and then at run time the case works the
      same as for an ordinary restriction clause.
     </para>
 

doc/src/sgml/file-fdw.sgml

@@ -122,7 +122,7 @@
 
    <listitem>
     <para>
-     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 <literal>null</literal> option).  This has the same effect
      as listing the column in <command>COPY</>'s
@@ -184,7 +184,7 @@ CREATE SERVER pglog FOREIGN DATA WRAPPER file_fdw;
   <para>
    Now you are ready to create the foreign data table.  Using the
    <command>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:
 
 <programlisting>
 CREATE FOREIGN TABLE pglog (

doc/src/sgml/func.sgml

@@ -9648,9 +9648,9 @@ table2-mapping
          <literal>array_to_json(anyarray [, pretty_bool])</literal>
        </entry>
        <entry>
-         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 <parameter>pretty_bool</parameter> is true.
        </entry>
        <entry><literal>array_to_json('{{1,5},{99,100}}'::int[])</literal></entry>
        <entry><literal>[[1,5],[99,100]]</literal></entry>
@@ -9664,7 +9664,7 @@ table2-mapping
        </entry>
        <entry>
          Returns the row as JSON. Line feeds will be added between level
-         1 elements if pretty_bool is true.
+         1 elements if <parameter>pretty_bool</parameter> is true.
        </entry>
        <entry><literal>row_to_json(row(1,'foo'))</literal></entry>
        <entry><literal>{"f1":1,"f2":"foo"}</literal></entry>
@@ -13813,7 +13813,7 @@ SELECT pg_type_is_visible('myschema.widget'::regtype);
        <entry><literal><function>pg_get_viewdef(<parameter>view_name</parameter>, <parameter>pretty_bool</>)</function></literal></entry>
        <entry><type>text</type></entry>
        <entry>get underlying <command>SELECT</command> command for view,
-              lines with fields are wrapped to 80 columns if pretty_bool is true (<emphasis>deprecated</emphasis>)</entry>
+              lines with fields are wrapped to 80 columns if <parameter>pretty_bool</parameter> is true (<emphasis>deprecated</emphasis>)</entry>
       </row>
       <row>
        <entry><literal><function>pg_get_viewdef(<parameter>view_oid</parameter>)</function></literal></entry>
@@ -13824,7 +13824,7 @@ SELECT pg_type_is_visible('myschema.widget'::regtype);
        <entry><literal><function>pg_get_viewdef(<parameter>view_oid</parameter>, <parameter>pretty_bool</>)</function></literal></entry>
        <entry><type>text</type></entry>
        <entry>get underlying <command>SELECT</command> command for view,
-              lines with fields are wrapped to 80 columns if pretty_bool is true</entry>
+              lines with fields are wrapped to 80 columns if <parameter>pretty_bool</parameter> is true</entry>
       </row>
       <row>
        <entry><literal><function>pg_get_viewdef(<parameter>view_oid</parameter>, <parameter>wrap_int</>)</function></literal></entry>
@@ -13845,7 +13845,7 @@ SELECT pg_type_is_visible('myschema.widget'::regtype);
       <row>
        <entry><literal><function>pg_tablespace_location(<parameter>tablespace_oid</parameter>)</function></literal></entry>
        <entry><type>text</type></entry>
-       <entry>get the path in the filesystem that this tablespace is located in</entry>
+       <entry>get the path in the file system that this tablespace is located in</entry>
       </row>
       <row>
        <entry><literal><function>pg_typeof(<parameter>any</parameter>)</function></literal></entry>

doc/src/sgml/gin.sgml

@@ -107,9 +107,9 @@
        If any of the keys can be null, also palloc an array of
        <literal>*nkeys</> booleans, store its address at
        <literal>*nullFlags</>, and set these null flags as needed.
-       <literal>*nullFlags</> can be left NULL (its initial value)
+       <literal>*nullFlags</> can be left <symbol>NULL</symbol> (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 <symbol>NULL</symbol> if the item contains no keys.
       </para>
      </listitem>
     </varlistentry>
@@ -313,7 +313,7 @@
  </para>
 
  <para>
-  Multi-column <acronym>GIN</acronym> indexes are implemented by building
+  Multicolumn <acronym>GIN</acronym> 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.
  </para>

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.
   </para>

doc/src/sgml/indexam.sgml

@@ -363,7 +363,7 @@ amrescan (IndexScanDesc scan,
           ScanKey orderbys,
           int norderbys);
 </programlisting>
-   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 <literal>keys</> and/or
    <literal>orderbys</>.)  Note that it is not allowed for
    the number of keys or order-by operators to be larger than

doc/src/sgml/libpq.sgml

@@ -805,7 +805,7 @@ postgresql:///mydb?host=localhost&port=5433
    </para>
 
    <para>
-    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:
 <synopsis>
 postgresql://[2001:db8::1234]/database

doc/src/sgml/maintenance.sgml

@@ -865,10 +865,10 @@ pg_ctl start | rotatelogs /var/log/pgsql_log 86400
   </para>
 
   <para>
-   <ulink url="http://pgfouine.projects.postgresql.org/">pgFouine</ulink>
+   <ulink url="http://pgfouine.projects.postgresql.org/"><productname>pgFouine</productname></ulink>
    is an external project that does sophisticated log file analysis.
    <ulink
-   url="http://bucardo.org/wiki/Check_postgres">check_postgres</ulink>
+   url="http://bucardo.org/wiki/Check_postgres"><productname>check_postgres</productname></ulink>
    provides Nagios alerts when important messages appear in the log
    files, as well as detection of many other extraordinary conditions.
   </para>

doc/src/sgml/monitoring.sgml

@@ -210,7 +210,7 @@ postgres: <replaceable>user</> <replaceable>database</> <replaceable>host</> <re
    the collector just before going idle; so a query or transaction still in
    progress does not affect the displayed totals.  Also, the collector itself
    emits a new report at most once per <varname>PGSTAT_STAT_INTERVAL</varname>
-   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 <varname>track_activities</varname> is
    always up-to-date.
@@ -472,7 +472,7 @@ postgres: <replaceable>user</> <replaceable>database</> <replaceable>host</> <re
 
 
   <table id="pg-stat-activity-view" xreflabel="pg_stat_activity">
-   <title>pg_stat_activity view</title>
+   <title><structname>pg_stat_activity</structname> View</title>
 
    <tgroup cols="3">
     <thead>
@@ -649,7 +649,7 @@ postgres: <replaceable>user</> <replaceable>database</> <replaceable>host</> <re
   </note>
 
   <table id="pg-stat-bgwriter-view" xreflabel="pg_stat_bgwriter">
-   <title>pg_stat_bgwriter view</title>
+   <title><structname>pg_stat_bgwriter</structname> View</title>
 
    <tgroup cols="3">
     <thead>
@@ -736,7 +736,7 @@ postgres: <replaceable>user</> <replaceable>database</> <replaceable>host</> <re
   </para>
 
   <table id="pg-stat-database-view" xreflabel="pg_stat_database">
-   <title>pg_stat_database view</title>
+   <title><structname>pg_stat_database</structname> View</title>
    <tgroup cols="3">
     <thead>
     <row>
@@ -787,7 +787,7 @@ postgres: <replaceable>user</> <replaceable>database</> <replaceable>host</> <re
      <entry><type>bigint</></entry>
      <entry>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)
      </entry>
     </row>
     <row>
@@ -873,7 +873,7 @@ postgres: <replaceable>user</> <replaceable>database</> <replaceable>host</> <re
   </para>
 
   <table id="pg-stat-all-tables-view" xreflabel="pg_stat_all_tables">
-   <title>pg_stat_all_tables view</title>
+   <title><structname>pg_stat_all_tables</structname> View</title>
    <tgroup cols="3">
     <thead>
     <row>
@@ -1011,7 +1011,7 @@ postgres: <replaceable>user</> <replaceable>database</> <replaceable>host</> <re
   </para>
 
   <table id="pg-stat-all-indexes-view" xreflabel="pg_stat_all_indexes">
-   <title>pg_stat_all_indexes view</title>
+   <title><structname>pg_stat_all_indexes</structname> View</title>
    <tgroup cols="3">
     <thead>
     <row>
@@ -1104,7 +1104,7 @@ postgres: <replaceable>user</> <replaceable>database</> <replaceable>host</> <re
   </note>
 
   <table id="pg-statio-all-tables-view" xreflabel="pg_statio_all_tables">
-   <title>pg_statio_all_tables view</title>
+   <title><structname>pg_statio_all_tables</structname> View</title>
    <tgroup cols="3">
     <thead>
     <row>
@@ -1185,7 +1185,7 @@ postgres: <replaceable>user</> <replaceable>database</> <replaceable>host</> <re
   </para>
 
   <table id="pg-statio-all-indexes-view" xreflabel="pg_statio_all_indexes">
-   <title>pg_statio_all_indexes view</title>
+   <title><structname>pg_statio_all_indexes</structname> View</title>
    <tgroup cols="3">
     <thead>
     <row>
@@ -1246,7 +1246,7 @@ postgres: <replaceable>user</> <replaceable>database</> <replaceable>host</> <re
   </para>
 
   <table id="pg-statio-all-sequences-view" xreflabel="pg_statio_all_sequences">
-   <title>pg_statio_all_sequences view</title>
+   <title><structname>pg_statio_all_sequences</structname> View</title>
    <tgroup cols="3">
     <thead>
     <row>
@@ -1293,7 +1293,7 @@ postgres: <replaceable>user</> <replaceable>database</> <replaceable>host</> <re
   </para>
 
   <table id="pg-stat-user-functions-view" xreflabel="pg_stat_user_functions">
-   <title>pg_stat_user_functions view</title>
+   <title><structname>pg_stat_user_functions</structname> View</title>
    <tgroup cols="3">
     <thead>
     <row>
@@ -1348,7 +1348,7 @@ postgres: <replaceable>user</> <replaceable>database</> <replaceable>host</> <re
   </para>
 
   <table id="pg-stat-replication-view" xreflabel="pg_stat_replication">
-   <title>pg_stat_replication view</title>
+   <title><structname>pg_stat_replication</structname> View</title>
    <tgroup cols="3">
     <thead>
     <row>
@@ -1462,7 +1462,7 @@ postgres: <replaceable>user</> <replaceable>database</> <replaceable>host</> <re
   </para>
 
   <table id="pg-stat-database-conflicts-view" xreflabel="pg_stat_database_conflicts">
-   <title>pg_stat_database_conflicts view</title>
+   <title><structname>pg_stat_database_conflicts</structname> View</title>
    <tgroup cols="3">
     <thead>
     <row>