Fossil

Hex Artifact Content
Login

Artifact 976db410b019ec100c95da8aa977d6209fee9a4e:


0000: 54 6f 20 64 6f 20 61 20 63 6f 6d 70 6c 65 74 65  To do a complete
0010: 20 62 75 69 6c 64 2c 20 6a 75 73 74 20 74 79 70   build, just typ
0020: 65 3a 0a 0a 20 20 20 2e 2f 63 6f 6e 66 69 67 75  e:..   ./configu
0030: 72 65 3b 20 6d 61 6b 65 0a 0a 54 68 65 20 2e 2f  re; make..The ./
0040: 63 6f 6e 66 69 67 75 72 65 20 73 63 72 69 70 74  configure script
0050: 20 62 75 69 6c 64 73 20 4d 61 6b 65 66 69 6c 65   builds Makefile
0060: 20 66 72 6f 6d 20 4d 61 6b 65 66 69 6c 65 2e 69   from Makefile.i
0070: 6e 20 62 61 73 65 64 20 6f 6e 0a 79 6f 75 72 20  n based on.your 
0080: 73 79 73 74 65 6d 20 61 6e 64 20 61 6e 79 20 6f  system and any o
0090: 70 74 69 6f 6e 73 20 79 6f 75 20 73 65 6c 65 63  ptions you selec
00a0: 74 20 28 72 75 6e 20 22 2e 2f 63 6f 6e 66 69 67  t (run "./config
00b0: 75 72 65 20 2d 2d 68 65 6c 70 22 0a 66 6f 72 20  ure --help".for 
00c0: 61 20 6c 69 73 74 69 6e 67 20 6f 66 20 74 68 65  a listing of the
00d0: 20 61 76 61 69 6c 61 62 6c 65 20 6f 70 74 69 6f   available optio
00e0: 6e 73 2e 29 0a 0a 49 66 20 79 6f 75 20 77 69 73  ns.)..If you wis
00f0: 68 20 74 6f 20 75 73 65 20 74 68 65 20 6f 72 69  h to use the ori
0100: 67 69 6e 61 6c 20 4d 61 6b 65 66 69 6c 65 20 77  ginal Makefile w
0110: 69 74 68 20 6e 6f 20 63 6f 6e 66 69 67 75 72 61  ith no configura
0120: 74 69 6f 6e 2c 20 79 6f 75 20 63 61 6e 0a 69 6e  tion, you can.in
0130: 73 74 65 61 64 20 75 73 65 3a 0a 0a 20 20 20 6d  stead use:..   m
0140: 61 6b 65 20 2d 66 20 4d 61 6b 65 66 69 6c 65 2e  ake -f Makefile.
0150: 63 6c 61 73 73 69 63 0a 0a 4f 6e 20 61 20 77 69  classic..On a wi
0160: 6e 64 6f 77 73 20 62 6f 78 2c 20 75 73 65 20 6f  ndows box, use o
0170: 6e 65 20 6f 66 20 74 68 65 20 4d 61 6b 65 66 69  ne of the Makefi
0180: 6c 65 73 20 69 6e 20 74 68 65 20 77 69 6e 2f 20  les in the win/ 
0190: 73 75 62 64 69 72 65 63 74 6f 72 79 2c 0a 61 63  subdirectory,.ac
01a0: 63 6f 72 64 69 6e 67 20 74 6f 20 79 6f 75 72 20  cording to your 
01b0: 63 6f 6d 70 69 6c 65 72 20 61 6e 64 20 65 6e 76  compiler and env
01c0: 69 72 6f 6e 6d 65 6e 74 2e 20 20 49 66 20 79 6f  ironment.  If yo
01d0: 75 20 68 61 76 65 20 4d 69 6e 47 57 20 6f 72 0a  u have MinGW or.
01e0: 4d 69 6e 47 57 2d 77 36 34 20 69 6e 73 74 61 6c  MinGW-w64 instal
01f0: 6c 65 64 20 6f 6e 20 79 6f 75 72 20 73 79 73 74  led on your syst
0200: 65 6d 20 28 4d 73 79 73 20 6f 72 20 43 79 67 77  em (Msys or Cygw
0210: 69 6e 2c 20 6f 72 20 61 73 0a 63 72 6f 73 73 2d  in, or as.cross-
0220: 63 6f 6d 70 69 6c 65 20 65 6e 76 69 72 6f 6e 6d  compile environm
0230: 65 6e 74 20 6f 6e 20 4c 69 6e 75 78 20 6f 72 20  ent on Linux or 
0240: 44 61 72 77 69 6e 29 2c 20 74 68 65 6e 20 63 6f  Darwin), then co
0250: 6e 73 69 64 65 72 3a 0a 0a 20 20 20 6d 61 6b 65  nsider:..   make
0260: 20 2d 66 20 77 69 6e 2f 4d 61 6b 65 66 69 6c 65   -f win/Makefile
0270: 2e 6d 69 6e 67 77 0a 0a 49 66 20 79 6f 75 20 68  .mingw..If you h
0280: 61 76 65 20 56 43 2b 2b 20 69 6e 73 74 61 6c 6c  ave VC++ install
0290: 65 64 20 6f 6e 20 79 6f 75 72 20 73 79 73 74 65  ed on your syste
02a0: 6d 2c 20 74 68 65 6e 20 63 6f 6e 73 69 64 65 72  m, then consider
02b0: 3a 0a 0a 20 20 20 63 64 20 77 69 6e 3b 20 6e 6d  :..   cd win; nm
02c0: 61 6b 65 20 2f 66 20 4d 61 6b 65 66 69 6c 65 2e  ake /f Makefile.
02d0: 6d 73 63 0a 0a 49 66 20 79 6f 75 20 68 61 76 65  msc..If you have
02e0: 20 74 72 6f 75 62 6c 65 2c 20 6f 72 20 79 6f 75   trouble, or you
02f0: 20 77 61 6e 74 20 74 6f 20 64 6f 20 73 6f 6d 65   want to do some
0300: 74 68 69 6e 67 20 66 61 6e 63 79 2c 20 6a 75 73  thing fancy, jus
0310: 74 20 6c 6f 6f 6b 20 61 74 0a 4d 61 6b 65 66 69  t look at.Makefi
0320: 6c 65 2e 63 6c 61 73 73 69 63 2e 20 54 68 65 72  le.classic. Ther
0330: 65 20 61 72 65 20 36 20 63 6f 6e 66 69 67 75 72  e are 6 configur
0340: 61 74 69 6f 6e 20 6f 70 74 69 6f 6e 73 20 74 68  ation options th
0350: 61 74 20 61 72 65 20 61 6c 6c 20 77 65 6c 6c 0a  at are all well.
0360: 63 6f 6d 6d 65 6e 74 65 64 2e 20 49 6e 73 74 65  commented. Inste
0370: 61 64 20 6f 66 20 65 64 69 74 69 6e 67 20 74 68  ad of editing th
0380: 65 20 4d 61 6b 65 66 69 6c 65 2e 63 6c 61 73 73  e Makefile.class
0390: 69 63 2c 20 63 6f 6e 73 69 64 65 72 20 63 6f 70  ic, consider cop
03a0: 79 69 6e 67 0a 4d 61 6b 65 66 69 6c 65 2e 63 6c  ying.Makefile.cl
03b0: 61 73 73 69 63 20 74 6f 20 61 6e 20 61 6c 74 65  assic to an alte
03c0: 72 6e 61 74 69 76 65 20 6e 61 6d 65 20 73 75 63  rnative name suc
03d0: 68 20 61 73 20 22 47 4e 55 4d 61 6b 65 66 69 6c  h as "GNUMakefil
03e0: 65 22 2c 0a 22 42 53 44 4d 61 6b 65 66 69 6c 65  e",."BSDMakefile
03f0: 22 2c 20 6f 72 20 22 6d 61 6b 65 66 69 6c 65 22  ", or "makefile"
0400: 20 61 6e 64 20 65 64 69 74 69 6e 67 20 74 68 65   and editing the
0410: 20 63 6f 70 79 2e 0a 0a 0a 42 55 49 4c 44 49 4e   copy....BUILDIN
0420: 47 20 4f 55 54 53 49 44 45 20 54 48 45 20 53 4f  G OUTSIDE THE SO
0430: 55 52 43 45 20 54 52 45 45 0a 0a 41 6e 20 6f 75  URCE TREE..An ou
0440: 74 20 6f 66 20 73 6f 75 72 63 65 20 62 75 69 6c  t of source buil
0450: 64 20 69 73 20 70 72 65 74 74 79 20 65 61 73 79  d is pretty easy
0460: 3a 0a 0a 20 20 31 2e 20 4d 61 6b 65 20 61 6e 64  :..  1. Make and
0470: 20 63 68 61 6e 67 65 20 74 6f 20 61 20 6e 65 77   change to a new
0480: 20 64 69 72 65 63 74 6f 72 79 20 74 6f 20 64 6f   directory to do
0490: 20 74 68 65 20 62 75 69 6c 64 73 20 69 6e 2e 0a   the builds in..
04a0: 20 20 32 2e 20 52 75 6e 20 74 68 65 20 22 63 6f    2. Run the "co
04b0: 6e 66 69 67 75 72 65 22 20 73 63 72 69 70 74 20  nfigure" script 
04c0: 66 72 6f 6d 20 74 68 69 73 20 64 69 72 65 63 74  from this direct
04d0: 6f 72 79 2e 0a 20 20 33 2e 20 54 79 70 65 3a 20  ory..  3. Type: 
04e0: 22 6d 61 6b 65 22 0a 0a 46 6f 72 20 65 78 61 6d  "make"..For exam
04f0: 70 6c 65 3a 0a 0a 20 20 6d 6b 64 69 72 20 62 75  ple:..  mkdir bu
0500: 69 6c 64 0a 20 20 63 64 20 62 75 69 6c 64 0a 20  ild.  cd build. 
0510: 20 2e 2e 2f 63 6f 6e 66 69 67 75 72 65 0a 20 20   ../configure.  
0520: 6d 61 6b 65 0a 0a 54 68 69 73 20 77 69 6c 6c 20  make..This will 
0530: 6e 6f 77 20 6b 65 65 70 20 61 6c 6c 20 67 65 6e  now keep all gen
0540: 65 72 61 74 65 73 20 66 69 6c 65 73 20 73 65 70  erates files sep
0550: 61 72 61 74 65 20 66 72 6f 6d 20 74 68 65 20 6d  arate from the m
0560: 61 69 6e 74 61 69 6e 65 64 0a 73 6f 75 72 63 65  aintained.source
0570: 20 63 6f 64 65 2e 0a 0a 2d 2d 2d 2d 2d 2d 2d 2d   code...--------
0580: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d  ----------------
0590: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d  ----------------
05a0: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d  ----------------
05b0: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d  ----------------
05c0: 2d 2d 0a 0a 48 65 72 65 20 61 72 65 20 73 6f 6d  --..Here are som
05d0: 65 20 6e 6f 74 65 73 20 6f 6e 20 77 68 61 74 20  e notes on what 
05e0: 69 73 20 68 61 70 70 65 6e 69 6e 67 20 62 65 68  is happening beh
05f0: 69 6e 64 20 74 68 65 20 73 63 65 6e 65 73 3a 0a  ind the scenes:.
0600: 0a 2a 20 54 68 65 20 63 6f 6e 66 69 67 75 72 65  .* The configure
0610: 20 73 63 72 69 70 74 20 28 69 66 20 75 73 65 64   script (if used
0620: 29 20 65 78 61 6d 69 6e 65 73 20 74 68 65 20 6f  ) examines the o
0630: 70 74 69 6f 6e 73 20 67 69 76 65 6e 0a 20 20 61  ptions given.  a
0640: 6e 64 20 72 75 6e 73 20 76 61 72 69 6f 75 73 20  nd runs various 
0650: 74 65 73 74 73 20 77 69 74 68 20 74 68 65 20 43  tests with the C
0660: 20 63 6f 6d 70 69 6c 65 72 20 74 6f 20 63 72 65   compiler to cre
0670: 61 74 65 20 4d 61 6b 65 66 69 6c 65 0a 20 20 66  ate Makefile.  f
0680: 72 6f 6d 20 74 68 65 20 4d 61 6b 65 66 69 6c 65  rom the Makefile
0690: 2e 69 6e 20 74 65 6d 70 6c 61 74 65 20 61 73 20  .in template as 
06a0: 77 65 6c 6c 20 61 73 20 61 75 74 6f 63 6f 6e 66  well as autoconf
06b0: 69 67 2e 68 0a 0a 2a 20 54 68 65 20 4d 61 6b 65  ig.h..* The Make
06c0: 66 69 6c 65 20 6a 75 73 74 20 73 65 74 73 20 75  file just sets u
06d0: 70 20 61 20 66 65 77 20 6d 61 63 72 6f 73 20 61  p a few macros a
06e0: 6e 64 20 74 68 65 6e 20 69 6e 76 6f 6b 65 73 20  nd then invokes 
06f0: 74 68 65 0a 20 20 72 65 61 6c 20 6d 61 6b 65 66  the.  real makef
0700: 69 6c 65 20 69 6e 20 73 72 63 2f 6d 61 69 6e 2e  ile in src/main.
0710: 6d 6b 2e 20 20 54 68 65 20 73 72 63 2f 6d 61 69  mk.  The src/mai
0720: 6e 2e 6d 6b 20 6d 61 6b 65 66 69 6c 65 20 69 73  n.mk makefile is
0730: 0a 20 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79  .  automatically
0740: 20 67 65 6e 65 72 61 74 65 64 20 62 79 20 61 20   generated by a 
0750: 54 43 4c 20 73 63 72 69 70 74 20 66 6f 75 6e 64  TCL script found
0760: 20 61 74 20 73 72 63 2f 6d 61 6b 65 6d 61 6b 65   at src/makemake
0770: 2e 74 63 6c 2e 0a 20 20 44 6f 20 6e 6f 74 20 65  .tcl..  Do not e
0780: 64 69 74 20 73 72 63 2f 6d 61 69 6e 2e 6d 6b 20  dit src/main.mk 
0790: 64 69 72 65 63 74 6c 79 2e 20 20 55 70 64 61 74  directly.  Updat
07a0: 65 20 73 72 63 2f 6d 61 6b 65 6d 61 6b 65 2e 74  e src/makemake.t
07b0: 63 6c 20 61 6e 64 0a 20 20 74 68 65 6e 20 72 65  cl and.  then re
07c0: 72 75 6e 20 69 74 2e 0a 0a 2a 20 54 68 65 20 2a  run it...* The *
07d0: 2e 68 20 68 65 61 64 65 72 20 66 69 6c 65 73 20  .h header files 
07e0: 61 72 65 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c  are automaticall
07f0: 79 20 67 65 6e 65 72 61 74 65 64 20 75 73 69 6e  y generated usin
0800: 67 20 61 20 70 72 6f 67 72 61 6d 0a 20 20 63 61  g a program.  ca
0810: 6c 6c 65 64 20 22 6d 61 6b 65 68 65 61 64 65 72  lled "makeheader
0820: 73 22 2e 20 20 53 6f 75 72 63 65 20 63 6f 64 65  s".  Source code
0830: 20 74 6f 20 74 68 65 20 6d 61 6b 65 68 65 61 64   to the makehead
0840: 65 72 73 20 70 72 6f 67 72 61 6d 20 69 73 0a 20  ers program is. 
0850: 20 66 6f 75 6e 64 20 69 6e 20 73 72 63 2f 6d 61   found in src/ma
0860: 6b 65 68 65 61 64 65 72 73 2e 63 2e 20 20 44 6f  keheaders.c.  Do
0870: 63 75 6d 65 6e 74 61 74 69 6f 6e 20 69 73 20 66  cumentation is f
0880: 6f 75 6e 64 20 69 6e 0a 20 20 73 72 63 2f 6d 61  ound in.  src/ma
0890: 6b 65 68 65 61 64 65 72 73 2e 68 74 6d 6c 2e 0a  keheaders.html..
08a0: 0a 2a 20 4d 6f 73 74 20 2a 2e 63 20 73 6f 75 72  .* Most *.c sour
08b0: 63 65 20 66 69 6c 65 73 20 61 72 65 20 70 72 65  ce files are pre
08c0: 70 72 6f 63 65 73 73 65 64 20 75 73 69 6e 67 20  processed using 
08d0: 61 20 70 72 6f 67 72 61 6d 20 63 61 6c 6c 65 64  a program called
08e0: 0a 20 20 22 74 72 61 6e 73 6c 61 74 65 22 2e 20  .  "translate". 
08f0: 20 54 68 65 20 73 6f 75 72 63 65 73 20 74 6f 20   The sources to 
0900: 74 72 61 6e 73 6c 61 74 65 20 61 72 65 20 66 6f  translate are fo
0910: 75 6e 64 20 69 6e 20 73 72 63 2f 74 72 61 6e 73  und in src/trans
0920: 6c 61 74 65 2e 63 2e 0a 20 20 41 20 68 65 61 64  late.c..  A head
0930: 65 72 20 63 6f 6d 6d 65 6e 74 20 69 6e 20 73 72  er comment in sr
0940: 63 2f 74 72 61 6e 73 6c 61 74 65 2e 63 20 65 78  c/translate.c ex
0950: 70 6c 61 69 6e 73 20 69 6e 20 64 65 74 61 69 6c  plains in detail
0960: 20 77 68 61 74 20 69 74 20 64 6f 65 73 2e 0a 0a   what it does...
0970: 2a 20 54 68 65 20 73 72 63 2f 6d 6b 69 6e 64 65  * The src/mkinde
0980: 78 2e 63 20 70 72 6f 67 72 61 6d 20 67 65 6e 65  x.c program gene
0990: 72 61 74 65 73 20 73 6f 6d 65 20 43 20 63 6f 64  rates some C cod
09a0: 65 20 74 68 61 74 20 69 6d 70 6c 65 6d 65 6e 74  e that implement
09b0: 73 0a 20 20 73 74 61 74 69 63 20 6c 6f 6f 6b 75  s.  static looku
09c0: 70 20 74 61 62 6c 65 73 2e 20 20 53 65 65 20 74  p tables.  See t
09d0: 68 65 20 68 65 61 64 65 72 20 63 6f 6d 6d 65 6e  he header commen
09e0: 74 20 69 6e 20 74 68 65 20 73 6f 75 72 63 65 20  t in the source 
09f0: 63 6f 64 65 0a 20 20 66 6f 72 20 64 65 74 61 69  code.  for detai
0a00: 6c 73 20 6f 6e 20 77 68 61 74 20 69 74 20 64 6f  ls on what it do
0a10: 65 73 2e 0a 0a 41 64 64 69 74 69 6f 6e 61 6c 20  es...Additional 
0a20: 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 6f 6e 20 74  information on t
0a30: 68 65 20 62 75 69 6c 64 20 70 72 6f 63 65 73 73  he build process
0a40: 20 69 73 20 61 76 61 69 6c 61 62 6c 65 20 66 72   is available fr
0a50: 6f 6d 0a 68 74 74 70 3a 2f 2f 77 77 77 2e 66 6f  om.http://www.fo
0a60: 73 73 69 6c 2d 73 63 6d 2e 6f 72 67 2f 66 6f 73  ssil-scm.org/fos
0a70: 73 69 6c 2f 64 6f 63 2f 74 72 75 6e 6b 2f 77 77  sil/doc/trunk/ww
0a80: 77 2f 6d 61 6b 65 66 69 6c 65 2e 77 69 6b 69 0a  w/makefile.wiki.