Documentation Source Text

Check-in [297fc5035b]
Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Fix documentation typos.
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: 297fc5035b0efe8ed53bed8ee8c0ffe2058045e1fc3115cf145f48e728378479
User & Date: drh 2018-11-30 21:04:18
Context
2018-12-01
12:41
Version 3.26.0 check-in: 7463317ee9 user: drh tags: trunk, release, version-3.26.0
2018-11-30
21:04
Fix documentation typos. check-in: 297fc5035b user: drh tags: trunk
2018-11-28
14:59
Update the speed-and-size spreadsheet with the latest performance numbers. check-in: 71c9a6d2b0 user: drh tags: trunk
Changes
Hide Diffs Side-by-Side Diffs Ignore Whitespace Patch

Changes to pages/affcase1.in.

    40     40   [http://www.libreoffice.org/|LibreOffice] on Linux and Windows.
    41     41   
    42     42   <p>
    43     43   An OpenDocument Presentation or "ODP" file is a
    44     44   [http://en.wikipedia.org/wiki/Zip_%28file_format%29|ZIP archive] containing
    45     45   XML files describing presentation slides and separate image files for the
    46     46   various images that are included as part of the presentation.
    47         -(OpenDocument word processor and spreedsheet files are similarly
           47  +(OpenDocument word processor and spreadsheet files are similarly
    48     48   structured but are not considered by this article.) The reader can
    49     49   easily see the content of an ODP file by using the "zip -l" command.
    50     50   For example, the following is the "zip -l" output from a 49-slide presentation
    51     51   about SQLite from the 2014
    52     52   <a href="http://southeastlinuxfest.org/">SouthEast LinuxFest</a>
    53     53   conference:
    54     54   

Changes to pages/changes.in.

    17     17   proc chng {date desc {options {}}} {
    18     18     global nChng aChng xrefChng
    19     19     set aChng($nChng) [list $date $desc $options]
    20     20     set xrefChng($date) $nChng
    21     21     incr nChng
    22     22   }
    23     23   
    24         -chng {2018-12-00 (3.26.0)} {
           24  +chng {2018-12-01 (3.26.0)} {
    25     25   <li>Optimization: When doing an [UPDATE] on a table with [indexes on expressions],
    26     26       do not update the expression indexes if they do not refer to any of the columns
    27     27       of the table being updated.
    28     28   <li>Allow the [xBestIndex()] method of [virtual table] implementations to return
    29     29       [SQLITE_CONSTRAINT] to indicate that the proposed query plan is unusable and
    30     30       should not be given further consideration.
    31     31   <li>Added the [SQLITE_DBCONFIG_DEFENSIVE] option which disables the ability to 

Changes to pages/codeofethics.in.

    10     10   filling in a box on "supplier registration" forms
    11     11   submitted to the SQLite developers by various minor clients.  However,
    12     12   we subsequently learned that "Code of Conduct" has a specific technical
    13     13   meaning within many software development communities, a meaning which
    14     14   was at odds with the intent of this document.  Hence, this document
    15     15   is now renamed and replaced by a 
    16     16   [Code of Conduct|Code of Conduct] that does comply with the
    17         -specific techical requirements was inserted in the place of
           17  +specific technical requirements was inserted in the place of
    18     18   the old name.
    19     19   
    20     20   <p>
    21     21   This document is still sometimes used as a "Code of Conduct" on supplier
    22     22   registration forms.  But it is not a Code of Conduct in the same sense
    23     23   that many communities mean a Code of Conduct.  Rather,
    24         -this document describes the foundational ethical principals upon
           24  +this document describes the ethical principals upon
    25     25   which SQLite is based.  Another way to look at this document is
    26     26   as a succinct description of the SQLite Founder's idea of what it
    27     27   means to be "virtuous".
    28     28   
    29     29   <p>
    30     30   Readers can also interpret this document as a primer on the
    31     31   world-view of the SQLite Founder, to help them better understand

Changes to pages/eqp.in.

    29     29   <li> Notes on the [optimizer | query optimizer].
    30     30   <li> How [indexing] works.
    31     31   <li> The [next generation query planner].
    32     32   </ul>
    33     33   
    34     34   <p>A query plan is represented as a tree.
    35     35   In raw form, as returned by [sqlite3_step()], each node of the tree
    36         -consists of four fields:  A integer node id, an integer parent id,
           36  +consists of four fields:  An integer node id, an integer parent id,
    37     37   an auxiliary integer field that is not currently used, and a description
    38     38   of the node.
    39     39   The entire tree is therefore a table with four columns and zero or more
    40     40   rows.
    41     41   The [command-line shell] will usually intercept this table and renders
    42     42   it as an ASCII-art graph for more convenient viewing.  To defeat the
    43     43   shells automatic graph rendering, simply include extra white space

Changes to pages/geopoly.in.

   122    122   overlaps the polygon in the $query_polygon parameter.  The
   123    123   geopoly_within() function works similarly, but only returns rows for
   124    124   which the _shape is completely contained within $query_polygon.
   125    125   
   126    126   <p>
   127    127   Queries (and also DELETE and UPDATE statements) in which the WHERE
   128    128   clause contains a bare geopoly_overlap() or geopoly_within() function
   129         -make use of the underly R*Tree data structures for a fast lookup that
          129  +make use of the underlying R*Tree data structures for a fast lookup that
   130    130   only has to examine a subset of the rows in the table.  The number of
   131    131   rows examines depends, of course, on the size of the $query_polygon.
   132    132   Large $query_polygons will normally need to look at more rows than small
   133    133   ones.
   134    134   
   135    135   <p>
   136    136   Queries against the rowid of a geopoly table are also very quick, even

Changes to pages/lang.in.

   161    161   
   162    162   <p>^Note also that when adding a [CHECK constraint], the CHECK constraint
   163    163   is not tested against preexisting rows of the table.
   164    164   ^This can result in a table that contains data that
   165    165   is in violation of the CHECK constraint.  Future versions of SQLite might
   166    166   change to validate CHECK constraints as they are added.</p>
   167    167   
   168         -<p>The ALTER TABLE command works by modifing the SQL text of the schema
          168  +<p>The ALTER TABLE command works by modifying the SQL text of the schema
   169    169   stored in the [sqlite_master table].
   170    170   No changes are made to table content.
   171    171   Because of this,
   172    172   the execution time of the ALTER TABLE command is independent of
   173    173   the amount of data in the table.  The ALTER TABLE command runs as quickly
   174    174   on a table with 10 million rows as it does on a table with 1 row.
   175    175   </p>
................................................................................
  3034   3034   so the date is normalized to 2001-05-01.  ^A similar effect occurs when
  3035   3035   the original date is February 29 of a leapyear and the modifier is
  3036   3036   &plusmn;N years where N is not a multiple of four.</p>
  3037   3037   
  3038   3038   <p>^The "start of" modifiers (7 through 9) shift the date backwards 
  3039   3039   to the beginning of the current month, year or day.</p>
  3040   3040   
  3041         -<p>^The "weekday" modifier advances the date forward, if necessary,
         3041  +<p>^(The "weekday" modifier advances the date forward, if necessary,
  3042   3042   to the next date where the weekday number is N. Sunday is 0, Monday is 1,
  3043         -and so forth.
         3043  +and so forth.)^
  3044   3044   ^If the date is already on the desired weekday, the "weekday" modifier
  3045   3045   leaves the date unchanged.  </p>
  3046   3046   
  3047   3047   <p>^The "unixepoch" modifier (11) only works if it immediately follows 
  3048   3048   a timestring in the DDDDDDDDDD format. 
  3049   3049   ^This modifier causes the DDDDDDDDDD to be interpreted not 
  3050   3050   as a Julian day number as it normally would be, but as

Changes to pages/news.in.

    12     12         {<a href="releaselog/\2_\3_\4.html">\0</a>} title
    13     13     }
    14     14     hd_puts "<h3>$date - $title</h3>"
    15     15     regsub -all "\n( *\n)+" $text "</p>\n\n<p>" txt
    16     16     hd_resolve "<blockquote>$txt</blockquote>"
    17     17     hd_puts "<hr width=\"50%\">"
    18     18   }
           19  +
           20  +newsitem {2018-12-01} {Release 3.26.0} {
           21  +SQLite [version 3.26.0] is a routine maintenance release with various
           22  +performance and feature enhancements.  See the
           23  +[version 3.26.0|release notes] for details.
           24  +}
    19     25   
    20     26   newsitem {2018-11-05} {Release 3.25.3} {
    21     27   SQLite [version 3.25.3] is a third patch against 3.25.0 that fixes various
    22     28   problems that have come to light and which seem serious enough to 
    23     29   justify a patch.
    24     30   }
    25     31   

Changes to pages/pragma.in.

   791    791       </ul>
   792    792       The default setting for this pragma is OFF, which means that all
   793    793       references to the table anywhere in the schema are converted to the new name.
   794    794       <p>This pragma is provided as a work-around for older programs that
   795    795       contain code that expect the incomplete behavior
   796    796       of ALTER TABLE RENAME found in older versions of SQLite.
   797    797       New applications should leave this flag turned off.
   798         -    <p>For compability with older [virtual table] implementations,
          798  +    <p>For compatibility with older [virtual table] implementations,
   799    799       this flag is turned on temporarily while the [sqlite3_module.xRename]
   800    800       method is being run.  The value of this flag is restore after the 
   801    801       [sqlite3_module.xRename] method finishes.
   802    802   }
   803    803   
   804    804   Pragma legacy_file_format {
   805    805      <p>^(<b>PRAGMA legacy_file_format;

Changes to pages/windowfunctions.in.

    12     12   
    13     13   <tcl>
    14     14   RecursiveBubbleDiagram window-function-invocation window-defn frame-spec filter
    15     15   </tcl>
    16     16   
    17     17   <p>Window functions are distinguished from ordinary SQL functions by the
    18     18   presence of an OVER clause.  If a function invocation has an OVER clause
    19         -then it is a window function, and if lacks a OVER clause it is an ordinary
           19  +then it is a window function, and if lacks an OVER clause it is an ordinary
    20     20   function.  Window functions might also have a FILTER
    21     21   clause in between the function and the OVER clause.
    22     22   
    23     23   <p>Unlike ordinary functions, window functions
    24     24   cannot use the DISTINCT keyword.
    25     25   Also, Window functions may only appear in the result set and in the
    26     26   ORDER BY clause of a SELECT statement.