Documentation spell checking and markup improvements
authorPeter Eisentraut
Fri, 29 Jul 2016 02:46:15 +0000 (22:46 -0400)
committerPeter Eisentraut
Fri, 29 Jul 2016 02:46:15 +0000 (22:46 -0400)
15 files changed:
doc/src/sgml/bloom.sgml
doc/src/sgml/brin.sgml
doc/src/sgml/config.sgml
doc/src/sgml/ecpg.sgml
doc/src/sgml/func.sgml
doc/src/sgml/high-availability.sgml
doc/src/sgml/indices.sgml
doc/src/sgml/libpq.sgml
doc/src/sgml/monitoring.sgml
doc/src/sgml/ref/pgbench.sgml
doc/src/sgml/ref/psql-ref.sgml
doc/src/sgml/ref/select.sgml
doc/src/sgml/release-9.6.sgml
doc/src/sgml/sources.sgml
doc/src/sgml/textsearch.sgml

index b3d0665deb332f1d43e87ebd1eb0ddeb2cee0f6d..396348c5237e3cf5b17cc1dc54fff825a570c7e6 100644 (file)
@@ -212,8 +212,8 @@ CREATE INDEX
 
   
    An operator class for bloom indexes requires only a hash function for the
-   indexed datatype and an equality operator for searching. This example
-   shows the opclass definition for the text data type:
+   indexed data type and an equality operator for searching. This example
+   shows the operator class definition for the text data type:
   
 
 
index d57fd52611258342df3c13e68745a01780a158e5..f51928513ce77c128104570a005489bd83a3bf6a 100644 (file)
@@ -625,7 +625,7 @@ typedef struct BrinOpcInfo
  
 
  
-  To write an operator class for a complex datatype which has values
+  To write an operator class for a complex data type which has values
   included within another type, it's possible to use the inclusion support
   procedures alongside the corresponding operators, as shown
   in .  It requires
@@ -774,16 +774,16 @@ typedef struct BrinOpcInfo
     Support procedure numbers 1-10 are reserved for the BRIN internal
     functions, so the SQL level functions start with number 11.  Support
     function number 11 is the main function required to build the index.
-    It should accept two arguments with the same datatype as the opclass,
-    and return the union of them.  The inclusion opclass can store union
-    values with different datatypes if it is defined with the
+    It should accept two arguments with the same data type as the operator class,
+    and return the union of them.  The inclusion operator class can store union
+    values with different data types if it is defined with the
     STORAGE parameter.  The return value of the union
-    function should match the STORAGE datatype.
+    function should match the STORAGE data type.
  
 
  
     Support procedure numbers 12 and 14 are provided to support
-    irregularities of built-in datatypes.  Procedure number 12
+    irregularities of built-in data types.  Procedure number 12
     is used to support network addresses from different families which
     are not mergeable.  Procedure number 14 is used to support
     empty ranges.  Procedure number 13 is an optional but
@@ -794,17 +794,17 @@ typedef struct BrinOpcInfo
  
 
  
-    Both minmax and inclusion opclasses support cross-datatype
+    Both minmax and inclusion operator classes support cross-data-type
     operators, though with these the dependencies become more complicated.
-    The minmax opclass requires a full set of operators to be
-    defined with both arguments having the same datatype.  It allows
-    additional datatypes to be supported by defining extra sets
-    of operators.  Inclusion opclass operator strategies are dependent
+    The minmax operator class requires a full set of operators to be
+    defined with both arguments having the same data type.  It allows
+    additional data types to be supported by defining extra sets
+    of operators.  Inclusion operator class operator strategies are dependent
     on another operator strategy as shown in
     , or the same
     operator strategy as themselves.  They require the dependency
-    operator to be defined with the STORAGE datatype as the
-    left-hand-side argument and the other supported datatype to be the
+    operator to be defined with the STORAGE data type as the
+    left-hand-side argument and the other supported data type to be the
     right-hand-side argument of the supported operator.  See
     float4_minmax_ops as an example of minmax, and
     box_inclusion_ops as an example of inclusion.
index c9e0ec2c0219b80bba2e5c002097211877eb98ed..4fb3186acf6c51a2267cb0cd762beb844566c111 100644 (file)
@@ -2006,7 +2006,7 @@ include_dir 'conf.d'
          Gather node.  Parallel workers are taken from the
          pool of processes established by
          .  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.
index 35f7f11dc33bd3ae2b016f6203681810813b97a1..b917bdd5b212310cc01ab3a404df1a292e780929 100644 (file)
@@ -3782,7 +3782,7 @@ EXEC SQL GET DESCRIPTOR name VALUE num
     keywords are different. A Descriptor Area can also be manually built to
     provide the input parameters for a query or a cursor and
     USING SQL DESCRIPTOR name
