Documentation Source Text

Check-in [c7671e4258]
Login

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

Overview
Comment:Add a brief comment describing what the toc.db build logic is used for and why it is important.
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: c7671e42587e305f87b314a2507765af8cbea4c1
User & Date: drh 2015-04-10 14:39:35
Context
2015-04-13
10:21
Fix a typo on the quickstart page. check-in: 80577829a2 user: drh tags: trunk
2015-04-10
14:39
Add a brief comment describing what the toc.db build logic is used for and why it is important. check-in: c7671e4258 user: drh tags: trunk
14:08
Generate the "toc.db" database containing all interfaces with links to their documentation. check-in: 5f5f7776fc user: drh tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Changes to pages/capi3ref.in.

360
361
362
363
364
365
366







367
368
369
370
371
372
373
be removed in some future release.</li>
</ul>

<tcl>
hd_close_aux
hd_puts {<hr>}








sqlite3 dbtoc doc/toc.db
dbtoc eval {
BEGIN;
DROP TABLE IF EXISTS toc;
CREATE TABLE toc(
  name TEXT,  -- Name of interface
  type TEXT,  -- 'object', 'constant', or 'function'







>
>
>
>
>
>
>







360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
be removed in some future release.</li>
</ul>

<tcl>
hd_close_aux
hd_puts {<hr>}

# The toc.db database file in the root directory of the document tree
# contains information about documentation for all C-API elements.  This
# database is used by third-party wrappers (ex: python) when building
# their own documentation, in order to provide links back to the
# canonical SQLite documentation.  Changing this table will break the
# build on those third-party systems.
#
sqlite3 dbtoc doc/toc.db
dbtoc eval {
BEGIN;
DROP TABLE IF EXISTS toc;
CREATE TABLE toc(
  name TEXT,  -- Name of interface
  type TEXT,  -- 'object', 'constant', or 'function'