Documentation spell checking and markup improvements

Author: petere

doc/src/sgml/config.sgml

@@ -223,7 +223,7 @@ include 'filename'
        <secondary>in configuration file</secondary>
       </indexterm>
         The <filename>postgresql.conf</> file can also contain
-        <firstterm>include_dir directives</>, which specify an entire directory
+        <literal>include_dir</literal> directives, which specify an entire directory
         of configuration files to include.  It is used similarly:
  <programlisting>
  include_dir 'directory'
@@ -234,7 +234,7 @@ include 'filename'
         names end with the suffix <literal>.conf</literal> will be included.  File
         names that start with the <literal>.</literal> character are also excluded,
         to prevent mistakes as they are hidden on some platforms.  Multiple files
-        within an include directory are processed in filename order. The filenames
+        within an include directory are processed in file name order. The file names
         are ordered by C locale rules, ie. numbers before letters, and uppercase
         letters before lowercase ones.
      </para>
@@ -1211,7 +1211,7 @@ include 'filename'
         Specifies the maximum amount of disk space that a session can use
         for temporary files, such as sort and hash temporary files, or the
         storage file for a held cursor.  A transaction attempting to exceed
-        this limit will be cancelled.
+        this limit will be canceled.
         The value is specified in kilobytes, and <literal>-1</> (the
         default) means no limit.
         Only superusers can change this setting.
@@ -3358,7 +3358,7 @@ local0.*    /var/log/postgresql
        <para>
         When <varname>logging_collector</varname> is enabled,
         this parameter sets the file names of the created log files.  The value
