Fossil SCM
Update the makefile.wiki documentation page to talk about the mkbuiltin.exe program used for generating the builtin_data.h header file.
Commit
8a8177071f861b49589d1aa61000ab5465ddeded
Parent
ee5b8648987d93c…
1 file changed
+25
-4
+25
-4
| --- www/makefile.wiki | ||
| +++ www/makefile.wiki | ||
| @@ -57,29 +57,36 @@ | ||
| 57 | 57 | |
| 58 | 58 | The VERSION.h header file is generated from other information sources |
| 59 | 59 | using a small program called: |
| 60 | 60 | |
| 61 | 61 | 9. mkversion.c |
| 62 | + | |
| 63 | +The builtin_data.h header file contains the definitions of C-language | |
| 64 | +byte-array constants that contain various resources such as scripts and | |
| 65 | +images. The builtin_data.h header file is generate from the original | |
| 66 | +resource files using a small program called: | |
| 67 | + | |
| 68 | + 10 mkbuiltin.c | |
| 62 | 69 | |
| 63 | 70 | The src/ subdirectory also contains documentation about the |
| 64 | 71 | makeheaders preprocessor program: |
| 65 | 72 | |
| 66 | - 10. [../src/makeheaders.html | makeheaders.html] | |
| 73 | + 11. [../src/makeheaders.html | makeheaders.html] | |
| 67 | 74 | |
| 68 | 75 | Click on the link to read this documentation. In addition there is |
| 69 | 76 | a [http://www.tcl.tk/ | Tcl] script used to build the various makefiles: |
| 70 | 77 | |
| 71 | - 11. makemake.tcl | |
| 78 | + 12. makemake.tcl | |
| 72 | 79 | |
| 73 | 80 | Running this Tcl script will automatically regenerate all makefiles. |
| 74 | 81 | In order to add a new source file to the Fossil implementation, simply |
| 75 | 82 | edit makemake.tcl to add the new filename, then rerun the script, and |
| 76 | 83 | all of the makefiles for all targets will be rebuild. |
| 77 | 84 | |
| 78 | 85 | Finally, there is one of the makefiles generated by makemake.tcl: |
| 79 | 86 | |
| 80 | - 12. main.mk | |
| 87 | + 13. main.mk | |
| 81 | 88 | |
| 82 | 89 | The main.mk makefile is invoked from the Makefile in the top-level |
| 83 | 90 | directory. The main.mk is generated by makemake.tcl and should not |
| 84 | 91 | be hand edited. Other makefiles generated by makemake.tcl are in |
| 85 | 92 | other subdirectories (currently all in the win/ subdirectory). |
| @@ -105,11 +112,11 @@ | ||
| 105 | 112 | |
| 106 | 113 | The VERSION.h header file is generated by |
| 107 | 114 | a C program: src/mkversion.c. |
| 108 | 115 | To run the VERSION.h generator, first compile the src/mkversion.c |
| 109 | 116 | source file into a command-line program (named "mkversion.exe") |
| 110 | -than run: | |
| 117 | +then run: | |
| 111 | 118 | |
| 112 | 119 | <blockquote><pre> |
| 113 | 120 | mkversion.exe manifest.uuid manifest VERSION >VERSION.h |
| 114 | 121 | </pre></blockquote> |
| 115 | 122 | |
| @@ -116,10 +123,24 @@ | ||
| 116 | 123 | The pathnames in the above command might need to be adjusted to get the |
| 117 | 124 | directories right. The point is that the manifest.uuid, manifest, and |
| 118 | 125 | VERSION files |
| 119 | 126 | in the root of the source tree are the three arguments and |
| 120 | 127 | the generated VERSION.h file appears on standard output. |
| 128 | + | |
| 129 | +The builtin_data.h header file is generated by a C program: src/mkbuiltin.c. | |
| 130 | +The builtin_data.h file contains C-langauge byte-array definitions for | |
| 131 | +the content of resource files used by Fossil. To generate the | |
| 132 | +builtin_data.h file, first compile the mkbuiltin.c program, then run: | |
| 133 | + | |
| 134 | +<blockquote><pre> | |
| 135 | +mkbuiltin.exe diff.tcl <i>OtherFiles...</i> >builtin_data.h | |
| 136 | +</pre></blockquote> | |
| 137 | + | |
| 138 | +At the time of this writing, the "diff.tcl" script (a Tcl/Tk script used | |
| 139 | +to generate implement --tk option on the diff command) is the only resource | |
| 140 | +file processed using mkbuiltin.exe. However, new resources will likely be | |
| 141 | +added using this facility in future versions of Fossil. | |
| 121 | 142 | |
| 122 | 143 | <a name="preprocessing"></a> |
| 123 | 144 | <h1>4.0 Preprocessing</h1> |
| 124 | 145 | |
| 125 | 146 | There are three preprocessors for the Fossil sources. The mkindex |
| 126 | 147 |
| --- www/makefile.wiki | |
| +++ www/makefile.wiki | |
| @@ -57,29 +57,36 @@ | |
| 57 | |
| 58 | The VERSION.h header file is generated from other information sources |
| 59 | using a small program called: |
| 60 | |
| 61 | 9. mkversion.c |
| 62 | |
| 63 | The src/ subdirectory also contains documentation about the |
| 64 | makeheaders preprocessor program: |
| 65 | |
| 66 | 10. [../src/makeheaders.html | makeheaders.html] |
| 67 | |
| 68 | Click on the link to read this documentation. In addition there is |
| 69 | a [http://www.tcl.tk/ | Tcl] script used to build the various makefiles: |
| 70 | |
| 71 | 11. makemake.tcl |
| 72 | |
| 73 | Running this Tcl script will automatically regenerate all makefiles. |
| 74 | In order to add a new source file to the Fossil implementation, simply |
| 75 | edit makemake.tcl to add the new filename, then rerun the script, and |
| 76 | all of the makefiles for all targets will be rebuild. |
| 77 | |
| 78 | Finally, there is one of the makefiles generated by makemake.tcl: |
| 79 | |
| 80 | 12. main.mk |
| 81 | |
| 82 | The main.mk makefile is invoked from the Makefile in the top-level |
| 83 | directory. The main.mk is generated by makemake.tcl and should not |
| 84 | be hand edited. Other makefiles generated by makemake.tcl are in |
| 85 | other subdirectories (currently all in the win/ subdirectory). |
| @@ -105,11 +112,11 @@ | |
| 105 | |
| 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") |
| 110 | than run: |
| 111 | |
| 112 | <blockquote><pre> |
| 113 | mkversion.exe manifest.uuid manifest VERSION >VERSION.h |
| 114 | </pre></blockquote> |
| 115 | |
| @@ -116,10 +123,24 @@ | |
| 116 | The pathnames in the above command might need to be adjusted to get the |
| 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. |
| 121 | |
| 122 | <a name="preprocessing"></a> |
| 123 | <h1>4.0 Preprocessing</h1> |
| 124 | |
| 125 | There are three preprocessors for the Fossil sources. The mkindex |
| 126 |
| --- www/makefile.wiki | |
| +++ www/makefile.wiki | |
| @@ -57,29 +57,36 @@ | |
| 57 | |
| 58 | The VERSION.h header file is generated from other information sources |
| 59 | using a small program called: |
| 60 | |
| 61 | 9. mkversion.c |
| 62 | |
| 63 | The builtin_data.h header file contains the definitions of C-language |
| 64 | byte-array constants that contain various resources such as scripts and |
| 65 | images. The builtin_data.h header file is generate from the original |
| 66 | resource files using a small program called: |
| 67 | |
| 68 | 10 mkbuiltin.c |
| 69 | |
| 70 | The src/ subdirectory also contains documentation about the |
| 71 | makeheaders preprocessor program: |
| 72 | |
| 73 | 11. [../src/makeheaders.html | makeheaders.html] |
| 74 | |
| 75 | Click on the link to read this documentation. In addition there is |
| 76 | a [http://www.tcl.tk/ | Tcl] script used to build the various makefiles: |
| 77 | |
| 78 | 12. makemake.tcl |
| 79 | |
| 80 | Running this Tcl script will automatically regenerate all makefiles. |
| 81 | In order to add a new source file to the Fossil implementation, simply |
| 82 | edit makemake.tcl to add the new filename, then rerun the script, and |
| 83 | all of the makefiles for all targets will be rebuild. |
| 84 | |
| 85 | Finally, there is one of the makefiles generated by makemake.tcl: |
| 86 | |
| 87 | 13. main.mk |
| 88 | |
| 89 | The main.mk makefile is invoked from the Makefile in the top-level |
| 90 | directory. The main.mk is generated by makemake.tcl and should not |
| 91 | be hand edited. Other makefiles generated by makemake.tcl are in |
| 92 | other subdirectories (currently all in the win/ subdirectory). |
| @@ -105,11 +112,11 @@ | |
| 112 | |
| 113 | The VERSION.h header file is generated by |
| 114 | a C program: src/mkversion.c. |
| 115 | To run the VERSION.h generator, first compile the src/mkversion.c |
| 116 | source file into a command-line program (named "mkversion.exe") |
| 117 | then run: |
| 118 | |
| 119 | <blockquote><pre> |
| 120 | mkversion.exe manifest.uuid manifest VERSION >VERSION.h |
| 121 | </pre></blockquote> |
| 122 | |
| @@ -116,10 +123,24 @@ | |
| 123 | The pathnames in the above command might need to be adjusted to get the |
| 124 | directories right. The point is that the manifest.uuid, manifest, and |
| 125 | VERSION files |
| 126 | in the root of the source tree are the three arguments and |
| 127 | the generated VERSION.h file appears on standard output. |
| 128 | |
| 129 | The builtin_data.h header file is generated by a C program: src/mkbuiltin.c. |
| 130 | The builtin_data.h file contains C-langauge byte-array definitions for |
| 131 | the content of resource files used by Fossil. To generate the |
| 132 | builtin_data.h file, first compile the mkbuiltin.c program, then run: |
| 133 | |
| 134 | <blockquote><pre> |
| 135 | mkbuiltin.exe diff.tcl <i>OtherFiles...</i> >builtin_data.h |
| 136 | </pre></blockquote> |
| 137 | |
| 138 | At the time of this writing, the "diff.tcl" script (a Tcl/Tk script used |
| 139 | to generate implement --tk option on the diff command) is the only resource |
| 140 | file processed using mkbuiltin.exe. However, new resources will likely be |
| 141 | added using this facility in future versions of Fossil. |
| 142 | |
| 143 | <a name="preprocessing"></a> |
| 144 | <h1>4.0 Preprocessing</h1> |
| 145 | |
| 146 | There are three preprocessors for the Fossil sources. The mkindex |
| 147 |