Documentation Source Text

Hex Artifact Content
Login

Artifact bfac4cfaac7e998a463611e82989ea4a50f06b43:


0000: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
0010: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
0020: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
0030: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
0040: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 0a  ###############.
0050: 23 20 54 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20  # The following 
0060: 6d 61 63 72 6f 73 20 73 68 6f 75 6c 64 20 62 65  macros should be
0070: 20 64 65 66 69 6e 65 64 20 62 65 66 6f 72 65 20   defined before 
0080: 74 68 69 73 20 73 63 72 69 70 74 20 69 73 0a 23  this script is.#
0090: 20 69 6e 76 6f 6b 65 64 3a 0a 23 0a 23 20 44 4f   invoked:.#.# DO
00a0: 43 20 20 20 20 20 20 20 20 20 20 20 20 20 20 54  C              T
00b0: 68 65 20 74 6f 70 6c 65 76 65 6c 20 64 69 72 65  he toplevel dire
00c0: 63 74 6f 72 79 20 6f 66 20 74 68 65 20 64 6f 63  ctory of the doc
00d0: 75 6d 65 6e 74 61 74 69 6f 6e 20 73 6f 75 72 63  umentation sourc
00e0: 65 20 74 72 65 65 2e 0a 23 0a 23 20 53 52 43 20  e tree..#.# SRC 
00f0: 20 20 20 20 20 20 20 20 20 20 20 20 20 54 68 65               The
0100: 20 74 6f 70 6c 65 76 65 6c 20 64 69 72 65 63 74   toplevel direct
0110: 6f 72 79 20 6f 66 20 74 68 65 20 73 6f 75 72 63  ory of the sourc
0120: 65 20 63 6f 64 65 20 73 6f 75 72 63 65 20 74 72  e code source tr
0130: 65 65 2e 0a 23 0a 23 20 54 43 4c 53 51 4c 49 54  ee..#.# TCLSQLIT
0140: 45 33 43 20 20 20 20 20 20 4e 61 6d 65 20 6f 66  E3C      Name of
0150: 20 74 68 65 20 61 6d 61 6c 67 61 6d 61 74 69 6f   the amalgamatio
0160: 6e 20 73 6f 75 72 63 65 20 66 69 6c 65 0a 23 0a  n source file.#.
0170: 23 20 54 48 33 20 20 20 20 20 20 20 20 20 20 20  # TH3           
0180: 20 20 20 54 68 65 20 74 6f 70 6c 65 76 65 6c 20     The toplevel 
0190: 64 69 72 65 63 74 6f 72 79 20 66 6f 72 20 54 48  directory for TH
01a0: 33 2e 20 20 4d 61 79 20 62 65 20 61 6e 20 65 6d  3.  May be an em
01b0: 70 74 79 20 73 74 72 69 6e 67 2e 0a 23 0a 23 20  pty string..#.# 
01c0: 53 4c 54 20 20 20 20 20 20 20 20 20 20 20 20 20  SLT             
01d0: 20 54 68 65 20 74 6f 70 6c 65 76 65 6c 20 64 69   The toplevel di
01e0: 72 65 63 74 6f 72 79 20 66 6f 72 20 53 51 4c 4c  rectory for SQLL
01f0: 6f 67 69 63 54 65 73 74 2e 20 20 4d 61 79 20 62  ogicTest.  May b
0200: 65 20 61 6e 0a 23 20 20 20 20 20 20 20 20 20 20  e an.#          
0210: 20 20 20 20 20 20 20 20 65 6d 70 74 79 20 73 74          empty st
0220: 72 69 6e 67 0a 23 0a 23 20 54 43 4c 46 4c 41 47  ring.#.# TCLFLAG
0230: 53 20 20 20 20 20 20 20 20 20 45 78 74 72 61 20  S         Extra 
0240: 43 2d 63 6f 6d 70 69 6c 65 72 20 6f 70 74 69 6f  C-compiler optio
0250: 6e 73 20 6e 65 65 64 65 64 20 74 6f 20 6c 69 6e  ns needed to lin
0260: 6b 20 61 67 61 69 6e 73 74 20 54 43 4c 0a 23 0a  k against TCL.#.
0270: 23 20 54 43 4c 53 54 55 42 46 4c 41 47 53 20 20  # TCLSTUBFLAGS  
0280: 20 20 20 45 78 74 72 61 20 43 2d 63 6f 6d 70 69     Extra C-compi
0290: 6c 65 72 20 6f 70 74 69 6f 6e 73 20 6e 65 65 64  ler options need
02a0: 65 64 20 74 6f 20 6c 69 6e 6b 20 61 20 54 43 4c  ed to link a TCL
02b0: 20 65 78 74 65 6e 73 69 6f 6e 0a 23 0a 23 20 4e   extension.#.# N
02c0: 41 57 4b 20 20 20 20 20 20 20 20 20 20 20 20 20  AWK             
02d0: 4e 61 77 6b 20 63 6f 6d 70 61 74 69 62 6c 65 20  Nawk compatible 
02e0: 61 77 6b 20 70 72 6f 67 72 61 6d 2e 20 20 4f 6c  awk program.  Ol
02f0: 64 65 72 20 28 6f 62 73 6f 6c 65 74 65 3f 29 20  der (obsolete?) 
0300: 73 6f 6c 61 72 69 73 0a 23 20 20 20 20 20 20 20  solaris.#       
0310: 20 20 20 20 20 20 20 20 20 20 20 73 79 73 74 65             syste
0320: 6d 73 20 6e 65 65 64 20 74 68 69 73 20 74 6f 20  ms need this to 
0330: 61 76 6f 69 64 20 75 73 69 6e 67 20 74 68 65 20  avoid using the 
0340: 6f 72 69 67 69 6e 61 6c 20 41 54 26 54 20 41 57  original AT&T AW
0350: 4b 2e 0a 23 0a 23 20 43 43 20 20 20 20 20 20 20  K..#.# CC       
0360: 20 20 20 20 20 20 20 20 41 20 43 2d 63 6f 6d 70          A C-comp
0370: 69 6c 65 72 20 61 6e 64 20 61 72 67 75 6d 65 6e  iler and argumen
0380: 74 73 20 66 6f 72 20 62 75 69 6c 64 69 6e 67 20  ts for building 
0390: 75 74 69 6c 69 74 79 20 70 72 6f 67 72 61 6d 73  utility programs
03a0: 0a 23 0a 23 20 4f 6e 63 65 20 74 68 65 20 6d 61  .#.# Once the ma
03b0: 63 72 6f 73 20 61 62 6f 76 65 20 61 72 65 20 64  cros above are d
03c0: 65 66 69 6e 65 64 2c 20 74 68 65 20 72 65 73 74  efined, the rest
03d0: 20 6f 66 20 74 68 69 73 20 6d 61 6b 65 20 73 63   of this make sc
03e0: 72 69 70 74 20 77 69 6c 6c 0a 23 20 62 75 69 6c  ript will.# buil
03f0: 64 20 74 68 65 20 53 51 4c 69 74 65 20 6c 69 62  d the SQLite lib
0400: 72 61 72 79 20 61 6e 64 20 74 65 73 74 69 6e 67  rary and testing
0410: 20 74 6f 6f 6c 73 2e 0a 23 23 23 23 23 23 23 23   tools..########
0420: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
0430: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
0440: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
0450: 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23 23  ################
0460: 23 23 23 23 23 23 23 23 0a 0a 54 43 4c 53 48 20  ########..TCLSH 
0470: 3d 20 74 63 6c 73 68 2e 64 6f 63 73 72 63 0a 0a  = tclsh.docsrc..
0480: 64 65 66 61 75 6c 74 3a 09 0a 09 40 65 63 68 6f  default:...@echo
0490: 20 27 6d 61 6b 65 20 62 61 73 65 3b 20 20 20 20   'make base;    
04a0: 20 20 20 23 20 42 75 69 6c 64 20 62 61 73 65 20     # Build base 
04b0: 64 6f 63 75 6d 65 6e 74 73 27 0a 09 40 65 63 68  documents'..@ech
04c0: 6f 20 27 6d 61 6b 65 20 65 76 69 64 65 6e 63 65  o 'make evidence
04d0: 3b 20 20 20 23 20 47 61 74 68 65 72 20 65 76 69  ;   # Gather evi
04e0: 64 65 6e 63 65 20 6d 61 72 6b 73 27 0a 09 40 65  dence marks'..@e
04f0: 63 68 6f 20 27 6d 61 6b 65 20 6d 61 74 72 69 78  cho 'make matrix
0500: 3b 20 20 20 20 20 23 20 42 75 69 6c 64 20 74 68  ;     # Build th
0510: 65 20 74 72 61 63 65 61 62 69 6c 69 74 79 20 6d  e traceability m
0520: 61 74 72 69 78 27 0a 09 40 65 63 68 6f 20 27 6d  atrix'..@echo 'm
0530: 61 6b 65 20 61 6c 6c 3b 20 20 20 20 20 20 20 20  ake all;        
0540: 23 20 44 6f 20 61 6c 6c 20 6f 66 20 74 68 65 20  # Do all of the 
0550: 61 62 6f 76 65 27 0a 09 40 65 63 68 6f 20 27 6d  above'..@echo 'm
0560: 61 6b 65 20 73 70 65 6c 6c 3b 20 20 20 20 20 20  ake spell;      
0570: 23 20 53 70 65 6c 6c 20 63 68 65 63 6b 20 67 65  # Spell check ge
0580: 6e 65 72 61 74 65 64 20 64 6f 63 73 27 0a 09 40  nerated docs'..@
0590: 65 63 68 6f 20 27 6d 61 6b 65 20 73 65 61 72 63  echo 'make searc
05a0: 68 64 62 3b 20 20 20 23 20 43 6f 6e 73 74 72 75  hdb;   # Constru
05b0: 63 74 20 74 68 65 20 46 54 53 20 73 65 61 72 63  ct the FTS searc
05c0: 68 20 64 61 74 61 62 61 73 65 27 0a 09 40 65 63  h database'..@ec
05d0: 68 6f 20 27 6d 61 6b 65 20 66 61 73 74 3b 20 20  ho 'make fast;  
05e0: 20 20 20 20 20 23 20 42 75 69 6c 64 20 64 6f 63       # Build doc
05f0: 75 6d 65 6e 74 61 74 69 6f 6e 20 6f 6e 6c 79 20  umentation only 
0600: 2d 20 6e 6f 20 72 65 71 75 69 72 65 6d 65 6e 74  - no requirement
0610: 73 27 0a 09 40 65 63 68 6f 20 27 6d 61 6b 65 20  s'..@echo 'make 
0620: 73 63 68 65 6d 61 3b 20 20 20 20 20 23 20 52 75  schema;     # Ru
0630: 6e 20 6f 6e 63 65 20 74 6f 20 69 6e 69 74 69 61  n once to initia
0640: 6c 69 7a 65 20 74 68 65 20 62 75 69 6c 64 20 70  lize the build p
0650: 72 6f 63 65 73 73 27 0a 0a 61 6c 6c 3a 09 62 61  rocess'..all:.ba
0660: 73 65 20 65 76 69 64 65 6e 63 65 20 66 6f 72 6d  se evidence form
0670: 61 74 5f 65 76 69 64 65 6e 63 65 20 6d 61 74 72  at_evidence matr
0680: 69 78 20 64 6f 63 0a 0a 70 72 69 76 61 74 65 3a  ix doc..private:
0690: 09 62 61 73 65 20 65 76 69 64 65 6e 63 65 20 70  .base evidence p
06a0: 72 69 76 61 74 65 5f 65 76 69 64 65 6e 63 65 20  rivate_evidence 
06b0: 6d 61 74 72 69 78 20 64 6f 63 0a 0a 66 61 73 74  matrix doc..fast
06c0: 3a 09 62 61 73 65 20 64 6f 63 0a 0a 73 71 6c 69  :.base doc..sqli
06d0: 74 65 33 2e 68 3a 20 24 28 54 43 4c 53 48 29 20  te3.h: $(TCLSH) 
06e0: 24 28 53 52 43 29 2f 73 72 63 2f 73 71 6c 69 74  $(SRC)/src/sqlit
06f0: 65 2e 68 2e 69 6e 20 24 28 53 52 43 29 2f 6d 61  e.h.in $(SRC)/ma
0700: 6e 69 66 65 73 74 2e 75 75 69 64 20 24 28 53 52  nifest.uuid $(SR
0710: 43 29 2f 56 45 52 53 49 4f 4e 0a 09 2e 2f 24 28  C)/VERSION.../$(
0720: 54 43 4c 53 48 29 20 24 28 53 52 43 29 2f 74 6f  TCLSH) $(SRC)/to
0730: 6f 6c 2f 6d 6b 73 71 6c 69 74 65 33 68 2e 74 63  ol/mksqlite3h.tc
0740: 6c 20 24 28 53 52 43 29 20 7c 20 5c 0a 09 73 65  l $(SRC) | \..se
0750: 64 20 27 73 2f 5e 53 51 4c 49 54 45 5f 41 50 49  d 's/^SQLITE_API
0760: 20 2f 2f 27 20 3e 73 71 6c 69 74 65 33 2e 68 0a   //' >sqlite3.h.
0770: 0a 23 20 47 65 6e 65 72 61 74 65 20 74 68 65 20  .# Generate the 
0780: 64 69 72 65 63 74 6f 72 79 20 69 6e 74 6f 20 77  directory into w
0790: 68 69 63 68 20 67 65 6e 65 72 61 74 65 64 20 64  hich generated d
07a0: 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 66 69 6c  ocumentation fil
07b0: 65 73 20 77 69 6c 6c 0a 23 20 62 65 20 77 72 69  es will.# be wri
07c0: 74 74 65 6e 2e 0a 23 0a 64 6f 63 64 69 72 3a 0a  tten..#.docdir:.
07d0: 09 6d 6b 64 69 72 20 2d 70 20 64 6f 63 20 64 6f  .mkdir -p doc do
07e0: 63 2f 63 33 72 65 66 20 64 6f 63 2f 6d 61 74 72  c/c3ref doc/matr
07f0: 69 78 20 64 6f 63 2f 6d 61 74 72 69 78 2f 63 33  ix doc/matrix/c3
0800: 72 65 66 20 64 6f 63 2f 6d 61 74 72 69 78 2f 73  ref doc/matrix/s
0810: 79 6e 74 61 78 0a 0a 23 20 54 68 69 73 20 72 75  yntax..# This ru
0820: 6c 65 20 67 65 6e 65 72 61 74 65 73 20 61 6c 6c  le generates all
0830: 20 64 6f 63 75 6d 65 6e 74 69 6f 6e 20 66 69 6c   documention fil
0840: 65 73 20 66 72 6f 6d 20 74 68 65 69 72 20 73 6f  es from their so
0850: 75 72 63 65 73 2e 20 20 54 68 65 0a 23 20 73 70  urces.  The.# sp
0860: 65 63 69 61 6c 20 6d 61 72 6b 75 70 20 6f 6e 20  ecial markup on 
0870: 48 54 4d 4c 20 66 69 6c 65 73 20 75 73 65 64 20  HTML files used 
0880: 74 6f 20 69 64 65 6e 74 69 66 79 20 74 65 73 74  to identify test
0890: 61 62 6c 65 20 73 74 61 74 65 6d 65 6e 74 73 20  able statements 
08a0: 61 6e 64 0a 23 20 72 65 71 75 69 72 65 6d 65 6e  and.# requiremen
08b0: 74 73 20 61 72 65 20 72 65 74 61 69 6e 65 64 20  ts are retained 
08c0: 69 6e 20 74 68 65 20 48 54 4d 4c 20 61 6e 64 20  in the HTML and 
08d0: 73 6f 20 74 68 65 20 48 54 4d 4c 20 67 65 6e 65  so the HTML gene
08e0: 72 61 74 65 64 20 62 79 0a 23 20 74 68 69 73 20  rated by.# this 
08f0: 72 75 6c 65 20 69 73 20 6e 6f 74 20 73 75 69 74  rule is not suit
0900: 61 62 6c 65 20 66 6f 72 20 70 75 62 6c 69 63 61  able for publica
0910: 74 69 6f 6e 2e 20 20 54 68 69 73 20 69 73 20 74  tion.  This is t
0920: 68 65 20 66 69 72 73 74 20 73 74 65 70 0a 23 20  he first step.# 
0930: 6f 6e 6c 79 2e 0a 23 0a 62 61 73 65 3a 09 24 28  only..#.base:.$(
0940: 54 43 4c 53 48 29 20 73 71 6c 69 74 65 33 2e 68  TCLSH) sqlite3.h
0950: 20 64 6f 63 64 69 72 20 61 6c 77 61 79 73 20 0a   docdir always .
0960: 09 72 6d 20 2d 72 66 20 64 6f 63 2f 69 6d 61 67  .rm -rf doc/imag
0970: 65 73 0a 09 63 70 20 2d 72 20 24 28 44 4f 43 29  es..cp -r $(DOC)
0980: 2f 69 6d 61 67 65 73 20 64 6f 63 0a 09 6d 6b 64  /images doc..mkd
0990: 69 72 20 64 6f 63 2f 69 6d 61 67 65 73 2f 73 79  ir doc/images/sy
09a0: 6e 74 61 78 0a 09 63 70 20 24 28 44 4f 43 29 2f  ntax..cp $(DOC)/
09b0: 61 72 74 2f 73 79 6e 74 61 78 2f 2a 2e 67 69 66  art/syntax/*.gif
09c0: 20 64 6f 63 2f 69 6d 61 67 65 73 2f 73 79 6e 74   doc/images/synt
09d0: 61 78 0a 09 63 70 20 24 28 44 4f 43 29 2f 72 61  ax..cp $(DOC)/ra
09e0: 77 70 61 67 65 73 2f 2a 20 64 6f 63 0a 09 2e 2f  wpages/* doc.../
09f0: 24 28 54 43 4c 53 48 29 20 24 28 44 4f 43 29 2f  $(TCLSH) $(DOC)/
0a00: 77 72 61 70 2e 74 63 6c 20 24 28 44 4f 43 29 20  wrap.tcl $(DOC) 
0a10: 24 28 53 52 43 29 20 64 6f 63 20 24 28 44 4f 43  $(SRC) doc $(DOC
0a20: 29 2f 70 61 67 65 73 2f 2a 2e 69 6e 0a 09 63 70  )/pages/*.in..cp
0a30: 20 64 6f 63 2f 66 69 6c 65 66 6f 72 6d 61 74 32   doc/fileformat2
0a40: 2e 68 74 6d 6c 20 64 6f 63 2f 66 69 6c 65 66 6f  .html doc/filefo
0a50: 72 6d 61 74 2e 68 74 6d 6c 0a 0a 23 20 53 74 72  rmat.html..# Str
0a60: 69 70 20 74 68 65 20 73 70 65 63 69 61 6c 20 6d  ip the special m
0a70: 61 72 6b 75 70 20 69 6e 20 48 54 4d 4c 20 66 69  arkup in HTML fi
0a80: 6c 65 73 20 74 68 61 74 20 69 64 65 6e 74 69 66  les that identif
0a90: 69 65 73 20 74 65 73 74 61 62 6c 65 20 73 74 61  ies testable sta
0aa0: 74 65 6d 65 6e 74 73 0a 23 20 61 6e 64 20 72 65  tements.# and re
0ab0: 71 75 69 72 65 6d 65 6e 74 73 2e 0a 23 0a 64 6f  quirements..#.do
0ac0: 63 3a 09 61 6c 77 61 79 73 20 24 28 44 4f 43 29  c:.always $(DOC)
0ad0: 2f 72 65 6d 6f 76 65 5f 63 61 72 65 74 73 2e 73  /remove_carets.s
0ae0: 68 0a 09 73 68 20 24 28 44 4f 43 29 2f 72 65 6d  h..sh $(DOC)/rem
0af0: 6f 76 65 5f 63 61 72 65 74 73 2e 73 68 20 64 6f  ove_carets.sh do
0b00: 63 0a 0a 23 20 53 70 65 6c 6c 20 63 68 65 63 6b  c..# Spell check
0b10: 20 67 65 6e 65 72 61 74 65 64 20 64 6f 63 73 2e   generated docs.
0b20: 0a 23 0a 73 70 65 6c 6c 3a 20 24 28 44 4f 43 29  .#.spell: $(DOC)
0b30: 2f 73 70 65 6c 6c 5f 63 68 6b 2e 73 68 20 24 28  /spell_chk.sh $(
0b40: 44 4f 43 29 2f 63 75 73 74 6f 6d 2e 74 78 74 0a  DOC)/custom.txt.
0b50: 09 73 68 20 24 28 44 4f 43 29 2f 73 70 65 6c 6c  .sh $(DOC)/spell
0b60: 5f 63 68 6b 2e 73 68 20 64 6f 63 20 27 2a 2e 68  _chk.sh doc '*.h
0b70: 74 6d 6c 27 20 24 28 44 4f 43 29 2f 63 75 73 74  tml' $(DOC)/cust
0b80: 6f 6d 2e 74 78 74 0a 0a 23 20 43 6f 6e 73 74 72  om.txt..# Constr
0b90: 75 63 74 20 74 68 65 20 64 61 74 61 62 61 73 65  uct the database
0ba0: 20 73 63 68 65 6d 61 2e 0a 23 0a 73 63 68 65 6d   schema..#.schem
0bb0: 61 3a 09 24 28 54 43 4c 53 48 29 0a 09 2e 2f 24  a:.$(TCLSH).../$
0bc0: 28 54 43 4c 53 48 29 20 24 28 44 4f 43 29 2f 73  (TCLSH) $(DOC)/s
0bd0: 63 68 65 6d 61 2e 74 63 6c 0a 0a 23 20 54 68 65  chema.tcl..# The
0be0: 20 66 6f 6c 6c 6f 77 69 6e 67 20 72 75 6c 65 20   following rule 
0bf0: 73 63 61 6e 73 20 73 71 6c 69 74 65 33 2e 63 20  scans sqlite3.c 
0c00: 73 6f 75 72 63 65 20 74 65 78 74 2c 20 74 68 65  source text, the
0c10: 20 74 65 78 74 20 6f 66 20 74 68 65 20 54 43 4c   text of the TCL
0c20: 0a 23 20 74 65 73 74 20 63 61 73 65 73 2c 20 61  .# test cases, a
0c30: 6e 64 20 28 6f 70 74 69 6f 6e 61 6c 6c 79 29 20  nd (optionally) 
0c40: 74 68 65 20 54 48 33 20 74 65 73 74 20 63 61 73  the TH3 test cas
0c50: 65 20 73 6f 75 72 63 65 73 20 6c 6f 6f 6b 69 6e  e sources lookin
0c60: 67 20 66 6f 72 0a 23 20 63 6f 6d 6d 65 6e 74 73  g for.# comments
0c70: 20 74 68 61 74 20 69 64 65 6e 74 69 66 79 20 61   that identify a
0c80: 73 73 65 72 74 69 6f 6e 73 20 61 6e 64 20 74 65  ssertions and te
0c90: 73 74 20 63 61 73 65 73 20 74 68 61 74 20 70 72  st cases that pr
0ca0: 6f 76 69 64 65 20 65 76 69 64 65 6e 63 65 0a 23  ovide evidence.#
0cb0: 20 74 68 61 74 20 53 51 4c 69 74 65 20 62 65 68   that SQLite beh
0cc0: 61 76 65 73 20 61 73 20 69 74 20 73 61 79 73 20  aves as it says 
0cd0: 69 74 20 64 6f 65 73 2e 20 20 53 65 65 20 74 68  it does.  See th
0ce0: 65 20 63 6f 6d 6d 65 6e 74 73 20 69 6e 20 0a 23  e comments in .#
0cf0: 20 73 63 61 6e 5f 74 65 73 74 5f 63 61 73 65 73   scan_test_cases
0d00: 2e 74 63 6c 20 66 6f 72 20 61 64 64 69 74 69 6f  .tcl for additio
0d10: 6e 61 6c 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 2e  nal information.
0d20: 0a 23 0a 23 20 54 68 65 20 6f 75 74 70 75 74 20  .#.# The output 
0d30: 66 69 6c 65 20 65 76 69 64 65 6e 63 65 2e 74 78  file evidence.tx
0d40: 74 20 69 73 20 75 73 65 64 20 62 79 20 72 65 71  t is used by req
0d50: 75 69 72 65 6d 65 6e 74 73 20 63 6f 76 65 72 61  uirements covera
0d60: 67 65 20 61 6e 61 6c 79 73 69 73 2e 0a 23 0a 53  ge analysis..#.S
0d70: 43 41 4e 4e 45 52 20 3d 20 24 28 44 4f 43 29 2f  CANNER = $(DOC)/
0d80: 73 63 61 6e 5f 74 65 73 74 5f 63 61 73 65 73 2e  scan_test_cases.
0d90: 74 63 6c 0a 0a 65 76 69 64 65 6e 63 65 3a 09 24  tcl..evidence:.$
0da0: 28 54 43 4c 53 48 29 0a 09 2e 2f 24 28 54 43 4c  (TCLSH).../$(TCL
0db0: 53 48 29 20 24 28 53 43 41 4e 4e 45 52 29 20 2d  SH) $(SCANNER) -
0dc0: 72 65 73 65 74 20 73 72 63 20 24 28 53 52 43 29  reset src $(SRC)
0dd0: 2f 73 72 63 2f 2a 2e 5b 63 68 79 5d 0a 09 2e 2f  /src/*.[chy].../
0de0: 24 28 54 43 4c 53 48 29 20 24 28 53 43 41 4e 4e  $(TCLSH) $(SCANN
0df0: 45 52 29 20 73 72 63 20 24 28 53 52 43 29 2f 65  ER) src $(SRC)/e
0e00: 78 74 2f 66 74 73 33 2f 2a 2e 5b 63 68 5d 0a 09  xt/fts3/*.[ch]..
0e10: 2e 2f 24 28 54 43 4c 53 48 29 20 24 28 53 43 41  ./$(TCLSH) $(SCA
0e20: 4e 4e 45 52 29 20 73 72 63 20 24 28 53 52 43 29  NNER) src $(SRC)
0e30: 2f 65 78 74 2f 72 74 72 65 65 2f 2a 2e 5b 63 68  /ext/rtree/*.[ch
0e40: 5d 0a 09 2e 2f 24 28 54 43 4c 53 48 29 20 24 28  ].../$(TCLSH) $(
0e50: 53 43 41 4e 4e 45 52 29 20 74 63 6c 20 24 28 53  SCANNER) tcl $(S
0e60: 52 43 29 2f 74 65 73 74 2f 2a 2e 74 65 73 74 0a  RC)/test/*.test.
0e70: 09 69 66 20 74 65 73 74 20 27 27 20 21 3d 20 27  .if test '' != '
0e80: 24 28 54 48 33 29 27 3b 20 74 68 65 6e 20 5c 0a  $(TH3)'; then \.
0e90: 09 20 20 2e 2f 24 28 54 43 4c 53 48 29 20 24 28  .  ./$(TCLSH) $(
0ea0: 53 43 41 4e 4e 45 52 29 20 74 68 33 20 24 28 54  SCANNER) th3 $(T
0eb0: 48 33 29 2f 6d 6b 74 68 33 2e 74 63 6c 3b 20 5c  H3)/mkth3.tcl; \
0ec0: 0a 09 20 20 2e 2f 24 28 54 43 4c 53 48 29 20 24  ..  ./$(TCLSH) $
0ed0: 28 53 43 41 4e 4e 45 52 29 20 74 68 33 20 24 28  (SCANNER) th3 $(
0ee0: 54 48 33 29 2f 62 61 73 65 2f 2a 2e 63 3b 20 5c  TH3)/base/*.c; \
0ef0: 0a 09 20 20 2e 2f 24 28 54 43 4c 53 48 29 20 24  ..  ./$(TCLSH) $
0f00: 28 53 43 41 4e 4e 45 52 29 20 74 68 33 2f 72 65  (SCANNER) th3/re
0f10: 71 31 20 24 28 54 48 33 29 2f 72 65 71 31 2f 2a  q1 $(TH3)/req1/*
0f20: 2e 74 65 73 74 3b 20 5c 0a 09 20 20 2e 2f 24 28  .test; \..  ./$(
0f30: 54 43 4c 53 48 29 20 24 28 53 43 41 4e 4e 45 52  TCLSH) $(SCANNER
0f40: 29 20 74 68 33 2f 63 6f 76 31 20 24 28 54 48 33  ) th3/cov1 $(TH3
0f50: 29 2f 63 6f 76 31 2f 2a 2e 74 65 73 74 3b 20 5c  )/cov1/*.test; \
0f60: 0a 09 20 20 2e 2f 24 28 54 43 4c 53 48 29 20 24  ..  ./$(TCLSH) $
0f70: 28 53 43 41 4e 4e 45 52 29 20 74 68 33 2f 73 74  (SCANNER) th3/st
0f80: 72 65 73 73 20 24 28 54 48 33 29 2f 73 74 72 65  ress $(TH3)/stre
0f90: 73 73 2f 2a 2e 74 65 73 74 3b 20 5c 0a 09 66 69  ss/*.test; \..fi
0fa0: 0a 09 69 66 20 74 65 73 74 20 27 27 20 21 3d 20  ..if test '' != 
0fb0: 27 24 28 53 4c 54 29 27 3b 20 74 68 65 6e 20 5c  '$(SLT)'; then \
0fc0: 0a 09 20 20 2e 2f 24 28 54 43 4c 53 48 29 20 24  ..  ./$(TCLSH) $
0fd0: 28 53 43 41 4e 4e 45 52 29 20 73 6c 74 20 24 28  (SCANNER) slt $(
0fe0: 53 4c 54 29 2f 74 65 73 74 2f 65 76 69 64 65 6e  SLT)/test/eviden
0ff0: 63 65 2f 2a 2e 74 65 73 74 3b 20 5c 0a 09 66 69  ce/*.test; \..fi
1000: 0a 0a 23 20 43 6f 70 79 20 61 6e 64 20 48 54 4d  ..# Copy and HTM
1010: 4c 69 7a 65 20 65 76 69 64 65 6e 63 65 20 66 69  Lize evidence fi
1020: 6c 65 73 0a 23 0a 46 4d 54 20 3d 20 24 28 44 4f  les.#.FMT = $(DO
1030: 43 29 2f 66 6f 72 6d 61 74 5f 65 76 69 64 65 6e  C)/format_eviden
1040: 63 65 2e 74 63 6c 0a 0a 66 6f 72 6d 61 74 5f 65  ce.tcl..format_e
1050: 76 69 64 65 6e 63 65 3a 20 24 28 54 43 4c 53 48  vidence: $(TCLSH
1060: 29 0a 09 72 6d 20 2d 66 72 20 64 6f 63 2f 6d 61  )..rm -fr doc/ma
1070: 74 72 69 78 2f 65 76 2f 2a 0a 09 2e 2f 24 28 54  trix/ev/*.../$(T
1080: 43 4c 53 48 29 20 24 28 46 4d 54 29 20 73 72 63  CLSH) $(FMT) src
1090: 20 64 6f 63 2f 6d 61 74 72 69 78 20 24 28 53 52   doc/matrix $(SR
10a0: 43 29 2f 73 72 63 2f 2a 2e 5b 63 68 79 5d 0a 09  C)/src/*.[chy]..
10b0: 2e 2f 24 28 54 43 4c 53 48 29 20 24 28 46 4d 54  ./$(TCLSH) $(FMT
10c0: 29 20 73 72 63 20 64 6f 63 2f 6d 61 74 72 69 78  ) src doc/matrix
10d0: 20 24 28 53 52 43 29 2f 65 78 74 2f 66 74 73 33   $(SRC)/ext/fts3
10e0: 2f 2a 2e 5b 63 68 5d 0a 09 2e 2f 24 28 54 43 4c  /*.[ch].../$(TCL
10f0: 53 48 29 20 24 28 46 4d 54 29 20 73 72 63 20 64  SH) $(FMT) src d
1100: 6f 63 2f 6d 61 74 72 69 78 20 24 28 53 52 43 29  oc/matrix $(SRC)
1110: 2f 65 78 74 2f 72 74 72 65 65 2f 2a 2e 5b 63 68  /ext/rtree/*.[ch
1120: 5d 0a 09 2e 2f 24 28 54 43 4c 53 48 29 20 24 28  ].../$(TCLSH) $(
1130: 46 4d 54 29 20 74 63 6c 20 64 6f 63 2f 6d 61 74  FMT) tcl doc/mat
1140: 72 69 78 20 24 28 53 52 43 29 2f 74 65 73 74 2f  rix $(SRC)/test/
1150: 2a 2e 74 65 73 74 0a 09 69 66 20 74 65 73 74 20  *.test..if test 
1160: 27 27 20 21 3d 20 27 24 28 53 4c 54 29 27 3b 20  '' != '$(SLT)'; 
1170: 74 68 65 6e 20 5c 0a 09 20 20 2e 2f 24 28 54 43  then \..  ./$(TC
1180: 4c 53 48 29 20 24 28 46 4d 54 29 20 73 6c 74 20  LSH) $(FMT) slt 
1190: 64 6f 63 2f 6d 61 74 72 69 78 20 24 28 53 4c 54  doc/matrix $(SLT
11a0: 29 2f 74 65 73 74 2f 65 76 69 64 65 6e 63 65 2f  )/test/evidence/
11b0: 2a 2e 74 65 73 74 3b 20 5c 0a 09 66 69 0a 0a 70  *.test; \..fi..p
11c0: 72 69 76 61 74 65 5f 65 76 69 64 65 6e 63 65 3a  rivate_evidence:
11d0: 20 66 6f 72 6d 61 74 5f 65 76 69 64 65 6e 63 65   format_evidence
11e0: 0a 09 2e 2f 24 28 54 43 4c 53 48 29 20 24 28 46  .../$(TCLSH) $(F
11f0: 4d 54 29 20 74 68 33 20 64 6f 63 2f 6d 61 74 72  MT) th3 doc/matr
1200: 69 78 20 24 28 54 48 33 29 2f 6d 6b 74 68 33 2e  ix $(TH3)/mkth3.
1210: 74 63 6c 0a 09 2e 2f 24 28 54 43 4c 53 48 29 20  tcl.../$(TCLSH) 
1220: 24 28 46 4d 54 29 20 74 68 33 2f 72 65 71 31 20  $(FMT) th3/req1 
1230: 64 6f 63 2f 6d 61 74 72 69 78 20 24 28 54 48 33  doc/matrix $(TH3
1240: 29 2f 72 65 71 31 2f 2a 2e 74 65 73 74 0a 09 2e  )/req1/*.test...
1250: 2f 24 28 54 43 4c 53 48 29 20 24 28 46 4d 54 29  /$(TCLSH) $(FMT)
1260: 20 74 68 33 2f 63 6f 76 31 20 64 6f 63 2f 6d 61   th3/cov1 doc/ma
1270: 74 72 69 78 20 24 28 54 48 33 29 2f 63 6f 76 31  trix $(TH3)/cov1
1280: 2f 2a 2e 74 65 73 74 0a 0a 23 20 47 65 6e 65 72  /*.test..# Gener
1290: 61 74 65 20 74 68 65 20 74 72 61 63 65 61 62 69  ate the traceabi
12a0: 6c 69 74 79 20 6d 61 74 72 69 78 0a 23 0a 6d 61  lity matrix.#.ma
12b0: 74 72 69 78 3a 09 0a 09 72 6d 20 2d 72 66 20 64  trix:...rm -rf d
12c0: 6f 63 2f 6d 61 74 72 69 78 2f 69 6d 61 67 65 73  oc/matrix/images
12d0: 0a 09 63 70 20 2d 72 20 64 6f 63 2f 69 6d 61 67  ..cp -r doc/imag
12e0: 65 73 20 64 6f 63 2f 6d 61 74 72 69 78 0a 09 63  es doc/matrix..c
12f0: 70 20 24 28 44 4f 43 29 2f 72 61 77 70 61 67 65  p $(DOC)/rawpage
1300: 73 2f 73 71 6c 69 74 65 2e 63 73 73 20 64 6f 63  s/sqlite.css doc
1310: 2f 6d 61 74 72 69 78 0a 09 2e 2f 24 28 54 43 4c  /matrix.../$(TCL
1320: 53 48 29 20 24 28 44 4f 43 29 2f 6d 61 74 72 69  SH) $(DOC)/matri
1330: 78 2e 74 63 6c 0a 0a 0a 23 2d 2d 2d 2d 2d 2d 2d  x.tcl...#-------
1340: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d  ----------------
1350: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d  ----------------
1360: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d  ----------------
1370: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d  ----------------
1380: 2d 2d 0a 0a 23 20 53 6f 75 72 63 65 20 66 69 6c  --..# Source fil
1390: 65 73 20 66 6f 72 20 74 68 65 20 5b 74 63 6c 73  es for the [tcls
13a0: 71 6c 69 74 65 33 2e 73 65 61 72 63 68 5d 20 65  qlite3.search] e
13b0: 78 65 63 75 74 61 62 6c 65 2e 20 0a 23 0a 53 53  xecutable. .#.SS
13c0: 52 43 20 3d 20 24 28 44 4f 43 29 2f 73 65 61 72  RC = $(DOC)/sear
13d0: 63 68 2f 73 65 61 72 63 68 63 2e 63 20 5c 0a 09  ch/searchc.c \..
13e0: 20 20 20 20 24 28 44 4f 43 29 2f 73 65 61 72 63      $(DOC)/searc
13f0: 68 2f 70 61 72 73 65 68 74 6d 6c 2e 63 20 5c 0a  h/parsehtml.c \.
1400: 09 20 20 20 20 24 28 44 4f 43 29 2f 73 65 61 72  .    $(DOC)/sear
1410: 63 68 2f 66 74 73 35 65 78 74 2e 63 20 5c 0a 09  ch/fts5ext.c \..
1420: 20 20 20 20 24 28 54 43 4c 53 51 4c 49 54 45 33      $(TCLSQLITE3
1430: 43 29 0a 0a 23 20 46 6c 61 67 73 20 74 6f 20 62  C)..# Flags to b
1440: 75 69 6c 64 20 5b 74 63 6c 73 71 6c 69 74 65 33  uild [tclsqlite3
1450: 2e 73 65 61 72 63 68 5d 20 77 69 74 68 2e 0a 23  .search] with..#
1460: 0a 53 46 4c 41 47 53 20 3d 20 24 28 54 43 4c 49  .SFLAGS = $(TCLI
1470: 4e 43 29 20 2d 44 53 51 4c 49 54 45 5f 54 48 52  NC) -DSQLITE_THR
1480: 45 41 44 53 41 46 45 3d 30 20 2d 44 53 51 4c 49  EADSAFE=0 -DSQLI
1490: 54 45 5f 45 4e 41 42 4c 45 5f 46 54 53 35 20 2d  TE_ENABLE_FTS5 -
14a0: 44 53 51 4c 49 54 45 5f 54 43 4c 4d 44 35 20 2d  DSQLITE_TCLMD5 -
14b0: 44 54 43 4c 53 48 20 2d 44 6d 61 69 6e 3d 78 6d  DTCLSH -Dmain=xm
14c0: 61 69 6e 0a 0a 24 28 54 43 4c 53 48 29 3a 20 24  ain..$(TCLSH): $
14d0: 28 53 53 52 43 29 0a 09 24 28 43 43 29 20 2d 4f  (SSRC)..$(CC) -O
14e0: 32 20 2d 6f 20 24 40 20 2d 49 2e 20 24 28 53 46  2 -o $@ -I. $(SF
14f0: 4c 41 47 53 29 20 24 28 53 53 52 43 29 20 24 28  LAGS) $(SSRC) $(
1500: 54 43 4c 46 4c 41 47 53 29 0a 0a 73 65 61 72 63  TCLFLAGS)..searc
1510: 68 64 62 3a 20 24 28 54 43 4c 53 48 29 0a 09 6d  hdb: $(TCLSH)..m
1520: 6b 64 69 72 20 2d 70 20 64 6f 63 2f 73 65 61 72  kdir -p doc/sear
1530: 63 68 2e 64 2f 0a 09 2e 2f 24 28 54 43 4c 53 48  ch.d/.../$(TCLSH
1540: 29 20 24 28 44 4f 43 29 2f 73 65 61 72 63 68 2f  ) $(DOC)/search/
1550: 62 75 69 6c 64 73 65 61 72 63 68 64 62 2e 74 63  buildsearchdb.tc
1560: 6c 0a 09 63 70 20 24 28 44 4f 43 29 2f 64 6f 63  l..cp $(DOC)/doc
1570: 75 6d 65 6e 74 5f 68 65 61 64 65 72 2e 74 63 6c  ument_header.tcl
1580: 20 64 6f 63 2f 64 6f 63 75 6d 65 6e 74 5f 68 65   doc/document_he
1590: 61 64 65 72 2e 74 63 6c 0a 09 63 70 20 24 28 44  ader.tcl..cp $(D
15a0: 4f 43 29 2f 64 6f 63 75 6d 65 6e 74 5f 68 65 61  OC)/document_hea
15b0: 64 65 72 2e 74 63 6c 20 64 6f 63 2f 73 65 61 72  der.tcl doc/sear
15c0: 63 68 2e 64 2f 64 6f 63 75 6d 65 6e 74 5f 68 65  ch.d/document_he
15d0: 61 64 65 72 2e 74 63 6c 0a 09 63 70 20 24 28 44  ader.tcl..cp $(D
15e0: 4f 43 29 2f 73 65 61 72 63 68 2f 73 65 61 72 63  OC)/search/searc
15f0: 68 2e 74 63 6c 20 64 6f 63 2f 73 65 61 72 63 68  h.tcl doc/search
1600: 0a 09 63 68 6d 6f 64 20 2b 78 20 64 6f 63 2f 73  ..chmod +x doc/s
1610: 65 61 72 63 68 0a 09 63 70 20 24 28 44 4f 43 29  earch..cp $(DOC)
1620: 2f 73 65 61 72 63 68 2f 73 65 61 72 63 68 2e 74  /search/search.t
1630: 63 6c 20 64 6f 63 2f 73 65 61 72 63 68 2e 64 2f  cl doc/search.d/
1640: 61 64 6d 69 6e 0a 09 63 68 6d 6f 64 20 2b 78 20  admin..chmod +x 
1650: 64 6f 63 2f 73 65 61 72 63 68 2e 64 2f 61 64 6d  doc/search.d/adm
1660: 69 6e 0a 0a 61 6c 77 61 79 73 3a 09 0a 0a 63 6c  in..always:...cl
1670: 65 61 6e 3a 09 0a 09 72 6d 20 2d 72 66 20 24 28  ean:...rm -rf $(
1680: 54 43 4c 53 48 29 20 64 6f 63 20 73 71 6c 69 74  TCLSH) doc sqlit
1690: 65 33 2e 68 0a                                   e3.h.