-        is treated as a <systemitem>strftime</systemitem> pattern,
+        is treated as a <function>strftime</function> pattern,
         so <literal>%</literal>-escapes can be used to specify time-varying
         file names.  (Note that if there are
         any time-zone-dependent <literal>%</literal>-escapes, the computation

doc/src/sgml/datatype.sgml

@@ -4098,7 +4098,7 @@ SET xmloption TO { DOCUMENT | CONTENT };
     representations of XML values, such as in the above examples.
     This would ordinarily mean that encoding declarations contained in
     XML data can become invalid as the character data is converted
-    to other encodings while travelling between client and server,
+    to other encodings while traveling between client and server,
     because the embedded encoding declaration is not changed.  To cope
     with this behavior, encoding declarations contained in
     character strings presented for input to the <type>xml</type> type

doc/src/sgml/fdwhandler.sgml

@@ -450,7 +450,7 @@ ExecForeignInsert (EState *estate,
      query has a <literal>RETURNING</> clause.  Hence, the FDW could choose
      to optimize away returning some or all columns depending on the contents
      of the <literal>RETURNING</> clause.  However, some slot must be
-     returned to indicate success, or the query's reported rowcount will be
+     returned to indicate success, or the query's reported row count will be
      wrong.
     </para>
 
@@ -495,7 +495,7 @@ ExecForeignUpdate (EState *estate,
      query has a <literal>RETURNING</> clause.  Hence, the FDW could choose
      to optimize away returning some or all columns depending on the contents
      of the <literal>RETURNING</> clause.  However, some slot must be
-     returned to indicate success, or the query's reported rowcount will be
+     returned to indicate success, or the query's reported row count will be
      wrong.
     </para>
 
@@ -538,7 +538,7 @@ ExecForeignDelete (EState *estate,
      query has a <literal>RETURNING</> clause.  Hence, the FDW could choose
      to optimize away returning some or all columns depending on the contents
      of the <literal>RETURNING</> clause.  However, some slot must be
-     returned to indicate success, or the query's reported rowcount will be
+     returned to indicate success, or the query's reported row count will be
      wrong.
     </para>
 

doc/src/sgml/func.sgml

@@ -9928,7 +9928,7 @@ table2-mapping
          </indexterm>
          <literal>array_to_json(anyarray [, pretty_bool])</literal>
        </entry>
-       <entry>json</entry>
+       <entry><type>json</type></entry>
        <entry>
          Returns the array as JSON. A PostgreSQL multidimensional array
          becomes a JSON array of arrays. Line feeds will be added between
@@ -9944,7 +9944,7 @@ table2-mapping
          </indexterm>
          <literal>row_to_json(record [, pretty_bool])</literal>
        </entry>
-       <entry>json</entry>
+       <entry><type>json</type></entry>
        <entry>
          Returns the row as JSON. Line feeds will be added between level
          1 elements if <parameter>pretty_bool</parameter> is true.
@@ -9959,12 +9959,12 @@ table2-mapping
          </indexterm>
          <literal>to_json(anyelement)</literal>
        </entry>
-       <entry>json</entry>
+       <entry><type>json</type></entry>
        <entry>
-         Returns the value as JSON. If the data type is not builtin, and there
-         is a cast from the type to json, the cast function will be used to
+         Returns the value as JSON. If the data type is not built in, and there
+         is a cast from the type to <type>json</type>, the cast function will be used to
          perform the conversion. Otherwise, for any value other than a number,
-         a boolean or NULL, the text representation will be used, escaped and
+         a Boolean, or a null value, the text representation will be used, escaped and
          quoted so that it is legal JSON.
        </entry>
        <entry><literal>to_json('Fred said "Hi."'::text)</literal></entry>
@@ -9977,9 +9977,9 @@ table2-mapping
          </indexterm>
          <literal>json_array_length(json)</literal>
        </entry>
-       <entry>int</entry>
+       <entry><type>int</type></entry>
        <entry>
-         Returns the number of elements in the outermost json array.
+         Returns the number of elements in the outermost JSON array.
        </entry>
        <entry><literal>json_array_length('[1,2,3,{"f1":1,"f2":[5,6]},4]')</literal></entry>
        <entry><literal>5</literal></entry>
@@ -9991,9 +9991,9 @@ table2-mapping
          </indexterm>
          <literal>json_each(json)</literal>
        </entry>
-       <entry>SETOF key text, value json</entry>
+       <entry><type>SETOF key text, value json</type></entry>
        <entry>
-         Expands the outermost json object into a set of key/value pairs.
+         Expands the outermost JSON object into a set of key/value pairs.
        </entry>
        <entry><literal>select * from json_each('{"a":"foo", "b":"bar"}')</literal></entry>
        <entry>
@@ -10012,9 +10012,9 @@ table2-mapping
          </indexterm>
          <literal>json_each_text(from_json json)</literal>
        </entry>
-       <entry>SETOF key text, value text</entry>
+       <entry><type>SETOF key text, value text</type></entry>
        <entry>
-         Expands the outermost json object into a set of key/value pairs. The
+         Expands the outermost JSON object into a set of key/value pairs. The
          returned value will be of type text.
        </entry>
        <entry><literal>select * from json_each_text('{"a":"foo", "b":"bar"}')</literal></entry>
@@ -10034,9 +10034,9 @@ table2-mapping
          </indexterm>
          <literal>json_extract_path(from_json json, VARIADIC path_elems text[])</literal>
        </entry>
-       <entry>json</entry>
+       <entry><type>json</type></entry>
        <entry>
-         Returns json object pointed to by <parameter>path_elems</parameter>.
+         Returns JSON object pointed to by <parameter>path_elems</parameter>.
        </entry>
        <entry><literal>json_extract_path('{"f2":{"f3":1},"f4":{"f5":99,"f6":"foo"}}','f4')</literal></entry>
        <entry><literal>{"f5":99,"f6":"foo"}</literal></entry>
@@ -10048,9 +10048,9 @@ table2-mapping
          </indexterm>
          <literal>json_extract_path_text(from_json json, VARIADIC path_elems text[])</literal>
        </entry>
-       <entry>text</entry>
+       <entry><type>text</type></entry>
        <entry>
-         Returns json object pointed to by <parameter>path_elems</parameter>.
+         Returns JSON object pointed to by <parameter>path_elems</parameter>.
        </entry>
        <entry><literal>json_extract_path_text('{"f2":{"f3":1},"f4":{"f5":99,"f6":"foo"}}','f4', 'f6')</literal></entry>
        <entry><literal>foo</literal></entry>
@@ -10062,9 +10062,9 @@ table2-mapping
          </indexterm>
          <literal>json_object_keys(json)</literal>
        </entry>
-       <entry>SETOF text</entry>
+       <entry><type>SETOF text</type></entry>
        <entry>
-          Returns set of keys in the json object.  Only the "outer" object will be displayed.
+          Returns set of keys in the JSON object.  Only the <quote>outer</quote> object will be displayed.
        </entry>
        <entry><literal>json_object_keys('{"f1":"abc","f2":{"f3":"a", "f4":"b"}}')</literal></entry>
        <entry>
@@ -10083,11 +10083,11 @@ table2-mapping
          </indexterm>
          <literal>json_populate_record(base anyelement, from_json json, [, use_json_as_text bool=false]</literal>
        </entry>
-       <entry>anyelement</entry>
+       <entry><type>anyelement</type></entry>
        <entry>
-         Expands the object in from_json to a row whose columns match
+         Expands the object in <replaceable>from_json</replaceable> to a row whose columns match
          the record type defined by base. Conversion will be best
-         effort; columns in base with no corresponding key in from_json
+         effort; columns in base with no corresponding key in <replaceable>from_json</replaceable>
          will be left null.  A column may only be specified once.
        </entry>
        <entry><literal>select * from json_populate_record(null::x, '{"a":1,"b":2}')</literal></entry>
@@ -10106,12 +10106,12 @@ table2-mapping
          </indexterm>
          <literal>json_populate_recordset(base anyelement, from_json json, [, use_json_as_text bool=false]</literal>
        </entry>
-       <entry>SETOF anyelement</entry>
+       <entry><type>SETOF anyelement</type></entry>
        <entry>
-         Expands the outermost set of objects in from_json to a set
+         Expands the outermost set of objects in <replaceable>from_json</replaceable> to a set
          whose columns match the record type defined by base.
          Conversion will be best effort; columns in base with no
-         corresponding key in from_json will be left null.  A column
+         corresponding key in <replaceable>from_json</replaceable> will be left null.  A column
          may only be specified once.
        </entry>
        <entry><literal>select * from json_populate_recordset(null::x, '[{"a":1,"b":2},{"a":3,"b":4}]')</literal></entry>
@@ -10131,9 +10131,9 @@ table2-mapping
          </indexterm>
          <literal>json_array_elements(json)</literal>
        </entry>
-       <entry>SETOF json</entry>
+       <entry><type>SETOF json</type></entry>
        <entry>
-         Expands a json array to a set of json elements.
+         Expands a JSON array to a set of JSON elements.
        </entry>
        <entry><literal>json_array_elements('[1,true, [2,false]]')</literal></entry>
        <entry>
@@ -10152,16 +10152,16 @@ table2-mapping
 
   <note>
     <para>
-      The <xref linkend="hstore"> extension has a cast from hstore to
-      json, so that converted hstore values are represented as json objects,
+      The <xref linkend="hstore"> extension has a cast from <type>hstore</type> to
+      <type>json</type>, so that converted <type>hstore</type> values are represented as JSON objects,
       not as string values.
     </para>
   </note>
 
   <para>
     See also <xref linkend="functions-aggregate"> about the aggregate
     function <function>json_agg</function> which aggregates record
-    values as json efficiently.
+    values as JSON efficiently.
   </para>
  </sect1>
 
@@ -11546,7 +11546,7 @@ SELECT NULLIF(value, '(none)') ...
       <entry>
        <type>json</type>
       </entry>
-      <entry>aggregates records as a json array of objects</entry>
+      <entry>aggregates records as a JSON array of objects</entry>
      </row>
 
      <row>
@@ -14904,7 +14904,7 @@ SELECT set_config('log_statement_stats', 'off', false);
   </sect2>
 
   <sect2 id="functions-admin-signal">
-   <title>Server Signalling Functions</title>
+   <title>Server Signaling Functions</title>
 
    <indexterm>
     <primary>pg_cancel_backend</primary>
@@ -14932,7 +14932,7 @@ SELECT set_config('log_statement_stats', 'off', false);
    </para>
 
    <table id="functions-admin-signal-table">
-    <title>Server Signalling Functions</title>
+    <title>Server Signaling Functions</title>
     <tgroup cols="3">
      <thead>
       <row><entry>Name</entry> <entry>Return Type</entry> <entry>Description</entry>

doc/src/sgml/gin.sgml

@@ -105,7 +105,7 @@
        Returns a palloc'd array of keys given an item to be indexed.  The
        number of returned keys must be stored into <literal>*nkeys</>.
        If any of the keys can be null, also palloc an array of
-       <literal>*nkeys</> booleans, store its address at
+       <literal>*nkeys</> <type>bool</type> fields, store its address at
        <literal>*nullFlags</>, and set these null flags as needed.
        <literal>*nullFlags</> can be left <symbol>NULL</symbol> (its initial value)
        if all keys are non-null.
@@ -130,11 +130,11 @@
        <literal>query</> and the method it should use to extract key values.
        The number of returned keys must be stored into <literal>*nkeys</>.
        If any of the keys can be null, also palloc an array of
-       <literal>*nkeys</> booleans, store its address at
+       <literal>*nkeys</> <type>bool</type> fields, 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 <literal>query</> contains no keys.
+       The return value can be <symbol>NULL</symbol> if the <literal>query</> contains no keys.
       </para>
 
       <para>
@@ -168,8 +168,8 @@
        an array of <literal>*nkeys</> booleans and store its address at
        <literal>*pmatch</>.  Each element of the array should be set to TRUE
        if the corresponding key requires partial match, FALSE if not.
-       If <literal>*pmatch</> is set to NULL then GIN assumes partial match
-       is not required.  The variable is initialized to NULL before call,
+       If <literal>*pmatch</> is set to <symbol>NULL</symbol> then GIN assumes partial match
+       is not required.  The variable is initialized to <symbol>NULL</symbol> before call,
        so this argument can simply be ignored by operator classes that do
        not support partial match.
       </para>
@@ -181,7 +181,7 @@
        To use it, <function>extractQuery</> must allocate
        an array of <literal>*nkeys</> Pointers and store its address at
        <literal>*extra_data</>, then store whatever it wants to into the
-       individual pointers.  The variable is initialized to NULL before
+       individual pointers.  The variable is initialized to <symbol>NULL</symbol> before
        call, so this argument can simply be ignored by operator classes that
        do not require extra data.  If <literal>*extra_data</> is set, the
        whole array is passed to the <function>consistent</> method, and
@@ -215,7 +215,7 @@
        and so are the <literal>queryKeys[]</> and <literal>nullFlags[]</>
        arrays previously returned by <function>extractQuery</>.
        <literal>extra_data</> is the extra-data array returned by
-       <function>extractQuery</>, or NULL if none.
+       <function>extractQuery</>, or <symbol>NULL</symbol> if none.
       </para>
 
       <para>
@@ -261,7 +261,7 @@
        that generated the partial match query is provided, in case its
        semantics are needed to determine when to end the scan.  Also,
        <literal>extra_data</> is the corresponding element of the extra-data
-       array made by <function>extractQuery</>, or NULL if none.
+       array made by <function>extractQuery</>, or <symbol>NULL</symbol> if none.
        Null keys are never passed to this function.
       </para>
      </listitem>
@@ -305,9 +305,9 @@
  </para>
 
  <para>
-  As of <productname>PostgreSQL</productname> 9.1, NULL key values can be
-  included in the index.  Also, placeholder NULLs are included in the index
-  for indexed items that are NULL or contain no keys according to
+  As of <productname>PostgreSQL</productname> 9.1, null key values can be
+  included in the index.  Also, placeholder nulls are included in the index
+  for indexed items that are null or contain no keys according to
   <function>extractValue</>.  This allows searches that should find empty
   items to do so.
  </para>
@@ -471,11 +471,11 @@
 
  <para>
   <acronym>GIN</acronym> assumes that indexable operators are strict.  This
-  means that <function>extractValue</> will not be called at all on a NULL
+  means that <function>extractValue</> will not be called at all on a null
   item value (instead, a placeholder index entry is created automatically),
-  and <function>extractQuery</function> will not be called on a NULL query
+  and <function>extractQuery</function> will not be called on a null query
   value either (instead, the query is presumed to be unsatisfiable).  Note
-  however that NULL key values contained within a non-null composite item
+  however that null key values contained within a non-null composite item
   or query value are supported.
  </para>
 </sect1>

doc/src/sgml/hstore.sgml

@@ -325,15 +325,15 @@ b
      <row>
       <entry><function>hstore_to_json(hstore)</function></entry>
       <entry><type>json</type></entry>
-      <entry>get <type>hstore</type> as a json value</entry>
+      <entry>get <type>hstore</type> as a <type>json</type> value</entry>
       <entry><literal>hstore_to_json('"a key"=&gt;1, b=&gt;t, c=&gt;null, d=&gt;12345, e=&gt;012345, f=&gt;1.234, g=&gt;2.345e+4')</literal></entry>
       <entry><literal>{"a key": "1", "b": "t", "c": null, "d": "12345", "e": "012345", "f": "1.234", "g": "2.345e+4"}</literal></entry>
      </row>
 
      <row>
       <entry><function>hstore_to_json_loose(hstore)</function></entry>
       <entry><type>json</type></entry>
-      <entry>get <type>hstore</type> as a json value, but attempting to distinguish numerical and boolean values so they are unquoted in the json</entry>
+      <entry>get <type>hstore</type> as a <type>json</type> value, but attempting to distinguish numerical and Boolean values so they are unquoted in the JSON</entry>
       <entry><literal>hstore_to_json_loose('"a key"=&gt;1, b=&gt;t, c=&gt;null, d=&gt;12345, e=&gt;012345, f=&gt;1.234, g=&gt;2.345e+4')</literal></entry>
       <entry><literal>{"a key": 1, "b": true, "c": null, "d": 12345, "e": "012345", "f": 1.234, "g": 2.345e+4}</literal></entry>
      </row>

doc/src/sgml/indexam.sgml

@@ -113,8 +113,8 @@
    <structfield>amoptionalkey</structfield> false.
    One reason that an index AM might set
    <structfield>amoptionalkey</structfield> false is if it doesn't index
-   NULLs.  Since most indexable operators are
-   strict and hence cannot return TRUE for NULL inputs,
+   null values.  Since most indexable operators are
+   strict and hence cannot return true for null inputs,
    it is at first sight attractive to not store index entries for null values:
    they could never be returned by an index scan anyway.  However, this
    argument fails when an index scan has no restriction clause for a given

doc/src/sgml/information_schema.sgml

@@ -13,7 +13,7 @@
   information schema is defined in the SQL standard and can therefore
   be expected to be portable and remain stable — unlike the system
   catalogs, which are specific to
-  <productname>PostgreSQL</productname> and are modelled after
+  <productname>PostgreSQL</productname> and are modeled after
   implementation concerns.  The information schema views do not,
   however, contain information about
   <productname>PostgreSQL</productname>-specific features; to inquire