-    is the way to pass the input parameters into a parametrized query. The statement
+    is the way to pass the input parameters into a parameterized query. The statement
     to build a named SQL Descriptor Area is below:
 
 EXEC SQL SET DESCRIPTOR name VALUE num field = :hostvar;
@@ -3917,7 +3917,7 @@ typedef struct sqlda_struct sqlda_t;
       sqln
       
        
-        It contains the number of input parameters for a parametrized query in
+        It contains the number of input parameters for a parameterized query in
         case it's passed into OPENDECLARE or
         EXECUTE statements using the USING
         keyword. In case it's used as output of SELECT,
@@ -8121,7 +8121,7 @@ if (*(int2 *)sqldata->sqlvar[i].sqlind != 0)
       
        
         Type of the NULL indicator data. It's always SQLSMINT when returning data from the server.
-        When the SQLDA is used for a parametrized query, the data is treated
+        When the SQLDA is used for a parameterized query, the data is treated
         according to the set type.
        
       
index 71aae2f41648bda46b17ddae89319e294c980313..971e642276c4ac4835e0b2d9cbf8a700d292d7fa 100644 (file)
@@ -17100,7 +17100,7 @@ SELECT collation for ('foo' COLLATE "de_DE");
        
        record
        
-        Returns information about current controldata file state.
+        Returns information about current control file state.
        
       
 
@@ -17148,97 +17148,97 @@ SELECT collation for ('foo' COLLATE "de_DE");
      
 
       
-       checkpoint_location
+       checkpoint_location
        pg_lsn
       
 
       
-       prior_location
+       prior_location
        pg_lsn
       
 
       
-       redo_location
+       redo_location
        pg_lsn
       
 
       
-       redo_wal_file
+       redo_wal_file
        text
       
 
       
-       timeline_id
+       timeline_id
        integer
       
 
       
-       prev_timeline_id
+       prev_timeline_id
        integer
       
 
       
-       full_page_writes
+       full_page_writes
        boolean
       
 
       
-       next_xid
+       next_xid
        text
       
 
       
-       next_oid
+       next_oid
        oid
       
 
       
-       next_multixact_id
+       next_multixact_id
        xid
       
 
       
-       next_multi_offset
+       next_multi_offset
        xid
       
 
       
-       oldest_xid
+       oldest_xid
        xid
       
 
       
-       oldest_xid_dbid
+       oldest_xid_dbid
        oid
       
 
       
-       oldest_active_xid
+       oldest_active_xid
        xid
       
 
       
-       oldest_multi_xid
+       oldest_multi_xid
        xid
       
 
       
-       oldest_multi_dbid
+       oldest_multi_dbid
        oid
       
 
       
-       oldest_commit_ts_xid
+       oldest_commit_ts_xid
        xid
       
 
       
-       newest_commit_ts_xid
+       newest_commit_ts_xid
        xid
       
 
       
-       checkpoint_time
+       checkpoint_time
        timestamp with time zone
       
 
@@ -17264,22 +17264,22 @@ SELECT collation for ('foo' COLLATE "de_DE");
      
 
       
-       pg_control_version
+       pg_control_version
        integer
       
 
       
-       catalog_version_no
+       catalog_version_no
        integer
       
 
       
-       system_identifier
+       system_identifier
        bigint
       
 
       
-       pg_control_last_modified
+       pg_control_last_modified
        timestamp with time zone
       
 
@@ -17305,67 +17305,67 @@ SELECT collation for ('foo' COLLATE "de_DE");
      
 
       
-       max_data_alignment
+       max_data_alignment
        integer
       
 
       
-       database_block_size
+       database_block_size
        integer
       
 
       
-       blocks_per_segment
+       blocks_per_segment
        integer
       
 
       
-       wal_block_size
+       wal_block_size
        integer
       
 
       
-       bytes_per_wal_segment
+       bytes_per_wal_segment
        integer
       
 
       
-       max_identifier_length
+       max_identifier_length
        integer
       
 
       
-       max_index_columns
+       max_index_columns
        integer
       
 
       
-       max_toast_chunk_size
+       max_toast_chunk_size
        integer
       
 
       
-       large_object_chunk_size
+       large_object_chunk_size
        integer
       
 
       
-       bigint_timestamps
+       bigint_timestamps
        boolean
       
 
       
-       float4_pass_by_value
+       float4_pass_by_value
        boolean
       
 
       
-       float8_pass_by_value
+       float8_pass_by_value
        boolean
       
 
       
-       data_page_checksum_version
+       data_page_checksum_version
        integer
       
 
