Fossil SCM

Update the how-to-build documentation in the BUILD.txt file at the root of the source tree.

drh 2010-03-01 00:54 trunk
Commit 355d37ca8c93ca2064dd6286d803583098006c70
Parent 7ca773bc312f914…
1 file changed +56 -60
~ BUILD.txt
M BUILD.txt
+56 -60
--- BUILD.txt
+++ BUILD.txt
@@ -1,62 +1,56 @@
1
-All of the source code for fossil is contained in the src/ subdirectory.
2
-But there is a lot of generated code, so you will probably want to
3
-use the Makefile. To do a complete build, just type:
4
-
5
- make
6
-
7
-That should work out-of-the-box on Macs and Linux systems. If you are
8
-building on a Windows box, install MinGW as well as MinGW's make (or
9
-MSYS). You can then type:
10
-
11
- make -f Makefile.w32
12
-
13
-If you have trouble, or you want to do something fancy, just look at
14
-top level makefile. There are 5 configuration options that are all well
15
-commented. Instead of editing the Makefile, create a new file named
16
-config.mak (for Macs and Linux systems) or config.w32 (for Windows) and
17
-override any settings you wish there.
18
-
19
-Out of source builds?
---------------------------------------------------------------------------
20
-
21
-An out of source build is pretty easy:
22
-
23
- 1. Make a new directory to do the builds in.
24
- 2. Create a config.mak (or .w32 ... explained above) and add something
25
- along the lines of:
26
-
27
- SRCDIR=../src
28
-
29
- 3. From that directory, type:
30
-
31
- Macs and Linux:
32
- $ make -f ../Makefile
33
-
34
- Windows:
35
- C:\fossil\build> make -f ../Makefile.w32
36
-
37
-This will now keep all generates files seperate from the maintained
38
-source code.
39
-
---------------------------------------------------------------------------
40
-
41
-Here are some notes on what is happening behind the scenes:
42
-
43
-* The Makefile just sets up a few macros and then invokes the
44
- real makefile in src/main.mk. The src/main.mk makefile is
45
- automatically generated by a TCL script found at src/makemake.tcl.
46
- Do not edit src/main.mk directly. Update src/makemake.tcl and
47
- then rerun it.
48
-
49
-* The *.h header files are automatically generated using a program
50
- called "makeheaders". Source code to the makeheaders program is
51
- found in src/makeheaders.c. Documentation is found in
52
- src/makeheaders.html.
53
-
54
-* Most *.c source files are preprocessed using a program called
55
- "translate". The sources to translate are found in src/translate.c.
56
- A header comment in src/translate.c explains in detail what it does.
57
-
58
-* The src/mkindex.c program generates some C code that implements
59
- static lookup tables. See the header comment in the source code
60
- for details on what it does.
1
+All of the source code for fossil is contained in the src/ subdirectory.
2
+But there is a lot of generated code, so you will probably want to
3
+use the Makefile. To do a complete build, just type:
4
+
5
+ make
6
+
7
+That should work out-of-the-box on Macs and Linux systems. If you are
8
+building on a Windows box, install MinGW as well as MinGW's make (or
9
+MSYS). You can then type:
10
+
11
+ make -f Makefile.w32
12
+
13
+If you have trouble, or you want to do something fancy, just look at
14
+top level makefile. There are 6 configuration options that are all well
15
+commented. Instead of editing the Makefile, consider copying the Makefile
16
+to an alternative name such as "GNUMakefile", "BSDMakefile", or "makefile"
17
+and editing the copy.
18
+
19
+Out of source builds?
20
+--------------------------------------------------------------------------
21
+
22
+An out of source build is pretty easy:
23
+
24
+ 1. Make a new directory to do the builds in.
25
+ 2. Copy "Makefile" from the source into the build directory and
26
+ modify the SRCDIR macro along the lines of:
27
+
28
+ SRCDIR=../src
29
+
30
+ 3. type: "make"
31
+
32
+This will now keep all generates files seperate from the maintained
33
+source code.
34
+
35
+--------------------------------------------------------------------------
36
+
37
+Here are some notes on what is happening behind the scenes:
38
+
39
+* The Makefile just sets up a few macros and then invokes the
40
+ real makefile in src/main.mk. The src/main.mk makefile is
41
+ automatically generated by a TCL script found at src/makemake.tcl.
42
+ Do not edit src/main.mk directly. Update src/makemake.tcl and
43
+ then rerun it.
44
+
45
+* The *.h header files are automatically generated using a program
46
+ called "makeheaders". Source code to the makeheaders program is
47
+ found in src/makeheaders.c. Documentation is found in
48
+ src/makeheaders.html.
49
+
50
+* Most *.c source files are preprocessed using a program called
51
+ "translate". The sources to translate are found in src/translate.c.
52
+ A header comment in src/translate.c explains in detail what it does.
53
+
54
+* The src/mkindex.c program generates some C code that implements
55
+ static lookup tables. See the header comment in the source code
56
+ for details on what it does.
6157
--- BUILD.txt
+++ BUILD.txt
@@ -1,62 +1,56 @@
1 All of the source code for fossil is contained in the src/ subdirectory.
2 But there is a lot of generated code, so you will probably want to
3 use the Makefile. To do a complete build, just type:
4
5 make
6
7 That should work out-of-the-box on Macs and Linux systems. If you are
8 building on a Windows box, install MinGW as well as MinGW's make (or
9 MSYS). You can then type:
10
11 make -f Makefile.w32
12
13 If you have trouble, or you want to do something fancy, just look at
14 top level makefile. There are 5 configuration options that are all well
15 commented. Instead of editing the Makefile, create a new file named
16 config.mak (for Macs and Linux systems) or config.w32 (for Windows) and
17 override any settings you wish there.
18
19 Out of source builds?
---------------------------------------------------------------------------
20
21 An out of source build is pretty easy:
22
23 1. Make a new directory to do the builds in.
24 2. Create a config.mak (or .w32 ... explained above) and add something
25 along the lines of:
26
27 SRCDIR=../src
28
29 3. From that directory, type:
30
31 Macs and Linux:
32 $ make -f ../Makefile
33
34 Windows:
35 C:\fossil\build> make -f ../Makefile.w32
36
37 This will now keep all generates files seperate from the maintained
38 source code.
39
---------------------------------------------------------------------------
40
41 Here are some notes on what is happening behind the scenes:
42
43 * The Makefile just sets up a few macros and then invokes the
44 real makefile in src/main.mk. The src/main.mk makefile is
45 automatically generated by a TCL script found at src/makemake.tcl.
46 Do not edit src/main.mk directly. Update src/makemake.tcl and
47 then rerun it.
48
49 * The *.h header files are automatically generated using a program
50 called "makeheaders". Source code to the makeheaders program is
51 found in src/makeheaders.c. Documentation is found in
52 src/makeheaders.html.
53
54 * Most *.c source files are preprocessed using a program called
55 "translate". The sources to translate are found in src/translate.c.
56 A header comment in src/translate.c explains in detail what it does.
57
58 * The src/mkindex.c program generates some C code that implements
59 static lookup tables. See the header comment in the source code
60 for details on what it does.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
61
--- BUILD.txt
+++ BUILD.txt
@@ -1,62 +1,56 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
---------------------------------------------------------------------------
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
---------------------------------------------------------------------------
1 All of the source code for fossil is contained in the src/ subdirectory.
2 But there is a lot of generated code, so you will probably want to
3 use the Makefile. To do a complete build, just type:
4
5 make
6
7 That should work out-of-the-box on Macs and Linux systems. If you are
8 building on a Windows box, install MinGW as well as MinGW's make (or
9 MSYS). You can then type:
10
11 make -f Makefile.w32
12
13 If you have trouble, or you want to do something fancy, just look at
14 top level makefile. There are 6 configuration options that are all well
15 commented. Instead of editing the Makefile, consider copying the Makefile
16 to an alternative name such as "GNUMakefile", "BSDMakefile", or "makefile"
17 and editing the copy.
18
19 Out of source builds?
20 --------------------------------------------------------------------------
21
22 An out of source build is pretty easy:
23
24 1. Make a new directory to do the builds in.
25 2. Copy "Makefile" from the source into the build directory and
26 modify the SRCDIR macro along the lines of:
27
28 SRCDIR=../src
29
30 3. type: "make"
31
32 This will now keep all generates files seperate from the maintained
33 source code.
34
35 --------------------------------------------------------------------------
36
37 Here are some notes on what is happening behind the scenes:
38
39 * The Makefile just sets up a few macros and then invokes the
40 real makefile in src/main.mk. The src/main.mk makefile is
41 automatically generated by a TCL script found at src/makemake.tcl.
42 Do not edit src/main.mk directly. Update src/makemake.tcl and
43 then rerun it.
44
45 * The *.h header files are automatically generated using a program
46 called "makeheaders". Source code to the makeheaders program is
47 found in src/makeheaders.c. Documentation is found in
48 src/makeheaders.html.
49
50 * Most *.c source files are preprocessed using a program called
51 "translate". The sources to translate are found in src/translate.c.
52 A header comment in src/translate.c explains in detail what it does.
53
54 * The src/mkindex.c program generates some C code that implements
55 static lookup tables. See the header comment in the source code
56 for details on what it does.
57

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button