Fossil SCM
Clarify linenoise
Commit
8a310633a778fa978657fb042a8f58a1c2aa4efc
Parent
f6ab9e2867b92fb…
1 file changed
+16
-8
+16
-8
| --- www/makefile.wiki | ||
| +++ www/makefile.wiki | ||
| @@ -35,58 +35,66 @@ | ||
| 35 | 35 | code files that do not participate in the preprocessing steps. |
| 36 | 36 | These three files that implement SQLite are: |
| 37 | 37 | |
| 38 | 38 | 4. sqlite3.c |
| 39 | 39 | 5. sqlite3.h |
| 40 | - 6. shell.c (which optionally uses linenoise.c and linenoise.h) | |
| 40 | + 6. shell.c | |
| 41 | 41 | |
| 42 | 42 | The sqlite3.c and sqlite3.h source files are byte-for-byte copies of a |
| 43 | 43 | standard [http://www.sqlite.org/amalgamation.html | amalgamation]. |
| 44 | 44 | The shell.c source file is code for the SQLite |
| 45 | 45 | [http://www.sqlite.org/sqlite.html | command-line shell] that is used |
| 46 | 46 | to help implement the [/help/sqlite3 | fossil sql] command. The |
| 47 | 47 | shell.c source file is also a byte-for-byte copy of the |
| 48 | 48 | shell.c file from the SQLite release. |
| 49 | + | |
| 50 | +The SQLite shell.c file uses the [https://github.com/antirez/linenoise | | |
| 51 | +linenoise] library to implement line editing. linenoise comprises two | |
| 52 | +source files which were copied from the upstream repository with only | |
| 53 | +very minor portability edits: | |
| 54 | + | |
| 55 | + 7. linenoise.c | |
| 56 | + 8. linenoise.h | |
| 49 | 57 | |
| 50 | 58 | The TH1 script engine is implemented using files: |
| 51 | 59 | |
| 52 | - 7. th.c | |
| 53 | - 8. th.h | |
| 60 | + 9. th.c | |
| 61 | + 10. th.h | |
| 54 | 62 | |
| 55 | 63 | These two files are imports like the SQLite source files, |
| 56 | 64 | and so are not preprocessed. |
| 57 | 65 | |
| 58 | 66 | The VERSION.h header file is generated from other information sources |
| 59 | 67 | using a small program called: |
| 60 | 68 | |
| 61 | - 9. mkversion.c | |
| 69 | + 11. mkversion.c | |
| 62 | 70 | |
| 63 | 71 | The builtin_data.h header file contains the definitions of C-language |
| 64 | 72 | byte-array constants that contain various resources such as scripts and |
| 65 | 73 | images. The builtin_data.h header file is generate from the original |
| 66 | 74 | resource files using a small program called: |
| 67 | 75 | |
| 68 | - 10 mkbuiltin.c | |
| 76 | + 12 mkbuiltin.c | |
| 69 | 77 | |
| 70 | 78 | The src/ subdirectory also contains documentation about the |
| 71 | 79 | makeheaders preprocessor program: |
| 72 | 80 | |
| 73 | - 11. [../src/makeheaders.html | makeheaders.html] | |
| 81 | + 13. [../src/makeheaders.html | makeheaders.html] | |
| 74 | 82 | |
| 75 | 83 | Click on the link to read this documentation. In addition there is |
| 76 | 84 | a [http://www.tcl-lang.org/ | Tcl] script used to build the various makefiles: |
| 77 | 85 | |
| 78 | - 12. makemake.tcl | |
| 86 | + 14. makemake.tcl | |
| 79 | 87 | |
| 80 | 88 | Running this Tcl script will automatically regenerate all makefiles. |
| 81 | 89 | In order to add a new source file to the Fossil implementation, simply |
| 82 | 90 | edit makemake.tcl to add the new filename, then rerun the script, and |
| 83 | 91 | all of the makefiles for all targets will be rebuild. |
| 84 | 92 | |
| 85 | 93 | Finally, there is one of the makefiles generated by makemake.tcl: |
| 86 | 94 | |
| 87 | - 13. main.mk | |
| 95 | + 15. main.mk | |
| 88 | 96 | |
| 89 | 97 | The main.mk makefile is invoked from the Makefile in the top-level |
| 90 | 98 | directory. The main.mk is generated by makemake.tcl and should not |
| 91 | 99 | be hand edited. Other makefiles generated by makemake.tcl are in |
| 92 | 100 | other subdirectories (currently all in the win/ subdirectory). |
| 93 | 101 |
| --- www/makefile.wiki | |
| +++ www/makefile.wiki | |
| @@ -35,58 +35,66 @@ | |
| 35 | code files that do not participate in the preprocessing steps. |
| 36 | These three files that implement SQLite are: |
| 37 | |
| 38 | 4. sqlite3.c |
| 39 | 5. sqlite3.h |
| 40 | 6. shell.c (which optionally uses linenoise.c and linenoise.h) |
| 41 | |
| 42 | The sqlite3.c and sqlite3.h source files are byte-for-byte copies of a |
| 43 | standard [http://www.sqlite.org/amalgamation.html | amalgamation]. |
| 44 | The shell.c source file is code for the SQLite |
| 45 | [http://www.sqlite.org/sqlite.html | command-line shell] that is used |
| 46 | to help implement the [/help/sqlite3 | fossil sql] command. The |
| 47 | shell.c source file is also a byte-for-byte copy of the |
| 48 | shell.c file from the SQLite release. |
| 49 | |
| 50 | The TH1 script engine is implemented using files: |
| 51 | |
| 52 | 7. th.c |
| 53 | 8. th.h |
| 54 | |
| 55 | These two files are imports like the SQLite source files, |
| 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 |
| 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-lang.org/ | 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). |
| 93 |
| --- www/makefile.wiki | |
| +++ www/makefile.wiki | |
| @@ -35,58 +35,66 @@ | |
| 35 | code files that do not participate in the preprocessing steps. |
| 36 | These three files that implement SQLite are: |
| 37 | |
| 38 | 4. sqlite3.c |
| 39 | 5. sqlite3.h |
| 40 | 6. shell.c |
| 41 | |
| 42 | The sqlite3.c and sqlite3.h source files are byte-for-byte copies of a |
| 43 | standard [http://www.sqlite.org/amalgamation.html | amalgamation]. |
| 44 | The shell.c source file is code for the SQLite |
| 45 | [http://www.sqlite.org/sqlite.html | command-line shell] that is used |
| 46 | to help implement the [/help/sqlite3 | fossil sql] command. The |
| 47 | shell.c source file is also a byte-for-byte copy of the |
| 48 | shell.c file from the SQLite release. |
| 49 | |
| 50 | The SQLite shell.c file uses the [https://github.com/antirez/linenoise | |
| 51 | linenoise] library to implement line editing. linenoise comprises two |
| 52 | source files which were copied from the upstream repository with only |
| 53 | very minor portability edits: |
| 54 | |
| 55 | 7. linenoise.c |
| 56 | 8. linenoise.h |
| 57 | |
| 58 | The TH1 script engine is implemented using files: |
| 59 | |
| 60 | 9. th.c |
| 61 | 10. th.h |
| 62 | |
| 63 | These two files are imports like the SQLite source files, |
| 64 | and so are not preprocessed. |
| 65 | |
| 66 | The VERSION.h header file is generated from other information sources |
| 67 | using a small program called: |
| 68 | |
| 69 | 11. mkversion.c |
| 70 | |
| 71 | The builtin_data.h header file contains the definitions of C-language |
| 72 | byte-array constants that contain various resources such as scripts and |
| 73 | images. The builtin_data.h header file is generate from the original |
| 74 | resource files using a small program called: |
| 75 | |
| 76 | 12 mkbuiltin.c |
| 77 | |
| 78 | The src/ subdirectory also contains documentation about the |
| 79 | makeheaders preprocessor program: |
| 80 | |
| 81 | 13. [../src/makeheaders.html | makeheaders.html] |
| 82 | |
| 83 | Click on the link to read this documentation. In addition there is |
| 84 | a [http://www.tcl-lang.org/ | Tcl] script used to build the various makefiles: |
| 85 | |
| 86 | 14. makemake.tcl |
| 87 | |
| 88 | Running this Tcl script will automatically regenerate all makefiles. |
| 89 | In order to add a new source file to the Fossil implementation, simply |
| 90 | edit makemake.tcl to add the new filename, then rerun the script, and |
| 91 | all of the makefiles for all targets will be rebuild. |
| 92 | |
| 93 | Finally, there is one of the makefiles generated by makemake.tcl: |
| 94 | |
| 95 | 15. main.mk |
| 96 | |
| 97 | The main.mk makefile is invoked from the Makefile in the top-level |
| 98 | directory. The main.mk is generated by makemake.tcl and should not |
| 99 | be hand edited. Other makefiles generated by makemake.tcl are in |
| 100 | other subdirectories (currently all in the win/ subdirectory). |
| 101 |