sherpa

Hex Artifact Content
Login
Tcl 2015 Conference, Manassas/VA, US, Oct 19-23
Send your abstracts to tclconference@googlegroups.com by Aug 24.

Artifact 36d86d4f8074607a01046940954c5ce5f7fc2a9c:

Wiki page [Sherpa Recipes] by hypnotoad 2015-11-19 18:12:35.
0000: 44 20 32 30 31 35 2d 31 31 2d 31 39 54 31 38 3a  D 2015-11-19T18:
0010: 31 32 3a 33 35 2e 38 34 33 0a 4c 20 53 68 65 72  12:35.843.L Sher
0020: 70 61 5c 73 52 65 63 69 70 65 73 0a 50 20 66 33  pa\sRecipes.P f3
0030: 34 34 36 32 64 61 61 38 36 34 35 39 37 63 63 31  4462daa864597cc1
0040: 32 64 39 33 63 33 34 39 65 65 32 61 37 30 39 34  2d93c349ee2a7094
0050: 36 34 35 63 61 61 0a 55 20 68 79 70 6e 6f 74 6f  645caa.U hypnoto
0060: 61 64 0a 57 20 32 30 39 38 0a 42 61 63 6b 20 5b  ad.W 2098.Back [
0070: 68 6f 6d 65 5d 20 6f 72 20 6f 6e 74 6f 20 5b 6d  home] or onto [m
0080: 6f 64 75 6c 65 20 6d 65 74 68 6f 64 73 5d 0d 0a  odule methods]..
0090: 3c 6c 69 3e 0d 0a 0d 0a 53 68 65 72 70 61 20 52  <li>....Sherpa R
00a0: 65 63 69 70 65 73 20 61 72 65 20 54 63 6c 4f 4f  ecipes are TclOO
00b0: 20 6f 62 6a 65 63 74 73 20 77 68 69 63 68 20 63   objects which c
00c0: 6f 6e 64 75 63 74 20 74 68 65 20 64 6f 77 6e 6c  onduct the downl
00d0: 6f 61 64 2c 20 75 6e 70 61 63 6b 69 6e 67 2c 20  oad, unpacking, 
00e0: 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 2c 20 69  configuration, i
00f0: 6e 73 74 61 6c 6c 61 74 69 6f 6e 2c 20 61 6e 64  nstallation, and
0100: 20 72 65 70 61 63 6b 61 67 69 6e 67 20 6f 66 20   repackaging of 
0110: 63 6f 64 65 2e 0d 0a 0d 0a 54 68 65 79 20 61 72  code.....They ar
0120: 65 20 61 20 63 6f 6d 62 69 6e 61 74 69 6f 6e 20  e a combination 
0130: 6f 66 20 74 68 72 65 65 20 64 69 66 66 65 72 65  of three differe
0140: 6e 74 20 74 79 70 65 73 20 6f 66 20 6f 62 6a 65  nt types of obje
0150: 63 74 73 3a 0d 0a 3c 75 6c 3e 0d 0a 3c 6c 69 3e  cts:..<ul>..<li>
0160: 73 68 65 72 70 61 2e 64 69 73 74 72 69 62 75 74  sherpa.distribut
0170: 69 6f 6e 20 2d 20 46 69 6c 65 20 64 69 73 74 72  ion - File distr
0180: 69 62 75 74 69 6f 6e 20 6d 65 74 68 6f 64 73 20  ibution methods 
0190: 28 74 61 72 62 61 6c 6c 2c 20 66 6f 73 73 69 6c  (tarball, fossil
01a0: 2c 20 67 69 74 2c 20 65 74 63 2e 29 0d 0a 3c 6c  , git, etc.)..<l
01b0: 69 3e 73 68 65 72 70 61 2e 62 75 69 6c 64 73 79  i>sherpa.buildsy
01c0: 73 74 65 6d 20 2d 20 44 72 69 76 65 72 20 66 6f  stem - Driver fo
01d0: 72 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 2c  r configuration,
01e0: 20 62 75 69 6c 64 73 2c 20 61 6e 64 20 69 6e 73   builds, and ins
01f0: 74 61 6c 6c 73 20 28 61 75 74 6f 63 6f 6e 66 2c  talls (autoconf,
0200: 20 63 6d 61 6b 65 2c 20 73 61 6b 2c 20 65 74 63   cmake, sak, etc
0210: 29 0d 0a 3c 6c 69 3e 73 68 65 72 70 61 2e 6d 6f  )..<li>sherpa.mo
0220: 64 75 6c 65 20 2d 20 52 65 63 6f 72 64 20 6b 65  dule - Record ke
0230: 65 70 69 6e 67 2c 20 6a 6f 75 72 6e 61 6c 69 6e  eping, journalin
0240: 67 2c 20 61 6e 64 20 72 65 70 61 63 6b 61 67 69  g, and repackagi
0250: 6e 67 0d 0a 3c 2f 75 6c 3e 0d 0a 0d 0a 41 20 74  ng..</ul>....A t
0260: 79 70 69 63 61 6c 20 72 65 63 69 70 65 20 77 69  ypical recipe wi
0270: 6c 6c 20 6c 6f 6f 6b 20 6c 69 6b 65 20 74 68 69  ll look like thi
0280: 73 3a 0d 0a 0d 0a 3c 76 65 72 62 61 74 69 6d 3e  s:....<verbatim>
0290: 0d 0a 73 68 65 72 70 61 3a 3a 72 65 63 69 70 65  ..sherpa::recipe
02a0: 20 75 64 70 20 7b 0d 0a 20 20 6d 6f 64 75 6c 65   udp {..  module
02b0: 20 75 64 70 0d 0a 20 20 64 69 73 74 72 69 62 75   udp..  distribu
02c0: 74 69 6f 6e 20 66 6f 73 73 69 6c 0d 0a 20 20 74  tion fossil..  t
02d0: 6f 6f 6c 73 65 74 20 74 65 61 0d 0a 20 20 66 6f  oolset tea..  fo
02e0: 73 73 69 6c 5f 75 72 6c 20 7b 68 74 74 70 3a 2f  ssil_url {http:/
02f0: 2f 66 6f 73 73 69 6c 2e 65 74 6f 79 6f 63 2e 63  /fossil.etoyoc.c
0300: 6f 6d 2f 66 6f 73 73 69 6c 2f 74 63 6c 75 64 70  om/fossil/tcludp
0310: 7d 0d 0a 20 20 70 61 63 6b 61 67 65 5f 62 69 6e  }..  package_bin
0320: 61 72 79 20 31 0d 0a 20 20 70 61 63 6b 61 67 65  ary 1..  package
0330: 5f 62 69 6e 61 72 79 5f 74 6b 20 30 0d 0a 20 20  _binary_tk 0..  
0340: 70 61 63 6b 61 67 65 5f 76 65 72 73 69 6f 6e 20  package_version 
0350: 31 2e 30 2e 31 30 0d 0a 20 20 64 65 73 74 72 6f  1.0.10..  destro
0360: 6f 74 5f 63 61 70 61 62 61 62 6c 65 20 30 0d 0a  ot_capabable 0..
0370: 7d 0d 0a 3c 2f 76 65 72 62 61 74 69 6d 3e 0d 0a  }..</verbatim>..
0380: 0d 0a 3c 62 3e 73 68 65 72 70 61 3a 3a 72 65 63  ..<b>sherpa::rec
0390: 69 70 65 3c 2f 62 3e 20 69 73 20 61 20 74 63 6c  ipe</b> is a tcl
03a0: 20 63 6f 6d 6d 61 6e 64 2e 20 49 74 27 73 20 74   command. It's t
03b0: 68 65 20 77 72 61 70 70 65 72 20 61 72 6f 75 6e  he wrapper aroun
03c0: 64 20 74 68 65 20 63 72 65 61 74 69 6f 6e 20 6f  d the creation o
03d0: 66 20 74 68 65 20 72 65 63 69 70 65 20 6f 62 6a  f the recipe obj
03e0: 65 63 74 2e 20 49 74 27 73 20 61 72 67 75 6d 65  ect. It's argume
03f0: 6e 74 73 20 61 72 65 3a 0d 0a 3c 75 6c 3e 0d 0a  nts are:..<ul>..
0400: 3c 6c 69 3e 6e 61 6d 65 0d 0a 3c 6c 69 3e 70 72  <li>name..<li>pr
0410: 6f 70 65 72 74 69 65 73 0d 0a 3c 6c 69 3e 63 6c  operties..<li>cl
0420: 61 73 73 20 6e 61 6d 65 20 7c 20 74 63 6c 4f 4f  ass name | tclOO
0430: 20 62 6f 64 79 0d 0a 3c 2f 75 6c 3e 0d 0a 0d 0a   body..</ul>....
0440: 49 66 20 74 68 65 20 6c 61 73 74 20 61 72 67 75  If the last argu
0450: 6d 65 6e 74 20 69 73 20 61 20 73 69 6e 67 6c 65  ment is a single
0460: 20 6c 69 73 74 20 65 6c 65 6d 65 6e 74 2c 20 69   list element, i
0470: 74 20 69 73 20 61 73 73 75 6d 65 64 20 74 6f 20  t is assumed to 
0480: 74 68 65 20 6e 61 6d 65 20 6f 66 20 61 20 70 72  the name of a pr
0490: 65 2d 62 75 69 6c 74 20 63 6c 61 73 73 2e 20 49  e-built class. I
04a0: 66 20 69 74 20 69 73 20 61 6e 79 20 6c 6f 6e 67  f it is any long
04b0: 65 72 20 69 74 20 69 73 20 69 6e 74 65 72 70 72  er it is interpr
04c0: 65 74 65 64 20 61 73 20 61 20 54 63 6c 4f 4f 20  eted as a TclOO 
04d0: 64 65 66 69 6e 65 20 66 6f 72 20 61 20 6e 65 77  define for a new
04e0: 20 63 6c 61 73 73 2e 0d 0a 0d 0a 41 20 6d 6f 72   class.....A mor
04f0: 65 20 63 6f 6d 70 6c 65 78 20 65 78 61 6d 70 6c  e complex exampl
0500: 65 3a 0d 0a 0d 0a 3c 76 65 72 62 61 74 69 6d 3e  e:....<verbatim>
0510: 0d 0a 6f 6f 3a 3a 63 6c 61 73 73 20 63 72 65 61  ..oo::class crea
0520: 74 65 20 73 68 65 72 70 61 2e 62 75 69 6c 64 73  te sherpa.builds
0530: 79 73 74 65 6d 2e 63 6f 72 65 20 7b 0d 0a 20 20  ystem.core {..  
0540: 73 75 70 65 72 63 6c 61 73 73 20 73 68 65 72 70  superclass sherp
0550: 61 2e 64 69 73 74 72 69 62 75 74 69 6f 6e 2e 66  a.distribution.f
0560: 6f 73 73 69 6c 20 73 68 65 72 70 61 2e 62 75 69  ossil sherpa.bui
0570: 6c 64 73 79 73 74 65 6d 2e 61 75 74 6f 63 6f 6e  ldsystem.autocon
0580: 66 20 73 68 65 72 70 61 2e 6d 6f 64 75 6c 65 0d  f sherpa.module.
0590: 0a 20 20 0d 0a 20 20 6d 65 74 68 6f 64 20 70 61  .  ..  method pa
05a0: 74 68 2d 73 6f 75 72 63 65 20 7b 7d 20 7b 0d 0a  th-source {} {..
05b0: 20 20 20 20 72 65 74 75 72 6e 20 5b 66 69 6c 65      return [file
05c0: 20 6a 6f 69 6e 20 5b 6d 79 20 6d 6f 64 75 6c 65   join [my module
05d0: 5f 70 61 74 68 5d 20 5b 6d 79 20 3c 74 6f 6f 6c  _path] [my <tool
05e0: 73 65 74 3e 20 74 63 6c 20 67 65 74 20 70 6c 61  set> tcl get pla
05f0: 74 66 6f 72 6d 5f 73 6f 75 72 63 65 5f 64 69 72  tform_source_dir
0600: 5d 5d 0d 0a 20 20 7d 0d 0a 20 20 6d 65 74 68 6f  ]]..  }..  metho
0610: 64 20 73 68 65 72 70 61 5f 76 66 73 5f 69 6e 73  d sherpa_vfs_ins
0620: 74 61 6c 6c 20 70 61 74 68 20 7b 7d 0d 0a 7d 0d  tall path {}..}.
0630: 0a 0d 0a 73 68 65 72 70 61 3a 3a 72 65 63 69 70  ...sherpa::recip
0640: 65 20 74 63 6c 20 7b 0d 0a 20 20 63 6c 61 73 73  e tcl {..  class
0650: 20 73 68 65 72 70 61 2e 62 75 69 6c 64 73 79 73   sherpa.buildsys
0660: 74 65 6d 2e 63 6f 72 65 0d 0a 20 20 70 61 63 6b  tem.core..  pack
0670: 61 67 65 5f 6e 61 6d 65 20 54 63 6c 0d 0a 20 20  age_name Tcl..  
0680: 70 61 63 6b 61 67 65 5f 76 65 72 73 69 6f 6e 20  package_version 
0690: 38 2e 36 2e 34 0d 0a 20 20 66 6f 73 73 69 6c 5f  8.6.4..  fossil_
06a0: 75 72 6c 20 68 74 74 70 3a 2f 2f 66 6f 73 73 69  url http://fossi
06b0: 6c 2e 65 74 6f 79 6f 63 2e 63 6f 6d 2f 66 6f 73  l.etoyoc.com/fos
06c0: 73 69 6c 2f 74 63 6c 0d 0a 20 20 66 6f 73 73 69  sil/tcl..  fossi
06d0: 6c 5f 74 61 67 20 72 65 6c 65 61 73 65 0d 0a 7d  l_tag release..}
06e0: 20 7b 0d 0a 20 20 6d 65 74 68 6f 64 20 62 75 69   {..  method bui
06f0: 6c 64 2d 6f 70 74 69 6f 6e 73 20 7b 7d 20 7b 0d  ld-options {} {.
0700: 0a 20 20 20 20 72 65 74 75 72 6e 20 5b 6d 79 20  .    return [my 
0710: 3c 74 6f 6f 6c 73 65 74 3e 20 74 63 6c 20 67 65  <toolset> tcl ge
0720: 74 20 63 6f 6e 66 69 67 5f 66 6c 61 67 73 5d 0d  t config_flags].
0730: 0a 20 20 7d 0d 0a 7d 0d 0a 3c 2f 76 65 72 62 61  .  }..}..</verba
0740: 74 69 6d 3e 0d 0a 0d 0a 49 6e 20 74 68 69 73 20  tim>....In this 
0750: 63 61 73 65 2c 20 77 65 20 61 72 65 20 64 65 66  case, we are def
0760: 69 6e 69 6e 67 20 61 20 6e 65 77 20 66 61 6d 69  ining a new fami
0770: 6c 79 20 6f 66 20 72 65 63 69 70 65 73 2e 20 41  ly of recipes. A
0780: 6e 64 20 65 76 65 6e 20 77 69 74 68 20 74 68 65  nd even with the
0790: 20 6e 65 77 20 66 61 6d 69 6c 79 2c 20 65 61 63   new family, eac
07a0: 68 20 72 65 63 69 70 65 20 73 74 69 6c 6c 20 6e  h recipe still n
07b0: 65 65 64 73 20 74 6f 20 64 65 66 69 6e 65 20 61  eeds to define a
07c0: 20 63 75 73 74 6f 6d 20 73 65 74 20 6f 66 20 62   custom set of b
07d0: 75 69 6c 64 20 6f 70 74 69 6f 6e 73 2e 20 41 6e  uild options. An
07e0: 64 2e 2e 2e 20 62 65 63 61 75 73 65 20 74 68 69  d... because thi
07f0: 73 20 69 73 20 74 68 65 20 54 63 6c 20 63 6f 72  s is the Tcl cor
0800: 65 2c 20 77 65 20 64 6f 6e 27 74 20 70 72 6f 76  e, we don't prov
0810: 69 64 65 20 74 68 65 20 63 75 73 74 6f 6d 61 72  ide the customar
0820: 79 20 6d 65 74 68 6f 64 20 66 6f 72 20 70 61 63  y method for pac
0830: 6b 69 6e 67 20 74 68 65 20 63 6f 6e 74 65 6e 74  king the content
0840: 73 20 69 6e 74 6f 20 61 20 56 46 53 2e 20 28 54  s into a VFS. (T
0850: 68 65 72 65 27 73 20 61 20 73 65 70 61 72 61 74  here's a separat
0860: 65 20 73 79 73 74 65 6d 20 66 6f 72 20 70 6f 70  e system for pop
0870: 75 6c 61 74 69 6e 67 20 74 68 65 20 56 46 53 20  ulating the VFS 
0880: 77 69 74 68 20 74 68 65 20 62 6f 6f 74 20 63 6f  with the boot co
0890: 64 65 20 66 6f 72 20 54 63 6c 2e 29 0a 5a 20 36  de for Tcl.).Z 6
08a0: 35 65 38 32 37 66 35 61 39 62 35 36 36 34 36 37  5e827f5a9b566467
08b0: 34 34 35 37 35 64 37 35 35 63 31 65 61 38 63 0a  44575d755c1ea8c.