Fossil

Hex Artifact Content
Login

Artifact f723d122442b204fc73734adfe27e9e5adc8573d:

Wiki page [Documentation outline] by ttmrichter 2008-05-24 15:42:23.
0000: 44 20 32 30 30 38 2d 30 35 2d 32 34 54 31 35 3a  D 2008-05-24T15:
0010: 34 32 3a 32 33 0a 4c 20 44 6f 63 75 6d 65 6e 74  42:23.L Document
0020: 61 74 69 6f 6e 5c 73 6f 75 74 6c 69 6e 65 0a 50  ation\soutline.P
0030: 20 39 34 33 32 65 38 61 62 61 32 37 34 37 66 30   9432e8aba2747f0
0040: 35 31 65 36 32 61 36 63 61 35 63 33 66 62 33 30  51e62a6ca5c3fb30
0050: 66 65 38 34 32 37 32 39 36 0a 55 20 74 74 6d 72  fe8427296.U ttmr
0060: 69 63 68 74 65 72 0a 57 20 32 34 33 34 0a 3c 68  ichter.W 2434.<h
0070: 31 3e 44 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20  1>Documentation 
0080: 6f 75 74 6c 69 6e 65 3c 2f 68 31 3e 0d 0a 54 68  outline</h1>..Th
0090: 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20  e documentation 
00a0: 66 6f 72 20 66 6f 73 73 69 6c 20 6e 65 65 64 73  for fossil needs
00b0: 20 74 6f 20 62 65 20 64 69 76 69 64 65 64 20 69   to be divided i
00c0: 6e 74 6f 20 74 68 65 73 65 20 6d 61 69 6e 20 73  nto these main s
00d0: 65 63 74 69 6f 6e 73 3a 0d 0a 20 20 2a 20 20 3c  ections:..  *  <
00e0: 63 69 74 65 3e 5b 54 75 74 6f 72 69 61 6c 5d 3c  cite>[Tutorial]<
00f0: 2f 63 69 74 65 3e 0d 0a 20 20 2a 20 20 3c 63 69  /cite>..  *  <ci
0100: 74 65 3e 5b 43 6f 6f 6b 62 6f 6f 6b 5d 3c 2f 63  te>[Cookbook]</c
0110: 69 74 65 3e 0d 0a 20 20 2a 20 20 3c 63 69 74 65  ite>..  *  <cite
0120: 3e 5b 52 65 66 65 72 65 6e 63 65 5d 3c 2f 63 69  >[Reference]</ci
0130: 74 65 3e 0d 0a 20 20 2a 20 20 3c 63 69 74 65 3e  te>..  *  <cite>
0140: 5b 44 65 76 65 6c 6f 70 65 72 20 47 75 69 64 65  [Developer Guide
0150: 5d 3c 2f 63 69 74 65 3e 0d 0a 0d 0a 3c 68 32 3e  ]</cite>....<h2>
0160: 54 75 74 6f 72 69 61 6c 3c 2f 68 32 3e 0d 0a 54  Tutorial</h2>..T
0170: 68 65 20 74 75 74 6f 72 69 61 6c 20 70 6f 72 74  he tutorial port
0180: 69 6f 6e 20 69 73 20 74 68 65 20 68 61 6e 64 2d  ion is the hand-
0190: 68 6f 6c 64 69 6e 67 20 70 6f 72 74 69 6f 6e 20  holding portion 
01a0: 74 68 61 74 20 74 61 6b 65 73 20 61 20 6e 65 77  that takes a new
01b0: 20 75 73 65 72 20 74 68 72 6f 75 67 68 0d 0a 74   user through..t
01c0: 68 65 20 73 74 65 70 73 20 6f 66 20 67 65 74 74  he steps of gett
01d0: 69 6e 67 2c 20 62 75 69 6c 64 69 6e 67 20 61 6e  ing, building an
01e0: 64 20 75 73 69 6e 67 20 66 6f 73 73 69 6c 2e 20  d using fossil. 
01f0: 20 46 6f 73 73 69 6c 27 73 20 74 65 72 6d 73 20   Fossil's terms 
0200: 73 68 6f 75 6c 64 20 62 65 0d 0a 64 65 66 69 6e  should be..defin
0210: 65 64 20 68 65 72 65 20 61 6e 64 20 62 61 73 69  ed here and basi
0220: 63 20 77 6f 72 6b 66 6c 6f 77 20 65 73 74 61 62  c workflow estab
0230: 6c 69 73 68 65 64 2e 20 20 49 64 65 61 6c 6c 79  lished.  Ideally
0240: 20 61 20 73 61 6d 70 6c 65 20 70 72 6f 6a 65 63   a sample projec
0250: 74 20 73 68 6f 75 6c 64 0d 0a 62 65 20 75 73 65  t should..be use
0260: 64 20 74 6f 20 73 68 6f 77 20 66 6f 73 73 69 6c  d to show fossil
0270: 20 69 6e 20 75 73 65 20 61 6e 64 20 67 69 76 65   in use and give
0280: 20 74 68 65 20 75 73 65 72 20 73 6f 6d 65 74 68   the user someth
0290: 69 6e 67 20 74 6f 20 74 79 70 65 20 74 6f 20 6d  ing to type to m
02a0: 61 67 69 63 61 6c 6c 79 0d 0a 68 61 76 65 20 66  agically..have f
02b0: 6f 73 73 69 6c 20 64 6f 20 63 6f 6f 6c 20 73 74  ossil do cool st
02c0: 75 66 66 2e 0d 0a 0d 0a 3c 68 32 3e 43 6f 6f 6b  uff.....<h2>Cook
02d0: 62 6f 6f 6b 3c 2f 68 32 3e 0d 0a 54 68 65 20 63  book</h2>..The c
02e0: 6f 6f 6b 62 6f 6f 6b 20 69 73 20 61 20 74 61 73  ookbook is a tas
02f0: 6b 2d 6f 72 69 65 6e 74 65 64 20 70 6f 72 74 69  k-oriented porti
0300: 6f 6e 20 28 6c 69 6b 65 6c 79 20 6f 6e 65 20 74  on (likely one t
0310: 68 61 74 27 73 20 65 76 65 72 2d 65 78 70 61 6e  hat's ever-expan
0320: 64 69 6e 67 20 61 73 0d 0a 66 6f 73 73 69 6c 20  ding as..fossil 
0330: 69 73 20 69 6e 63 72 65 61 73 69 6e 67 6c 79 20  is increasingly 
0340: 64 65 76 65 6c 6f 70 65 64 20 61 6e 64 20 68 6f  developed and ho
0350: 6e 65 64 29 20 64 65 73 69 67 6e 65 64 20 66 6f  ned) designed fo
0360: 72 20 61 20 75 73 65 72 20 77 68 6f 20 68 61 73  r a user who has
0370: 20 62 61 73 69 63 0d 0a 73 6b 69 6c 6c 73 20 69   basic..skills i
0380: 6e 20 75 73 69 6e 67 20 66 6f 73 73 69 6c 20 28  n using fossil (
0390: 6c 69 6b 65 2c 20 73 61 79 2c 20 6d 65 29 20 62  like, say, me) b
03a0: 75 74 20 69 73 6e 27 74 20 66 61 6d 69 6c 69 61  ut isn't familia
03b0: 72 20 77 69 74 68 20 61 6c 6c 20 74 68 65 20 66  r with all the f
03c0: 61 6e 63 69 65 72 0d 0a 61 73 70 65 63 74 73 20  ancier..aspects 
03d0: 6f 66 20 69 74 20 61 6e 64 20 74 68 65 20 69 6e  of it and the in
03e0: 6f 62 76 69 6f 75 73 20 77 6f 72 6b 66 6c 6f 77  obvious workflow
03f0: 73 20 74 68 61 74 20 69 74 20 73 75 70 70 6f 72  s that it suppor
0400: 74 73 2e 20 20 45 61 63 68 20 22 72 65 63 69 70  ts.  Each "recip
0410: 65 22 20 28 75 73 65 0d 0a 63 61 73 65 29 20 69  e" (use..case) i
0420: 6e 20 74 68 65 20 63 6f 6f 6b 62 6f 6f 6b 20 73  n the cookbook s
0430: 68 6f 75 6c 64 20 66 6f 6c 6c 6f 77 20 61 20 66  hould follow a f
0440: 6f 72 6d 61 74 20 77 69 74 68 20 74 68 65 73 65  ormat with these
0450: 20 66 6f 6c 6c 6f 77 69 6e 67 20 70 6f 69 6e 74   following point
0460: 73 3a 0d 0a 20 20 2a 20 20 53 75 63 63 69 6e 63  s:..  *  Succinc
0470: 74 20 70 72 6f 62 6c 65 6d 20 73 74 61 74 65 6d  t problem statem
0480: 65 6e 74 2e 0d 0a 20 20 2a 20 20 44 65 74 61 69  ent...  *  Detai
0490: 6c 65 64 20 73 74 61 74 65 6d 65 6e 74 20 6f 66  led statement of
04a0: 20 70 72 6f 62 6c 65 6d 20 61 6e 64 20 6d 6f 74   problem and mot
04b0: 69 76 61 74 69 6f 6e 20 66 6f 72 20 73 6f 6c 75  ivation for solu
04c0: 74 69 6f 6e 2e 0d 0a 20 20 2a 20 20 44 65 74 61  tion...  *  Deta
04d0: 69 6c 65 64 20 69 6e 73 74 72 75 63 74 69 6f 6e  iled instruction
04e0: 73 20 28 3c 65 6d 3e 6e 6f 20 64 69 73 63 75 73  s (<em>no discus
04f0: 73 69 6f 6e 21 3c 2f 65 6d 3e 29 20 66 6f 72 20  sion!</em>) for 
0500: 69 6d 70 6c 65 6d 65 6e 74 69 6e 67 20 74 68 65  implementing the
0510: 20 73 6f 6c 75 74 69 6f 6e 2e 0d 0a 20 20 2a 20   solution...  * 
0520: 20 44 69 73 63 75 73 73 69 6f 6e 20 6f 66 20 74   Discussion of t
0530: 68 65 20 73 6f 6c 75 74 69 6f 6e 20 69 6e 63 6c  he solution incl
0540: 75 64 69 6e 67 2c 20 69 66 20 61 70 70 6c 69 63  uding, if applic
0550: 61 62 6c 65 2c 20 70 69 74 66 61 6c 6c 73 20 61  able, pitfalls a
0560: 6e 64 20 0d 0a 61 6c 74 65 72 6e 61 74 69 76 65  nd ..alternative
0570: 73 2e 0d 0a 0d 0a 3c 68 32 3e 52 65 66 65 72 65  s.....<h2>Refere
0580: 6e 63 65 3c 2f 68 32 3e 0d 0a 54 68 65 20 72 65  nce</h2>..The re
0590: 66 65 72 65 6e 63 65 20 69 73 20 73 65 6c 66 2d  ference is self-
05a0: 65 78 70 6c 61 6e 61 74 6f 72 79 2e 20 20 42 61  explanatory.  Ba
05b0: 73 69 63 61 6c 6c 79 20 74 61 6b 65 20 65 76 65  sically take eve
05c0: 72 79 74 68 69 6e 67 20 66 72 6f 6d 20 3c 63 6f  rything from <co
05d0: 64 65 3e 66 6f 73 73 69 6c 0d 0a 68 65 6c 70 20  de>fossil..help 
05e0: 2a 3c 2f 63 6f 64 65 3e 20 61 6e 64 20 70 75 74  *</code> and put
05f0: 20 69 74 20 68 65 72 65 2e 20 20 48 6f 77 65 76   it here.  Howev
0600: 65 72 2c 20 74 68 65 20 74 65 72 73 65 6e 65 73  er, the tersenes
0610: 73 20 6f 66 20 3c 63 6f 64 65 3e 66 6f 73 73 69  s of <code>fossi
0620: 6c 0d 0a 68 65 6c 70 3c 2f 63 6f 64 65 3e 2c 20  l..help</code>, 
0630: 77 68 69 6c 65 20 67 6f 6f 64 20 66 6f 72 20 61  while good for a
0640: 20 71 75 69 63 6b 20 72 65 6d 69 6e 64 65 72 20   quick reminder 
0650: 61 74 20 74 68 65 20 63 6f 6d 6d 61 6e 64 20 6c  at the command l
0660: 69 6e 65 2c 20 69 73 20 6e 6f 74 0d 0a 73 75 69  ine, is not..sui
0670: 74 61 62 6c 65 20 66 6f 72 20 22 72 65 61 6c 22  table for "real"
0680: 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 20   documentation. 
0690: 20 49 64 65 61 6c 6c 79 20 65 61 63 68 20 64 6f   Ideally each do
06a0: 63 75 6d 65 6e 74 65 64 20 65 6c 65 6d 65 6e 74  cumented element
06b0: 20 69 6e 20 74 68 65 0d 0a 72 65 66 65 72 65 6e   in the..referen
06c0: 63 65 20 73 68 6f 75 6c 64 20 68 61 76 65 20 61  ce should have a
06d0: 20 66 75 6c 6c 20 65 78 70 6c 61 6e 61 74 69 6f   full explanatio
06e0: 6e 2c 20 69 6e 63 6c 75 64 69 6e 67 20 6c 69 6e  n, including lin
06f0: 6b 73 20 74 6f 20 72 65 6c 61 74 65 64 20 69 74  ks to related it
0700: 65 6d 73 2c 20 61 73 0d 0a 77 65 6c 6c 20 61 73  ems, as..well as
0710: 20 3c 65 6d 3e 65 78 61 6d 70 6c 65 73 3c 2f 65   <em>examples</e
0720: 6d 3e 2e 20 20 28 54 68 69 73 20 68 61 73 20 62  m>.  (This has b
0730: 65 65 6e 20 77 68 61 74 27 73 20 6b 69 6c 6c 69  een what's killi
0740: 6e 67 20 6d 65 20 77 69 74 68 20 67 72 6f 6b 6b  ng me with grokk
0750: 69 6e 67 20 73 6f 6d 65 0d 0a 61 73 70 65 63 74  ing some..aspect
0760: 73 20 6f 66 20 66 6f 73 73 69 6c 3a 20 49 20 6a  s of fossil: I j
0770: 75 73 74 20 63 61 6e 27 74 20 66 69 67 75 72 65  ust can't figure
0780: 20 6f 75 74 20 77 68 61 74 20 74 68 65 79 20 64   out what they d
0790: 6f 21 29 0d 0a 0d 0a 3c 68 32 3e 44 65 76 65 6c  o!)....<h2>Devel
07a0: 6f 70 65 72 20 47 75 69 64 65 3c 2f 68 32 3e 0d  oper Guide</h2>.
07b0: 0a 49 74 20 69 73 20 69 6e 65 76 69 74 61 62 6c  .It is inevitabl
07c0: 65 20 74 68 61 74 20 70 65 6f 70 6c 65 20 77 69  e that people wi
07d0: 6c 6c 20 77 61 6e 74 20 74 6f 20 73 74 61 72 74  ll want to start
07e0: 20 62 75 69 6c 64 69 6e 67 20 74 68 69 72 64 2d   building third-
07f0: 70 61 72 74 79 20 74 6f 6f 6c 73 20 74 68 61 74  party tools that
0800: 0d 0a 69 6e 74 65 72 66 61 63 65 20 77 69 74 68  ..interface with
0810: 20 66 6f 73 73 69 6c 20 61 73 20 66 6f 73 73 69   fossil as fossi
0820: 6c 20 67 65 74 73 20 6d 6f 72 65 20 77 69 64 65  l gets more wide
0830: 6c 79 20 61 64 6f 70 74 65 64 20 61 6e 64 20 6d  ly adopted and m
0840: 6f 72 65 20 6d 61 74 75 72 65 2e 20 20 57 65 0d  ore mature.  We.
0850: 0a 6d 69 67 68 74 20 61 73 20 77 65 6c 6c 20 68  .might as well h
0860: 65 61 64 20 6f 66 66 20 74 68 65 20 69 6e 65 76  ead off the inev
0870: 69 74 61 62 6c 65 20 61 6e 64 20 6c 65 74 20 64  itable and let d
0880: 65 76 65 6c 6f 70 65 72 73 20 68 61 76 65 20 74  evelopers have t
0890: 68 65 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 0d 0a  he information..
08a0: 74 68 65 79 20 6e 65 65 64 20 77 69 74 68 6f 75  they need withou
08b0: 74 20 74 65 61 72 69 6e 67 20 61 70 61 72 74 20  t tearing apart 
08c0: 74 68 65 20 73 6f 75 72 63 65 20 74 6f 20 67 65  the source to ge
08d0: 74 20 74 6f 20 69 74 2e 20 20 54 68 69 73 20 77  t to it.  This w
08e0: 6f 75 6c 64 20 69 6e 63 6c 75 64 65 0d 0a 74 68  ould include..th
08f0: 69 6e 67 73 20 6c 69 6b 65 3a 0d 0a 20 20 2a 20  ings like:..  * 
0900: 20 61 6e 79 20 41 50 49 73 20 69 74 20 77 6f 75   any APIs it wou
0910: 6c 64 20 62 65 20 72 65 61 73 6f 6e 61 62 6c 65  ld be reasonable
0920: 20 74 6f 20 65 78 70 6f 73 65 0d 0a 20 20 2a 20   to expose..  * 
0930: 20 61 20 63 75 72 72 65 6e 74 2c 20 75 70 2d 74   a current, up-t
0940: 6f 2d 64 61 74 65 20 64 61 74 61 62 61 73 65 20  o-date database 
0950: 73 63 68 65 6d 61 0d 0a 20 20 2a 20 20 6e 6f 74  schema..  *  not
0960: 65 73 20 6f 6e 20 69 6e 6e 65 72 20 77 6f 72 6b  es on inner work
0970: 69 6e 67 73 20 28 61 6c 72 65 61 64 79 20 73 75  ings (already su
0980: 70 70 6c 69 65 64 2c 20 62 75 74 20 6d 69 67 68  pplied, but migh
0990: 74 20 6e 65 65 64 20 64 75 73 74 69 6e 67 20 6f  t need dusting o
09a0: 66 66 20 61 6e 64 20 0d 0a 54 4c 43 29 0d 0a 20  ff and ..TLC).. 
09b0: 20 2a 20 20 61 6e 79 74 68 69 6e 67 20 65 6c 73   *  anything els
09c0: 65 20 77 65 20 63 61 6e 20 74 68 69 6e 6b 20 6f  e we can think o
09d0: 66 20 28 4c 75 61 2f 54 63 6c 2f 77 68 61 74 65  f (Lua/Tcl/whate
09e0: 76 65 72 20 62 69 6e 64 69 6e 67 73 3f 29 0d 0a  ver bindings?)..
09f0: 0a 5a 20 39 61 38 37 33 36 32 39 37 32 61 32 32  .Z 9a87362972a22
0a00: 32 64 66 39 65 33 36 33 66 31 32 39 37 33 63 66  2df9e363f12973cf
0a10: 65 65 39 0a                                      ee9.