@@ -17391,27 +17391,27 @@ SELECT collation for ('foo' COLLATE "de_DE");
      
 
       
-       min_recovery_end_location
+       min_recovery_end_location
        pg_lsn
       
 
       
-       min_recovery_end_timeline
+       min_recovery_end_timeline
        integer
       
 
       
-       backup_start_location
+       backup_start_location
        pg_lsn
       
 
       
-       backup_end_location
+       backup_end_location
        pg_lsn
       
 
       
-       end_of_backup_record_required
+       end_of_backup_record_required
        boolean
       
 
index 8834a4297690a367667b8e63c05940def3c3ffa7..06f49dba5da29d9b404df878de1f797027d8044e 100644 (file)
@@ -1046,7 +1046,7 @@ primary_slot_name = 'node_a_slot'
     servers.  Waiting for confirmation increases the user's confidence that the
     changes will not be lost in the event of server crashes but it also
     necessarily increases the response time for the requesting transaction.
-    The minimum wait time is the roundtrip time between primary to standby.
+    The minimum wait time is the round-trip time between primary to standby.
    
 
    
index 49d3286400ba00be7a8bf4288f3d3731a928910c..46f8e55ca925f864573ea226f1a9fb5105100b0e 100644 (file)
@@ -1315,7 +1315,7 @@ SELECT target FROM tests WHERE subject = 'some-subject' AND success;
    But there's a problem: the WHERE clause refers
    to success which is not available as a result column of the
    index.  Nonetheless, an index-only scan is possible because the plan does
-   not need to recheck that part of the WHERE clause at runtime:
+   not need to recheck that part of the WHERE clause at run time:
    all entries found in the index necessarily have success = true
    so this need not be explicitly checked in the
    plan.  PostgreSQL versions 9.6 and later will recognize
index 6285dd05dde81e7922043a4f2509bf0e5e555d08..f22e3da0475804166c0c8915dc92088c7ad7d995 100644 (file)
@@ -7345,7 +7345,7 @@ ldap://ldap.acme.com/cn=dbserver,cn=hosts?pgconnectinfo?base?(objectclass=*)
   
    In verify-full mode, the host name is matched against the
    certificate's Subject Alternative Name attribute(s), or against the
-   Common Name attribute if no Subject Alternative Name of type dNSName is
+   Common Name attribute if no Subject Alternative Name of type dNSName is
    present.  If the certificate's name attribute starts with an asterisk
    (*), the asterisk will be treated as
    a wildcard, which will match all characters except a dot
@@ -7505,7 +7505,7 @@ ldap://ldap.acme.com/cn=dbserver,cn=hosts?pgconnectinfo?base?(objectclass=*)
 
   
    All SSL options carry overhead in the form of encryption and
-   key-exchange, so there is a tradeoff that has to be made between performance
+   key-exchange, so there is a trade-off that has to be made between performance
    and security. 
    illustrates the risks the different sslmode values
    protect against, and what statement they make about security and overhead.
index b620febd06b400aa374ff1ebc43e2c133db54632..1c283a0623cbeedbc16a51e1e94922602cfddfa4 100644 (file)
@@ -870,7 +870,7 @@ postgres   27093  0.0  0.0  30096  2752 ?        Ss   11:34   0:00 postgres: ser
         
          BtreeVacuumLock
           Waiting to read or update vacuum-related information for a
-          Btree index.
+          B-tree index.
         
         
          AddinShmemInitLock
index f3afedb04090cf81238e946d5e2d36d576ce6bdc..bc37285066d2d4a7ed189471be95df66c2f89dbe 100644 (file)
@@ -266,13 +266,13 @@ pgbench  options  dbname
       
       
        
-        Add the specified builtin script to the list of executed scripts.
+        Add the specified built-in script to the list of executed scripts.
         An optional integer weight after @ allows to adjust the
         probability of drawing the script.  If not specified, it is set to 1.
-        Available builtin scripts are: tpcb-like,
+        Available built-in scripts are: tpcb-like,
         simple-update and select-only.
-        Unambiguous prefixes of builtin names are accepted.
-        With special name list, show the list of builtin scripts
+        Unambiguous prefixes of built-in names are accepted.
+        With special name list, show the list of built-in scripts
         and exit immediately.
        
       
@@ -422,7 +422,7 @@ pgbench  options  dbname
       
       
        
-        Run builtin simple-update script.
+        Run built-in simple-update script.
         Shorthand for 
        
       
@@ -702,7 +702,7 @@ pgbench  options  dbname
  
 
   
