Fossil SCM
Updates to the makefile documentation.
Commit
ef0b48de0d59ecf9c10fa5adff66f4d535952258
Parent
cad1b4a4348527b…
2 files changed
+42
-14
+1
-1
+42
-14
| --- www/build.wiki | ||
| +++ www/build.wiki | ||
| @@ -1,16 +1,29 @@ | ||
| 1 | 1 | <title>Building and Installing Fossil</title> |
| 2 | 2 | |
| 3 | -<p>This page describes how to build and install Fossil. The | |
| 4 | -whole process is designed to be very easy.</p> | |
| 5 | - | |
| 6 | 3 | <h2>0.0 Using A Pre-compiled Binary</h2> |
| 7 | 4 | |
| 8 | -<p>You can skip steps 1.0 and 2.0 below by downloading | |
| 5 | +<p>You can skip all of the following by downloading | |
| 9 | 6 | a <a href="http://www.fossil-scm.org/download.html">pre-compiled binary</a> |
| 10 | -appropriate for your platform. If you use a pre-compiled binary | |
| 11 | -jump immediate to step 3.0.</p> | |
| 7 | +appropriate for your platform and putting that self-contained binary | |
| 8 | +someplace on your $PATH. | |
| 9 | +To uninstall, simply delete the binary. | |
| 10 | +To upgrade from an older release, just overwrite the older binary with | |
| 11 | +the newer one.</p> | |
| 12 | + | |
| 13 | +<h2>0.1 Executive Summary</h2> | |
| 14 | + | |
| 15 | +<p>Building and installing is very simple. Three steps:</p> | |
| 16 | + | |
| 17 | +<ol> | |
| 18 | +<li> Download and unpack a source tarball or ZIP. | |
| 19 | +<li> <b>./configure; make</b> | |
| 20 | +<li> Move or copy the resulting "fossil" executable to someplace | |
| 21 | + on your $PATH. | |
| 22 | +</ol> | |
| 23 | + | |
| 24 | +<p><hr> | |
| 12 | 25 | |
| 13 | 26 | <h2>1.0 Obtaining The Source Code</h2> |
| 14 | 27 | |
| 15 | 28 | <p>Fossil is self-hosting, so you can obtain a ZIP archive containing |
| 16 | 29 | a snapshot of the latest version directly from fossil's own fossil |
| @@ -47,22 +60,37 @@ | ||
| 47 | 60 | <li value="6"> |
| 48 | 61 | <p>Create a directory to hold the source code. Then unarchive the |
| 49 | 62 | ZIP or tarball you downloaded into that directory. You should be |
| 50 | 63 | in the top-level folder of that directory</p></li> |
| 51 | 64 | |
| 52 | -<li><p><b>(Optional:)</b> | |
| 53 | -Edit the Makefile to set it up like you want. You probably do not | |
| 54 | -need to do anything. Do not be intimidated: There are less than 10 | |
| 55 | -variables in the makefile that can be changed. The whole Makefile | |
| 56 | -is only a few dozen lines long and most of those lines are comments.</p> | |
| 65 | +<li><i>(Optional, unix only)</i> | |
| 66 | +Run <b>./configure</b> to construct a makefile. | |
| 67 | + | |
| 68 | +<ol type="a"> | |
| 69 | +<li><p> | |
| 70 | +If you do not have the OpenSSL library installed on your system, then | |
| 71 | +add <b>--with-openssl=none</b> to omit the https functionality. | |
| 72 | + | |
| 73 | +<li><p> | |
| 74 | +To build a statically linked binary (suitable for use inside a chroot | |
| 75 | +jail) add the <b>--static</b> option. | |
| 76 | + | |
| 77 | +<li><p> | |
| 78 | +Other configuration options can be seen by running | |
| 79 | +<b>./configure --help</b> | |
| 80 | +</ol> | |
| 57 | 81 | |
| 58 | 82 | <li><p>Run make to build the "fossil" or "fossil.exe" executable. The |
| 59 | -details depend on your platform and compiler: | |
| 83 | +details depend on your platform and compiler. | |
| 60 | 84 | |
| 61 | 85 | <ol type="a"> |
| 62 | -<li><p><i>Unix</i> → the default Makefile works on most unix and | |
| 63 | -unix-like systems. Simply type "<b>make</b>". | |
| 86 | +<li><p><i>Unix</i> → the configure-generated Makefile should work on | |
| 87 | +all unix and unix-like systems. Simply type "<b>make</b>". | |
| 88 | + | |
| 89 | +<li><p><i>Unix without running "configure"</i> → if you prefer to avoid running configure, you | |
| 90 | +can also use: <b>make -f Makefile.classic</b>. You may want to make minor | |
| 91 | +edits to Makefile.classic to configure the build for your system. | |
| 64 | 92 | |
| 65 | 93 | <li><p><i>Msys/MinGW</i> → Use the |
| 66 | 94 | mingw makefile: "<b>make -f win/Makefile.mingw</b>" |
| 67 | 95 | |
| 68 | 96 | <li><p><i>VC++</i> → Use the msc makefile. First |
| 69 | 97 |
| --- www/build.wiki | |
| +++ www/build.wiki | |
| @@ -1,16 +1,29 @@ | |
| 1 | <title>Building and Installing Fossil</title> |
| 2 | |
| 3 | <p>This page describes how to build and install Fossil. The |
| 4 | whole process is designed to be very easy.</p> |
| 5 | |
| 6 | <h2>0.0 Using A Pre-compiled Binary</h2> |
| 7 | |
| 8 | <p>You can skip steps 1.0 and 2.0 below by downloading |
| 9 | a <a href="http://www.fossil-scm.org/download.html">pre-compiled binary</a> |
| 10 | appropriate for your platform. If you use a pre-compiled binary |
| 11 | jump immediate to step 3.0.</p> |
| 12 | |
| 13 | <h2>1.0 Obtaining The Source Code</h2> |
| 14 | |
| 15 | <p>Fossil is self-hosting, so you can obtain a ZIP archive containing |
| 16 | a snapshot of the latest version directly from fossil's own fossil |
| @@ -47,22 +60,37 @@ | |
| 47 | <li value="6"> |
| 48 | <p>Create a directory to hold the source code. Then unarchive the |
| 49 | ZIP or tarball you downloaded into that directory. You should be |
| 50 | in the top-level folder of that directory</p></li> |
| 51 | |
| 52 | <li><p><b>(Optional:)</b> |
| 53 | Edit the Makefile to set it up like you want. You probably do not |
| 54 | need to do anything. Do not be intimidated: There are less than 10 |
| 55 | variables in the makefile that can be changed. The whole Makefile |
| 56 | is only a few dozen lines long and most of those lines are comments.</p> |
| 57 | |
| 58 | <li><p>Run make to build the "fossil" or "fossil.exe" executable. The |
| 59 | details depend on your platform and compiler: |
| 60 | |
| 61 | <ol type="a"> |
| 62 | <li><p><i>Unix</i> → the default Makefile works on most unix and |
| 63 | unix-like systems. Simply type "<b>make</b>". |
| 64 | |
| 65 | <li><p><i>Msys/MinGW</i> → Use the |
| 66 | mingw makefile: "<b>make -f win/Makefile.mingw</b>" |
| 67 | |
| 68 | <li><p><i>VC++</i> → Use the msc makefile. First |
| 69 |
| --- www/build.wiki | |
| +++ www/build.wiki | |
| @@ -1,16 +1,29 @@ | |
| 1 | <title>Building and Installing Fossil</title> |
| 2 | |
| 3 | <h2>0.0 Using A Pre-compiled Binary</h2> |
| 4 | |
| 5 | <p>You can skip all of the following by downloading |
| 6 | a <a href="http://www.fossil-scm.org/download.html">pre-compiled binary</a> |
| 7 | appropriate for your platform and putting that self-contained binary |
| 8 | someplace on your $PATH. |
| 9 | To uninstall, simply delete the binary. |
| 10 | To upgrade from an older release, just overwrite the older binary with |
| 11 | the newer one.</p> |
| 12 | |
| 13 | <h2>0.1 Executive Summary</h2> |
| 14 | |
| 15 | <p>Building and installing is very simple. Three steps:</p> |
| 16 | |
| 17 | <ol> |
| 18 | <li> Download and unpack a source tarball or ZIP. |
| 19 | <li> <b>./configure; make</b> |
| 20 | <li> Move or copy the resulting "fossil" executable to someplace |
| 21 | on your $PATH. |
| 22 | </ol> |
| 23 | |
| 24 | <p><hr> |
| 25 | |
| 26 | <h2>1.0 Obtaining The Source Code</h2> |
| 27 | |
| 28 | <p>Fossil is self-hosting, so you can obtain a ZIP archive containing |
| 29 | a snapshot of the latest version directly from fossil's own fossil |
| @@ -47,22 +60,37 @@ | |
| 60 | <li value="6"> |
| 61 | <p>Create a directory to hold the source code. Then unarchive the |
| 62 | ZIP or tarball you downloaded into that directory. You should be |
| 63 | in the top-level folder of that directory</p></li> |
| 64 | |
| 65 | <li><i>(Optional, unix only)</i> |
| 66 | Run <b>./configure</b> to construct a makefile. |
| 67 | |
| 68 | <ol type="a"> |
| 69 | <li><p> |
| 70 | If you do not have the OpenSSL library installed on your system, then |
| 71 | add <b>--with-openssl=none</b> to omit the https functionality. |
| 72 | |
| 73 | <li><p> |
| 74 | To build a statically linked binary (suitable for use inside a chroot |
| 75 | jail) add the <b>--static</b> option. |
| 76 | |
| 77 | <li><p> |
| 78 | Other configuration options can be seen by running |
| 79 | <b>./configure --help</b> |
| 80 | </ol> |
| 81 | |
| 82 | <li><p>Run make to build the "fossil" or "fossil.exe" executable. The |
| 83 | details depend on your platform and compiler. |
| 84 | |
| 85 | <ol type="a"> |
| 86 | <li><p><i>Unix</i> → the configure-generated Makefile should work on |
| 87 | all unix and unix-like systems. Simply type "<b>make</b>". |
| 88 | |
| 89 | <li><p><i>Unix without running "configure"</i> → if you prefer to avoid running configure, you |
| 90 | can also use: <b>make -f Makefile.classic</b>. You may want to make minor |
| 91 | edits to Makefile.classic to configure the build for your system. |
| 92 | |
| 93 | <li><p><i>Msys/MinGW</i> → Use the |
| 94 | mingw makefile: "<b>make -f win/Makefile.mingw</b>" |
| 95 | |
| 96 | <li><p><i>VC++</i> → Use the msc makefile. First |
| 97 |
+1
-1
| --- www/makefile.wiki | ||
| +++ www/makefile.wiki | ||
| @@ -126,11 +126,11 @@ | ||
| 126 | 126 | preprocessor must be run after translate. |
| 127 | 127 | |
| 128 | 128 | <h2>4.1 The mkindex preprocessor</h2> |
| 129 | 129 | |
| 130 | 130 | The mkindex program scans the "src.c" source files looking for special |
| 131 | -comments that identify routines that implement of various Fossil commands, | |
| 131 | +comments that identify routines that implement various Fossil commands, | |
| 132 | 132 | web interface methods, and help text comments. The mkindex program |
| 133 | 133 | generates some C code that Fossil uses in order to dispatch commands and |
| 134 | 134 | HTTP requests and to show on-line help. Compile the mkindex program |
| 135 | 135 | from the mkindex.c source file. Then run: |
| 136 | 136 | |
| 137 | 137 |
| --- www/makefile.wiki | |
| +++ www/makefile.wiki | |
| @@ -126,11 +126,11 @@ | |
| 126 | preprocessor must be run after translate. |
| 127 | |
| 128 | <h2>4.1 The mkindex preprocessor</h2> |
| 129 | |
| 130 | The mkindex program scans the "src.c" source files looking for special |
| 131 | comments that identify routines that implement of various Fossil commands, |
| 132 | web interface methods, and help text comments. The mkindex program |
| 133 | generates some C code that Fossil uses in order to dispatch commands and |
| 134 | HTTP requests and to show on-line help. Compile the mkindex program |
| 135 | from the mkindex.c source file. Then run: |
| 136 | |
| 137 |
| --- www/makefile.wiki | |
| +++ www/makefile.wiki | |
| @@ -126,11 +126,11 @@ | |
| 126 | preprocessor must be run after translate. |
| 127 | |
| 128 | <h2>4.1 The mkindex preprocessor</h2> |
| 129 | |
| 130 | The mkindex program scans the "src.c" source files looking for special |
| 131 | comments that identify routines that implement various Fossil commands, |
| 132 | web interface methods, and help text comments. The mkindex program |
| 133 | generates some C code that Fossil uses in order to dispatch commands and |
| 134 | HTTP requests and to show on-line help. Compile the mkindex program |
| 135 | from the mkindex.c source file. Then run: |
| 136 | |
| 137 |