Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Overview
Comment: | Miscellaneous documentation enhancements and cleanup. |
---|---|
Downloads: | Tarball | ZIP archive |
Timelines: | family | ancestors | descendants | both | trunk |
Files: | files | file ages | folders |
SHA1: |
31954ec1845d0231ff22bc76beb018f1 |
User & Date: | drh 2009-08-19 13:52:55.000 |
Context
2009-08-19
| ||
13:54 | Fix a typo in the documentation of INSERT. Ticket [e07f262a63441]. (check-in: 6fbc1f9707 user: drh tags: trunk) | |
13:52 | Miscellaneous documentation enhancements and cleanup. (check-in: 31954ec184 user: drh tags: trunk) | |
2009-08-14
| ||
18:43 | Update the documentation makefile to use mksqlite3h.tcl rather than trying to process sqlite.h.in on its own. (check-in: e982745da1 user: drh tags: trunk) | |
Changes
Changes to pages/capi3ref.in.
︙ | ︙ | |||
188 189 190 191 192 193 194 | regsub {^sqlite3_} $oldname {} name return $name.html } # Output HTML that displays the list $lx in $N columns # proc output_list {N lx} { | | > | | | 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 | regsub {^sqlite3_} $oldname {} name return $name.html } # Output HTML that displays the list $lx in $N columns # proc output_list {N lx} { hd_putsnl {<table width="100%" cellpadding="5"><tr>} set len [llength $lx] set n [expr {($len + $N - 1)/$N}] for {set i 0} {$i<$N} {incr i} { set start [expr {$i*$n}] set end [expr {($i+1)*$n}] hd_puts {<td valign="top"><ul>} for {set j $start} {$j<$end} {incr j} { set entry [lindex $lx $j] if {$entry!=""} { foreach {link label s} $entry break if {$s==1} { hd_resolve "<li>\[$link|$label\] " hd_resolve "\[experimental | <small><i>(exp)</i></small>\]</li>" } elseif {$s==2} { hd_resolve "<li>\[$link|$label\] " hd_resolve "\[deprecated | <small><i>(obs)</i></small>\]</li>" } else { hd_resolve "<li>\[$link|$label\]</li>" } hd_puts \n } } hd_putsnl {</ul></td>} } hd_putsnl {</tr></table>} } hd_open_aux c3ref/intro.html hd_header Introduction hd_enable_main 0 hd_keywords {capi3ref} </tcl> |
︙ | ︙ | |||
374 375 376 377 378 379 380 | lappend objlist [list $k $kw $s] } } } hd_open_aux c3ref/objlist.html hd_header {List Of SQLite Objects} hd_enable_main 0 | | | | | | | | 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 | lappend objlist [list $k $kw $s] } } } hd_open_aux c3ref/objlist.html hd_header {List Of SQLite Objects} hd_enable_main 0 hd_putsnl {<a href="intro.html"><h2>SQLite C Interface</h2></a>} hd_enable_main 1 </tcl> <h2>Objects:</h2> <p>Note: Objects marked with "[experimental | <small><i>exp</i></small>]" are [experimental] and objects marked with "[deprecated | <small><i>(obs)</i></small>]" are [deprecated].</p> <tcl> output_list 3 [lsort $objlist] hd_enable_main 0 hd_putsnl {<p>Other lists: <a href="constlist.html">Constants</a> and <a href="funclist.html">Functions</a>.} hd_close_aux hd_enable_main 1 hd_putsnl {<hr>} # Do a table of contents for constants # set clist {} foreach c $content { foreach {key title type keywords body code} $c break if {$type!="constant"} continue set keywords [lsort $keywords] set k [preferred_keyword $keywords] set s $supported($k) foreach kw $keywords { if {[regexp {^SQLITE_} $kw]} { lappend clist [list $k $kw $s] } } } hd_open_aux c3ref/constlist.html hd_header {List Of SQLite Constants} hd_enable_main 0 hd_putsnl {<a href="intro.html"><h2>SQLite C Interface</h2></a>} hd_enable_main 1 </tcl> <h2>Constants:</h2> <p>Note: Constants marked with "[experimental | <small><i>(exp)</i></small>]" are [experimental] and constants marked with "[deprecated | <small><i>(obs)</i></small>]" are [deprecated]</p> <tcl> set clist [lsort -index 1 $clist] output_list 2 $clist hd_enable_main 0 hd_putsnl {<p>Other lists: <a href="objlist.html">Objects</a> and <a href="funclist.html">Functions</a>.</p>} hd_enable_main 1 hd_close_aux hd_putsnl {<hr>} # Do a table of contents for functions # set funclist {} foreach c $content { foreach {key title type keywords body code} $c break |
︙ | ︙ | |||
447 448 449 450 451 452 453 | } } } hd_open_aux c3ref/funclist.html hd_header {List Of SQLite Functions} hd_keywords {capi3ref_funclist} hd_enable_main 0 | | | | | 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 | } } } hd_open_aux c3ref/funclist.html hd_header {List Of SQLite Functions} hd_keywords {capi3ref_funclist} hd_enable_main 0 hd_putsnl {<a href="intro.html"><h2>SQLite C Interface</h2></a>} hd_enable_main 1 </tcl> <h2>Functions:</h2> <p>Note: Functions marked with "[experimental | <small><i>(exp)</i></small>]" are [experimental] and functions marked with [deprecated | <small><i>(obs)</i></small>] are [deprecated].</p> <tcl> set funclist [lsort -index 1 $funclist] output_list 3 $funclist hd_enable_main 0 hd_putsnl {<p>Other lists: <a href="constlist.html">Constants</a> and <a href="objlist.html">Objects</a>.</p>} hd_enable_main 1 hd_close_aux hd_putsnl {<hr>} # Output all the records # foreach c [lsort $content] { foreach {key title type keywords body code} $c break set kw [preferred_keyword [lsort $keywords]] |
︙ | ︙ |
Changes to pages/docs.in.
1 2 | <title>SQLite Documentation</title> | | | | | > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 | <title>SQLite Documentation</title> <h2 align="center">Available Documentation</h2> <table width="100%" cellpadding="5"> <tcl> proc doc {name url desc} { hd_puts {<tr><td valign="top" align="right">} regsub -all { +} $name {\ } name hd_puts "<a href=\"$url\">$name</a></td>" hd_puts {<td width="10"></td>} hd_puts {<td valign="top" align="left">} hd_resolve $desc hd_puts {</td></tr>} } proc heading {text {caption {}}} { hd_puts {<tr><td colspan=3 style="padding: 3ex 0 2ex 0">} hd_puts "<b>$text</b>" if {$caption ne ""} { hd_puts {<br />} hd_puts "$caption" } } heading {Overview Documents} doc {Appropriate Uses For SQLite} {whentouse.html} { This document describes situations where SQLite is an appropriate database engine to use versus situations where a client/server database engine might be a better choice. } doc {Distinctive Features} {different.html} { |
︙ | ︙ | |||
101 102 103 104 105 106 107 | } doc {Sharing Cache Mode} {sharedcache.html} { Version 3.3.0 and later supports the ability for two or more database connections to share the same page and schema cache. This feature is useful for certain specialized applications. } doc {Unlock Notify} {unlock_notify.html} { | | | | 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 | } doc {Sharing Cache Mode} {sharedcache.html} { Version 3.3.0 and later supports the ability for two or more database connections to share the same page and schema cache. This feature is useful for certain specialized applications. } doc {Unlock Notify} {unlock_notify.html} { The "unlock notify" feature can be used in conjunction with [shared cache mode] to more efficiently manage resource conflict (database table locks). } doc {Asynchronous IO Mode} {asyncvfs.html} { This page describes the asynchronous IO extension developed alongside SQLite. Using asynchronous IO can cause SQLite to appear more responsive by delegating database writes to a background thread. } |
︙ | ︙ | |||
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 | doc {Release History} {changes.html} { A chronology of SQLite releases going back to version 1.0.0 } doc {Backwards Compatibility} {formatchng.html} { This document details all of the incompatible changes to the SQLite file format that have occurred since version 1.0.0. } heading {SQLite Technical/Design Documentation} doc {Temporary Files Used By SQLite} {tempfiles.html} { SQLite can potentially use many different temporary files when processing certain SQL statements. This document describes the many kinds of temporary files that SQLite uses and offers suggestions for avoiding them on systems where creating a temporary file is an expensive operation. } doc {How SQLite Implements Atomic Commit} {atomiccommit.html} { A description of the logic within SQLite that implements transactions with atomic commit, even in the face of power failures. } doc {Locking And Concurrency<br>In SQLite Version 3} {lockingv3.html} { A description of how the new locking code in version 3 increases concurrency and decreases the problem of writer starvation. } doc {Overview Of The Optimizer} {optoverview.html} { | > > > > > > > > > > > > > | 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 | doc {Release History} {changes.html} { A chronology of SQLite releases going back to version 1.0.0 } doc {Backwards Compatibility} {formatchng.html} { This document details all of the incompatible changes to the SQLite file format that have occurred since version 1.0.0. } doc {Private Branches} {privatebranch.html} { This document suggests procedures for maintaining a private branch or fork of SQLite and keeping that branch or fork in sync with the public SQLite source tree. } heading {SQLite Technical/Design Documentation} doc {Temporary Files Used By SQLite} {tempfiles.html} { SQLite can potentially use many different temporary files when processing certain SQL statements. This document describes the many kinds of temporary files that SQLite uses and offers suggestions for avoiding them on systems where creating a temporary file is an expensive operation. } doc {How SQLite Implements Atomic Commit} {atomiccommit.html} { A description of the logic within SQLite that implements transactions with atomic commit, even in the face of power failures. } doc {Dynamic Memory Allocation in SQLite} {malloc.html} { SQLite has a sophisticated memory allocation subsystem that can be configured and customized to meet memory usage requirements of the application and that is robust against out-of-memory conditions and leak-free. This document provides the details. } doc {Locking And Concurrency<br>In SQLite Version 3} {lockingv3.html} { A description of how the new locking code in version 3 increases concurrency and decreases the problem of writer starvation. } doc {Overview Of The Optimizer} {optoverview.html} { |
︙ | ︙ | |||
184 185 186 187 188 189 190 191 192 193 194 195 196 197 | doc {Compilation Options} {compile.html} { This document describes the compile time options that may be set to modify the default behavior of the library or omit optional features in order to reduce binary size. } heading {Old Documents} { These documents either pertain to SQLite version 2 or were written during the transition period between versions 2 and 3. They are no longer strictly applicable to recent versions of SQLite, but the information | > > > > > > | 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 | doc {Compilation Options} {compile.html} { This document describes the compile time options that may be set to modify the default behavior of the library or omit optional features in order to reduce binary size. } doc {Limits In SQLite} {limits.html} { This document describes limitations of SQLite (the maximum length of a string or blob, the maximum size of a database, the maximum number of tables in a database, etc.) and how these limits can be altered at compile-time and run-time. } heading {Old Documents} { These documents either pertain to SQLite version 2 or were written during the transition period between versions 2 and 3. They are no longer strictly applicable to recent versions of SQLite, but the information |
︙ | ︙ |
Changes to pages/malloc.in.
︙ | ︙ | |||
15 16 17 18 19 20 21 | use of SQLite for peak performance in demanding environments. Nothing in this document is required knowledge for using SQLite. The default settings and configuration for SQLite will work well in most applications. However, the information contained in this document may be useful to engineers who are tuning SQLite to comply with special requirements or to run under unusual circumstances.</p> | < < | | 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 | use of SQLite for peak performance in demanding environments. Nothing in this document is required knowledge for using SQLite. The default settings and configuration for SQLite will work well in most applications. However, the information contained in this document may be useful to engineers who are tuning SQLite to comply with special requirements or to run under unusual circumstances.</p> <a name="features"></a> <h2>1.0 Features</h2> <p>The SQLite core and its memory allocation subsystem provides the following capabilities:</p> <ul> <li><p> <b>Robust against allocation failures.</b> If a memory allocation ever fails (that is to say, if malloc() or realloc() ever return NULL) then SQLite will recover gracefully. SQLite will first attempt to free memory from unpinned cache pages then retry the allocation request. Failing that, SQLite will either stop what it is doing and return the [SQLITE_NOMEM] error code back up to the application or it will make do without the requested memory. </p></li> <li><p> <b>No memory leaks.</b> The application is responsible for destroying any objects it allocates. (For example, the application must use [sqlite3_finalize()] on every [prepared statement] and [sqlite3_close()] on every |
︙ | ︙ | |||
107 108 109 110 111 112 113 | </ul> <a name="testing"></a> <h2>2.0 Testing</h2> <p>Over | | | | 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 | </ul> <a name="testing"></a> <h2>2.0 Testing</h2> <p>Over 75% of the code in the SQLite source tree is devoted purely to [testing | testing and verification]. Reliability is important to SQLite. Among the tasks of the test infrastructure is to insure that SQLite does not misuse dynamically allocated memory, that SQLite does not leak memory, and that SQLite responds correctly to a dynamic memory allocation failure.</p> <p>The test infrastructure verifies that SQLite does not misuse dynamically allocated memory by using a specially instrumented |
︙ | ︙ | |||
184 185 186 187 188 189 190 | Note also that the OOM overlay can work with any underlying memory allocator, including the instrumented memory allocator that checks for memory allocation misuse. In this way it is verified that OOM errors do not induce other kinds of memory usage errors.</p> <p>Finally, we observe that the instrumented memory allocator and the memory leak detector both work over the entire SQLite test suite and | | > > | 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 | Note also that the OOM overlay can work with any underlying memory allocator, including the instrumented memory allocator that checks for memory allocation misuse. In this way it is verified that OOM errors do not induce other kinds of memory usage errors.</p> <p>Finally, we observe that the instrumented memory allocator and the memory leak detector both work over the entire SQLite test suite and the [TCL test suite] provides over 99% statement test coverage and that the [TH3] test harness provides [test coverage | 100% branch test coverage] with no leak leaks. This is strong evidence that dynamic memory allocation is used correctly everywhere within SQLite.</p> <a name="config"></a> <h2>3.0 Configuration</h2> <p>The default memory allocation settings in SQLite are appropriate |
︙ | ︙ |
Changes to pages/testing.in.
︙ | ︙ | |||
118 119 120 121 122 123 124 125 126 127 128 129 130 131 | core SQLite library. Each test harness is designed, maintained, and managed separately from the others. </p> <ol> <li><p> The <b>TCL Tests</b> are the oldest set of tests for SQLite. The TCL tests are contained in the same source tree as the SQLite core and like the SQLite core are in the public domain. The TCL tests are the primary tests used during development. The TCL tests are written using the <a href="http://www.tcl.tk/">TCL scripting language</a>. The TCL test harness itself consists of <tcl>KB {$stat(tclcSLOC)}</tcl> KSLOC | > | 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 | core SQLite library. Each test harness is designed, maintained, and managed separately from the others. </p> <ol> <li><p> <tcl>hd_fragment tcl {TCL test suite}</tcl> The <b>TCL Tests</b> are the oldest set of tests for SQLite. The TCL tests are contained in the same source tree as the SQLite core and like the SQLite core are in the public domain. The TCL tests are the primary tests used during development. The TCL tests are written using the <a href="http://www.tcl.tk/">TCL scripting language</a>. The TCL test harness itself consists of <tcl>KB {$stat(tclcSLOC)}</tcl> KSLOC |
︙ | ︙ |
Changes to wrap.tcl.
︙ | ︙ | |||
212 213 214 215 216 217 218 219 220 221 222 223 224 225 | if {[regexp {^http} $ref4]} continue if {$ref4==""} continue if {[regexp {\.html$} $ref4]} { lappend pagelink($ref4) $fn } } } # Enable or disable the main output file. # proc hd_enable_main {boolean} { global hd set hd(enable-main) $boolean } | > > > | 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 | if {[regexp {^http} $ref4]} continue if {$ref4==""} continue if {[regexp {\.html$} $ref4]} { lappend pagelink($ref4) $fn } } } proc hd_putsnl {text} { hd_puts $text\n } # Enable or disable the main output file. # proc hd_enable_main {boolean} { global hd set hd(enable-main) $boolean } |
︙ | ︙ | |||
630 631 632 633 634 635 636 | hd_puts "<a href=\"$ref\">$ref</a> " set prev $ref } hd_puts "</li>" } hd_puts "</ul>" hd_close_main | < | 633 634 635 636 637 638 639 | hd_puts "<a href=\"$ref\">$ref</a> " set prev $ref } hd_puts "</li>" } hd_puts "</ul>" hd_close_main |