| | @@ -52,29 +52,34 @@ |
| 52 | 52 | 7. th.c |
| 53 | 53 | 8. th.h |
| 54 | 54 | |
| 55 | 55 | These two files are imports like the SQLite source files, |
| 56 | 56 | and so are not preprocessed. |
| 57 | + |
| 58 | +The VERSION.h header file is generated from other information sources |
| 59 | +using a small program called: |
| 60 | + |
| 61 | + 9. mkversion.c |
| 57 | 62 | |
| 58 | 63 | The src/ subdirectory also contains documentation about the |
| 59 | 64 | makeheaders preprocessor program: |
| 60 | 65 | |
| 61 | | - 9. [../src/makeheaders.html | makeheaders.html] |
| 66 | + 10. [../src/makeheaders.html | makeheaders.html] |
| 62 | 67 | |
| 63 | 68 | Click on the link to read this documentation. In addition there is |
| 64 | 69 | a [http://www.tcl.tk/ | Tcl] script used to build the various makefiles: |
| 65 | 70 | |
| 66 | | - 10. makemake.tcl |
| 71 | + 11. makemake.tcl |
| 67 | 72 | |
| 68 | 73 | Running this Tcl script will automatically regenerate all makefiles. |
| 69 | 74 | In order to add a new source file to the Fossil implementation, simply |
| 70 | 75 | edit makemake.tcl to add the new filename, then rerun the script, and |
| 71 | 76 | all of the makefiles for all targets will be rebuild. |
| 72 | 77 | |
| 73 | 78 | Finally, there is one of the makefiles generated by makemake.tcl: |
| 74 | 79 | |
| 75 | | - 11. main.mk |
| 80 | + 12. main.mk |
| 76 | 81 | |
| 77 | 82 | The main.mk makefile is invoked from the Makefile in the top-level |
| 78 | 83 | directory. The main.mk is generated by makemake.tcl and should not |
| 79 | 84 | be hand edited. Other makefiles generated by makemake.tcl are in |
| 80 | 85 | other subdirectories (currently all in the win/ subdirectory). |
| | @@ -89,31 +94,32 @@ |
| 89 | 94 | |
| 90 | 95 | <h1>3.0 Automatically generated files</h1> |
| 91 | 96 | |
| 92 | 97 | The "VERSION.h" header file contains some C preprocessor macros that |
| 93 | 98 | identify the version of Fossil that is to be build. The VERSION.h file is |
| 94 | | -generated automatically from information extracted from the "manifest" |
| 95 | | -and "manifest.uuid" source files in the root directory of the source tree. |
| 99 | +generated automatically from information extracted from the "manifest", |
| 100 | +"manifest.uuid", and "VERSION" source files in the root directory of the |
| 101 | +source tree. |
| 96 | 102 | (The "manifest" and "manifest.uuid" files are automatically generated and |
| 97 | 103 | updated by Fossil itself. See the [/help/setting | fossil set manifest] |
| 98 | 104 | command for additional information.) |
| 99 | 105 | |
| 100 | | -Under unix, there is an AWK script that converts manifest and manifest.uuid |
| 101 | | -into VERSION.h. For windows, there is a C program: win/version.c. |
| 102 | | -(Unix builds could also used the version.c convert, if desired, but AWK |
| 103 | | -seems easier there.) To run the VERSION.h generator, first compile |
| 104 | | -the win/version.c source file into a command-line program (named "version.exe") |
| 106 | +The VERSION.h header file is generated by |
| 107 | +a C program: src/mkversion.c. |
| 108 | +To run the VERSION.h generator, first compile the src/mkversion.c |
| 109 | + source file into a command-line program (named "mkversion.exe") |
| 105 | 110 | than run: |
| 106 | 111 | |
| 107 | 112 | <blockquote><pre> |
| 108 | | -version.exe manifest.uuid manifest VERSION.h |
| 113 | +mkversion.exe manifest.uuid manifest VERSION >VERSION.h |
| 109 | 114 | </pre></blockquote> |
| 110 | 115 | |
| 111 | 116 | The pathnames in the above command might need to be adjusted to get the |
| 112 | | -directories right. The point is that the manifest.uuid and manifest files |
| 113 | | -in the root of the source tree are the first two arguments and the name of |
| 114 | | -the generated VERSION.h file is the third and final argument. |
| 117 | +directories right. The point is that the manifest.uuid, manifest, and |
| 118 | +VERSION files |
| 119 | +in the root of the source tree are the three arguments and |
| 120 | +the generated VERSION.h file appears on standard output. |
| 115 | 121 | |
| 116 | 122 | <h1>4.0 Preprocessing</h1> |
| 117 | 123 | |
| 118 | 124 | There are three preprocessors for the Fossil sources. The mkindex |
| 119 | 125 | and translate preprocessors can be run in any order. The makeheaders |
| 120 | 126 | |