Hex Artifact Content
Not logged in

Artifact 7b627a64906deaa649173e6fd622b85161b648bd:

File kktodo.wiki part of check-in [f8835f7365] - added documentation plan, just so I can ask myself "What was I thinking?" later. by kejoki on 2008-11-20 17:24:26.

0000: 3c 68 33 3e 6b 6b 69 6e 6e 65 6c 6c 3c 2f 68 33  <h3>kkinnell</h3
0010: 3e 0a 0a 2e 70 6c 61 6e 20 2d 2d 20 3c 69 3e 46  >...plan -- <i>F
0020: 6f 73 73 69 6c 2c 20 74 68 65 20 44 47 3c 2f 69  ossil, the DG</i
0030: 3e 20 42 77 61 68 61 68 61 68 61 68 61 21 20 54  > Bwahahahaha! T
0040: 68 65 20 63 6f 76 65 72 20 61 72 74 20 63 6f 75  he cover art cou
0050: 6c 64 20 62 65 20 61 6e 20 3c 69 3e 68 6f 6d 6f  ld be an <i>homo
0060: 20 65 72 65 63 74 75 73 3c 2f 69 3e 20 73 6b 75   erectus</i> sku
0070: 6c 6c 20 6c 79 69 6e 67 20 6f 6e 20 73 6f 6d 65  ll lying on some
0080: 20 43 4f 42 4f 4c 20 63 6f 64 65 2e 2e 2e 0a 0a   COBOL code.....
0090: 20 20 31 2e 20 20 43 6f 6d 6d 61 6e 64 20 6c 69    1.  Command li
00a0: 6e 65 20 69 6e 74 65 72 66 61 63 65 20 72 65 66  ne interface ref
00b0: 65 72 65 6e 63 65 20 64 6f 63 73 0a 20 20 20 20  erence docs.    
00c0: 20 3c 75 6c 3e 0a 20 20 20 20 20 20 20 20 20 3c   <ul>.         <
00d0: 6c 69 3e 20 46 69 6e 69 73 68 20 69 6e 69 74 69  li> Finish initi
00e0: 61 6c 20 70 61 67 65 73 2e 3c 2f 6c 69 3e 0a 09  al pages.</li>..
00f0: 20 3c 6c 69 3e 20 53 74 61 72 74 20 6f 6e 20 74   <li> Start on t
0100: 65 63 68 2d 73 70 65 63 20 28 73 65 72 69 6f 75  ech-spec (seriou
0110: 73 2c 20 6e 6f 74 20 22 63 68 61 74 74 79 22 29  s, not "chatty")
0120: 20 72 65 66 65 72 65 6e 63 65 20 70 61 67 65 73   reference pages
0130: 2e 3c 2f 6c 69 3e 0a 09 20 3c 6c 69 3e 20 45 64  .</li>.. <li> Ed
0140: 69 74 2c 20 65 64 69 74 2c 20 65 64 69 74 2e 3c  it, edit, edit.<
0150: 2f 6c 69 3e 0a 20 20 20 20 20 3c 2f 75 6c 3e 0a  /li>.     </ul>.
0160: 0a 20 20 32 2e 20 20 53 75 70 70 6f 72 74 20 64  .  2.  Support d
0170: 6f 63 73 0a 20 20 20 20 20 3c 75 6c 3e 0a 09 20  ocs.     <ul>.. 
0180: 3c 6c 69 3e 42 61 73 69 63 20 65 78 70 6c 61 6e  <li>Basic explan
0190: 61 74 69 6f 6e 20 6f 66 20 44 69 73 74 72 69 62  ation of Distrib
01a0: 75 74 65 64 20 53 43 4d 2e 3c 2f 69 3e 0a 09 20  uted SCM.</i>.. 
01b0: 3c 6c 69 3e 54 75 74 6f 72 69 61 6c 0a 09 20 3c  <li>Tutorial.. <
01c0: 75 6c 3e 0a 09 20 20 20 20 20 3c 6c 69 3e 53 69  ul>..     <li>Si
01d0: 6c 6c 79 20 73 6f 75 72 63 65 2e 20 20 53 74 61  lly source.  Sta
01e0: 72 74 20 77 69 74 68 20 65 78 69 73 74 69 6e 67  rt with existing
01f0: 20 64 69 72 20 73 74 72 75 63 74 2e 3c 2f 6c 69   dir struct.</li
0200: 3e 0a 09 20 20 20 20 20 3c 6c 69 3e 52 65 70 6f  >..     <li>Repo
0210: 73 69 74 6f 72 79 2e 20 20 43 72 65 61 74 69 69  sitory.  Creatii
0220: 6e 67 20 61 6e 64 20 70 6f 70 75 6c 61 74 69 6e  ng and populatin
0230: 67 2e 3c 2f 6c 69 3e 0a 09 20 20 20 20 20 3c 6c  g.</li>..     <l
0240: 69 3e 57 68 65 72 65 3f 20 20 4c 6f 63 61 6c 2c  i>Where?  Local,
0250: 20 49 6e 74 72 61 6e 65 74 2c 20 49 6e 74 65 72   Intranet, Inter
0260: 6e 65 74 2e 3c 2f 6c 69 3e 0a 09 20 20 20 20 20  net.</li>..     
0270: 3c 6c 69 3e 57 68 6f 3f 20 50 72 6f 6a 65 63 74  <li>Who? Project
0280: 20 73 69 7a 65 20 64 65 66 69 6e 65 64 20 62 79   size defined by
0290: 20 73 69 7a 65 20 6f 66 20 63 6f 64 65 20 62 61   size of code ba
02a0: 73 65 20 76 65 72 73 75 73 0a 09 20 20 20 20 20  se versus..     
02b0: 6e 75 6d 62 65 72 20 6f 66 20 64 65 76 65 6c 6f  number of develo
02c0: 70 65 72 73 2e 20 20 53 69 7a 65 20 6d 61 74 74  pers.  Size matt
02d0: 65 72 73 2e 3c 2f 6c 69 3e 0a 09 20 20 20 20 20  ers.</li>..     
02e0: 3c 6c 69 3e 48 6f 77 3f 0a 09 20 20 20 20 20 3c  <li>How?..     <
02f0: 75 6c 3e 0a 09 20 20 20 20 20 20 20 20 20 3c 6c  ul>..         <l
0300: 69 3e 4f 70 65 6e 2c 20 63 6c 6f 73 65 2c 20 63  i>Open, close, c
0310: 6f 6d 6d 69 74 2c 20 63 68 65 63 6b 6f 75 74 2c  ommit, checkout,
0320: 20 75 70 64 61 74 65 2c 20 6d 65 72 67 65 2e 3c   update, merge.<
0330: 2f 6c 69 3e 0a 09 20 20 20 20 20 3c 2f 75 6c 3e  /li>..     </ul>
0340: 0a 09 20 20 20 20 20 3c 2f 6c 69 3e 0a 09 20 20  ..     </li>..  
0350: 20 20 20 3c 6c 69 3e 48 6d 6d 6d 2e 20 20 45 78     <li>Hmmm.  Ex
0360: 70 65 72 69 6d 65 6e 74 69 6e 67 2e 3c 2f 6c 69  perimenting.</li
0370: 3e 0a 09 20 20 20 20 20 3c 75 6c 3e 0a 09 20 20  >..     <ul>..  
0380: 20 20 20 20 20 20 20 3c 6c 69 3e 54 68 65 20 72         <li>The r
0390: 6f 61 64 20 6c 65 73 73 20 74 72 61 76 65 6c 6c  oad less travell
03a0: 65 64 2c 20 6f 72 20 77 68 65 72 65 27 64 20 74  ed, or where'd t
03b0: 68 61 74 0a 09 09 20 66 6f 72 6b 20 63 6f 6d 65  hat... fork come
03c0: 20 66 72 6f 6d 3f 3c 2f 6c 3e 0a 09 20 20 20 20   from?</l>..    
03d0: 20 3c 2f 75 6c 3e 0a 09 20 20 20 20 20 3c 6c 69   </ul>..     <li
03e0: 3e 4f 6f 70 73 21 20 20 47 6f 69 6e 67 20 62 61  >Oops!  Going ba
03f0: 63 6b 20 69 6e 20 74 69 6d 65 2e 3c 2f 6c 69 3e  ck in time.</li>
0400: 0a 09 20 3c 2f 75 6c 3e 0a 09 20 3c 2f 6c 69 3e  .. </ul>.. </li>
0410: 0a 20 20 20 20 20 20 20 20 20 3c 6c 69 3e 42 61  .         <li>Ba
0420: 73 69 63 20 65 78 70 6c 61 6e 61 74 69 6f 6e 20  sic explanation 
0430: 6f 66 20 3c 69 3e 6d 65 72 67 65 3c 2f 69 3e 2e  of <i>merge</i>.
0440: 0a 09 20 3c 6f 6c 3e 0a 09 20 20 20 20 20 3c 6c  .. <ol>..     <l
0450: 69 3e 4c 65 61 76 65 73 2c 20 62 72 61 6e 63 68  i>Leaves, branch
0460: 65 73 20 61 6e 64 20 62 61 73 65 6c 69 6e 65 73  es and baselines
0470: 2e 3c 2f 6c 69 3e 0a 09 20 20 20 20 20 3c 6c 69  .</li>..     <li
0480: 3e 3c 69 3e 75 70 64 61 74 65 3c 2f 69 3e 20 6d  ><i>update</i> m
0490: 65 72 67 65 73 20 76 73 2e 20 3c 69 3e 6d 65 72  erges vs. <i>mer
04a0: 67 65 3c 2f 69 3e 20 6d 65 72 67 65 73 2e 0a 09  ge</i> merges...
04b0: 20 20 20 20 20 41 6c 6c 20 6d 65 72 67 65 73 20       All merges 
04c0: 61 72 65 20 65 71 75 61 6c 2c 20 62 75 74 20 73  are equal, but s
04d0: 6f 6d 65 20 61 72 65 20 6d 6f 72 65 20 65 71 75  ome are more equ
04e0: 61 6c 20 74 68 61 6e 20 6f 74 68 65 72 73 2e 3c  al than others.<
04f0: 2f 6c 69 3e 0a 09 20 3c 2f 6f 6c 3e 0a 09 20 3c  /li>.. </ol>.. <
0500: 2f 6c 69 3e 0a 20 20 20 20 20 3c 2f 75 6c 3e 0a  /li>.     </ul>.
0510: 0a 20 20 34 32 2e 20 20 47 65 6e 65 72 61 6c 0a  .  42.  General.
0520: 20 20 20 20 20 3c 75 6c 3e 0a 09 20 3c 6c 69 3e       <ul>.. <li>
0530: 43 6f 2d 6f 72 64 69 6e 61 74 65 20 73 74 79 6c  Co-ordinate styl
0540: 65 20 61 6e 64 20 74 6f 6e 65 20 77 69 74 68 20  e and tone with 
0550: 64 72 68 2c 20 6f 74 68 65 72 20 64 65 76 73 2e  drh, other devs.
0560: 20 28 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 0a   (documentation.
0570: 20 20 20 20 20 20 20 20 20 73 74 61 6e 64 61 72           standar
0580: 64 3f 20 20 79 75 63 6b 2e 29 3c 2f 6c 69 3e 0a  d?  yuck.)</li>.
0590: 20 20 20 20 20 3c 2f 75 6c 3e 0a 0a 20 20 2a 20       </ul>..  * 
05a0: 20 54 69 70 73 20 26 20 74 72 69 63 6b 73 2e 0a   Tips & tricks..
05b0: 0a 20 20 2a 20 20 3c 62 3e 46 6f 73 73 69 6c 3c  .  *  <b>Fossil<
05c0: 2f 62 3e 20 61 6e 64 20 3c 62 3e 53 71 6c 69 74  /b> and <b>Sqlit
05d0: 65 3c 2f 62 3e 0a 20 20 20 20 20 3c 75 6c 3e 0a  e</b>.     <ul>.
05e0: 20 20 20 20 20 20 20 20 20 3c 6c 69 3e 47 65 74           <li>Get
05f0: 20 61 20 77 6f 72 64 20 69 6e 20 66 6f 72 20 4d   a word in for M
0600: 72 69 6e 61 6c 20 4b 61 6e 74 27 73 0a 09 20 3c  rinal Kant's.. <
0610: 61 20 68 72 65 66 3d 22 68 74 74 70 3a 2f 2f 63  a href="http://c
0620: 6f 64 65 2e 67 6f 6f 67 6c 65 2e 63 6f 6d 2f 70  ode.google.com/p
0630: 2f 73 71 6c 69 74 65 2d 6d 61 6e 61 67 65 72 2f  /sqlite-manager/
0640: 22 3e 53 51 4c 69 74 65 20 4d 61 6e 61 67 65 72  ">SQLite Manager
0650: 3c 2f 61 3e 0a 09 20 58 55 4c 20 61 70 70 2e 20  </a>.. XUL app. 
0660: 20 47 72 65 61 74 20 74 6f 6f 6c 2e 3c 2f 6c 69   Great tool.</li
0670: 3e 0a 20 20 20 20 20 3c 2f 75 6c 3e 0a 0a 20 20  >.     </ul>..  
0680: 2a 20 20 54 68 20 28 63 6f 64 65 20 67 72 6f 76  *  Th (code grov
0690: 65 6c 69 6e 67 20 26 23 39 31 3b 61 6e 64 20 63  eling &#91;and c
06a0: 6f 64 65 20 67 72 6f 76 65 6c 69 6e 67 20 7b 61  ode groveling {a
06b0: 6e 64 20 63 6f 64 65 20 67 72 6f 76 65 6c 69 6e  nd code grovelin
06c0: 67 20 2e 2e 2e 20 7d 20 2e 2e 2e 20 26 23 39 33  g ... } ... &#93
06d0: 3b 20 2e 2e 2e 20 29 0a                          ; ... ).