-   The default builtin transaction script (also invoked with 
+   The default built-in transaction script (also invoked with 
    issues seven commands per transaction over randomly chosen aid,
    tid, bid and balance.
    The scenario is inspired by the TPC-B benchmark, but is not actually TPC-B,
@@ -720,14 +720,14 @@ pgbench  options  dbname
   
 
   
-   If you select the simple-update builtin (also 
+   If you select the simple-update built-in (also 
    steps 4 and 5 aren't included in the transaction.
    This will avoid update contention on these tables, but
    it makes the test case even less like TPC-B.
   
 
   
-   If you select the select-only builtin (also 
+   If you select the select-only built-in (also 
    only the SELECT is issued.
   
  
@@ -1000,7 +1000,7 @@ pgbench  options  dbname
       
        random_gaussian(lb, ub, parameter)
        integer
-       gaussian-distributed random integer in [lb, ub],
+       Gaussian-distributed random integer in [lb, ub],
               see below
        random_gaussian(1, 10, 2.5)
        an integer between 1 and 10
index 0e6f3fd317f0e4b6560d6d423afd0aec77850688..a4d3e429f67f89fd76589ac56a89c6a843a411d4 100644 (file)
@@ -4164,7 +4164,7 @@ second | four
 
 
   When suitable, query results can be shown in a crosstab representation
-  with the \crosstabview command:
+  with the \crosstabview command:
 
 testdb=> SELECT first, second, first > 2 AS gt2 FROM my_table;
  first | second | ge2 
index 0520f2ccfa046afaccf75ff12c064faf141f3c3f..c4bd8fed449b5f9d5cb49713dbc0b55038fe7439 100644 (file)
@@ -460,7 +460,7 @@ TABLE [ ONLY ] table_name [ * ]
         with ROWS FROM( ... ).  The output of such an item is the
         concatenation of the first row from each function, then the second
         row from each function, etc.  If some of the functions produce fewer
-        rows than others, NULLs are substituted for the missing data, so
+        rows than others, null values are substituted for the missing data, so
         that the total number of rows returned is always the same as for the
         function that produced the most rows.
        
index 82aaa965dbafc4579cb0290a72330543056321d7..230eb4cb4c06629d20c35c8e93befe81ae7f1877 100644 (file)
         output list are executed in the order suggested by ORDER
         BY, and that they are not evaluated more times than required when
         there's a LIMIT.  Previously, these properties held if
-        the ordering was performed by an indexscan or pre-mergejoin sort,
+        the ordering was performed by an index scan or pre-merge-join sort,
         but not if it was performed by a top-level sort step.
        
       
 2016-01-26 [cc988fbb0] Improve ResourceOwners' behavior for large numbers of ow
 -->
        
-        Improve performance of ResourceOwners with many tracked objects
+        Improve performance of resource owners with many tracked objects
         (Aleksander Alekseev)
        
       
index 13409a7994a5d018d6267a86cadbb0a9179a7a78..eb852627273b6bbba7cc60c35dd053ed369a8108 100644 (file)
@@ -935,10 +935,10 @@ MemoryContextSwitchTo(MemoryContext context)
     
     
      Barring special arrangements code in signal handlers may only
-     call async-signal safe functions (as defined in posix) and access
+     call async-signal safe functions (as defined in POSIX) and access
      variables of type volatile sig_atomic_t. A few
-     functions in postgres are also deemed signal safe, importantly
-     <literal>SetLatch()>.
+     functions in postgres are also deemed signal safe, importantly
+     <function>SetLatch()>.
     
     
      In most cases signal handlers should do nothing more than note
@@ -957,9 +957,9 @@ handle_sighup(SIGNAL_ARGS)
     errno = save_errno;
 }
 
-     <literal>errno is safed and restored because
-     <literal>SetLatch() might change it. If that were not done
-     interrupted code that's currently inspecting errno might see the wrong
+     <varname>errno is saved and restored because
+     <function>SetLatch() might change it. If that were not done
+     interrupted code that's currently inspecting errno might see the wrong
      value.
     
    
index 41151ef4bdf813f512e2ed55db939a5bbbd23b05..be5974a4ffffefdd0a3cfacfb286cf75730c0f7f 100644 (file)
@@ -2798,7 +2798,7 @@ SELECT plainto_tsquery('supernova star');
       to extract .aff and .dic files, change
       extensions to .affix and .dict. For some
       dictionary files it is also needed to convert characters to the UTF-8
-      encoding with commands (for example, for norwegian language dictionary):
+      encoding with commands (for example, for a Norwegian language dictionary):
 
 iconv -f ISO_8859-1 -t UTF-8 -o nn_no.affix nn_NO.aff
 iconv -f ISO_8859-1 -t UTF-8 -o nn_no.dict nn_NO.dic