/ Check-in [69055e9b]
Login

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

Overview
Comment:Documentation updates for the version info #defines and C interfaces.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: 69055e9b4cb6346e9e10fd9dd65e6ea06b959e76
User & Date: drh 2009-09-02 19:04:24
Context
2009-09-03
01:18
Do not reuse function parameters in subsequent expressions since the function call might have triggered a text encoding change. Fix for ticket [2ea2425d34be]. check-in: f22e3887 user: drh tags: trunk
2009-09-02
19:04
Documentation updates for the version info #defines and C interfaces. check-in: 69055e9b user: drh tags: trunk
2009-09-01
17:28
Fix a problem in main.c. SQLITE_NoRecTriggers -> SQLITE_RecTriggers. check-in: 5ac69ed6 user: dan tags: trunk
Changes
Hide Diffs Side-by-Side Diffs Ignore Whitespace Patch

Changes to src/sqlite.h.in.

    78     78   /*
    79     79   ** CAPI3REF: Compile-Time Library Version Numbers {H10010} <S60100>
    80     80   **
    81     81   ** The SQLITE_VERSION and SQLITE_VERSION_NUMBER #defines in
    82     82   ** the sqlite3.h file specify the version of SQLite with which
    83     83   ** that header file is associated.
    84     84   **
    85         -** The "version" of SQLite is a string of the form "X.Y.Z".
    86         -** The phrase "alpha" or "beta" might be appended after the Z.
    87         -** The X value is major version number always 3 in SQLite3.
    88         -** The X value only changes when backwards compatibility is
           85  +** The "version" of SQLite is a string of the form "W.X.Y" or "W.X.Y.Z".
           86  +** The W value is major version number and is always 3 in SQLite3.
           87  +** The W value only changes when backwards compatibility is
    89     88   ** broken and we intend to never break backwards compatibility.
    90         -** The Y value is the minor version number and only changes when
           89  +** The X value is the minor version number and only changes when
    91     90   ** there are major feature enhancements that are forwards compatible
    92     91   ** but not backwards compatible.
    93         -** The Z value is the release number and is incremented with
    94         -** each release but resets back to 0 whenever Y is incremented.
           92  +** The Y value is the release number and is incremented with
           93  +** each release but resets back to 0 whenever X is incremented.
           94  +** The Z value only appears on branch releases.
    95     95   **
    96     96   ** The SQLITE_VERSION_NUMBER is an integer that is computed as
    97     97   ** follows:
    98     98   **
    99     99   ** <blockquote><pre>
   100         -** SQLITE_VERSION_NUMBER = X*1000000 + Y*1000 + Z
          100  +** SQLITE_VERSION_NUMBER = W*1000000 + X*1000 + Y
   101    101   ** </pre></blockquote>
   102    102   **
   103    103   ** Since version 3.6.18, SQLite source code has been stored in the
   104    104   ** <a href="http://www.fossil-scm.org/">fossil configuration management
   105    105   ** system</a>.  The SQLITE_SOURCE_ID
   106    106   ** macro is a string which identifies a particular check-in of SQLite
   107    107   ** within its configuration management system.  The string contains the
   108    108   ** date and time of the check-in (UTC) and an SHA1 hash of the entire
   109    109   ** source tree.
   110    110   **
   111    111   ** See also: [sqlite3_libversion()],
   112         -** [sqlite3_libversion_number()], and [sqlite3_sourceid()].
          112  +** [sqlite3_libversion_number()], [sqlite3_sourceid()],
          113  +** [sqlite_version()] and [sqlite_source_id()].
   113    114   **
   114    115   ** Requirements: [H10011] [H10014]
   115    116   */
   116    117   #define SQLITE_VERSION        "--VERS--"
   117    118   #define SQLITE_VERSION_NUMBER --VERSION-NUMBER--
   118    119   #define SQLITE_SOURCE_ID      "--SOURCE-ID--"
   119    120   
................................................................................
   120    121   /*
   121    122   ** CAPI3REF: Run-Time Library Version Numbers {H10020} <S60100>
   122    123   ** KEYWORDS: sqlite3_version
   123    124   **
   124    125   ** These interfaces provide the same information as the [SQLITE_VERSION],
   125    126   ** [SQLITE_VERSION_NUMBER], and [SQLITE_SOURCE_ID] #defines in the header,
   126    127   ** but are associated with the library instead of the header file.  Cautious
   127         -** programmers might include an assert in their application to verify that
   128         -** sqlite3_libversion_number() always returns the value
   129         -** [SQLITE_VERSION_NUMBER] and thus insure that the application is
          128  +** programmers might include assert() statements in their application to
          129  +** verify that values returned by these interfaces match the macros in
          130  +** the header, and thus insure that the application is
   130    131   ** compiled with matching library and header files.
   131    132   **
   132    133   ** <blockquote><pre>
   133    134   ** assert( sqlite3_libversion_number()==SQLITE_VERSION_NUMBER );
          135  +** assert( strcmp(sqlite3_sourceid(),SQLITE_SOURCE_ID)==0 );
          136  +** assert( strcmp(sqlite3_libversion,SQLITE_VERSION)==0 );
   134    137   ** </pre></blockquote>
   135    138   **
   136    139   ** The sqlite3_libversion() function returns the same information as is
   137    140   ** in the sqlite3_version[] string constant.  The function is provided
   138    141   ** for use in DLLs since DLL users usually do not have direct access to string
   139    142   ** constants within the DLL.  Similarly, the sqlite3_sourceid() function
   140    143   ** returns the same information as is in the [SQLITE_SOURCE_ID] #define of
   141    144   ** the header file.
          145  +**
          146  +** See also: [sqlite_version()] and [sqlite_source_id()].
   142    147   **
   143    148   ** Requirements: [H10021] [H10022] [H10023]
   144    149   */
   145    150   SQLITE_EXTERN const char sqlite3_version[];
   146    151   const char *sqlite3_libversion(void);
   147    152   const char *sqlite3_sourceid(void);
   148    153   int sqlite3_libversion_number(void);