Fossil SCM

Minor documentation updates.

drh 2010-03-06 13:39 trunk
Commit 46d98dd5552cffcd9b4cf29800fb27a341236f0e
Parent d6e09ac9343ab2f…
5 files changed +1 -4 +21 -6 +9 -8 -13 +1 -1
~ www/build.wiki ~ www/embeddeddoc.wiki ~ www/quickstart.wiki ~ www/webui.wiki ~ www/wikitheory.wiki
M www/build.wiki
+1 -4
--- www/build.wiki
+++ www/build.wiki
@@ -34,13 +34,10 @@
3434
3535
 <li><p>Select a version of of fossil you want to download. Click on its
3636
 link. Note that you must successfully log in as "anonymous" in step 1
3737
 above in order to see the link to the detailed version information.</p></li>
3838
39
-<li><p>On the version information page, click on the "[details]" hyperlink
40
-that appears right after the check-in comment at the top of the page.</p>
41
-
4239
 <li><p>Finally, click on the
4340
 "Zip Archive" link. This link will build a ZIP archive of the
4441
 complete source code and download it to your browser.
4542
 </ol>
4643
@@ -54,11 +51,11 @@
5451
 ZIP archive you downloaded into that directory. You should be
5552
 in the top-level folder of that directory</p></li>
5653
5754
 <li><p><b>(Optional:)</b>
5855
 Edit the Makefile to set it up like you want. You probably do not
59
-need to do anything. Do not be intimidated: There are only 5
56
+need to do anything. Do not be intimidated: There are less than 10
6057
 variables in the makefile that can be changed. The whole Makefile
6158
 is only a few dozen lines long and most of those lines are comments.</p>
6259
6360
 <li><p>Type "<b>make</b>"
6461
 </ol>
6562
--- www/build.wiki
+++ www/build.wiki
@@ -34,13 +34,10 @@
34
35 <li><p>Select a version of of fossil you want to download. Click on its
36 link. Note that you must successfully log in as "anonymous" in step 1
37 above in order to see the link to the detailed version information.</p></li>
38
39 <li><p>On the version information page, click on the "[details]" hyperlink
40 that appears right after the check-in comment at the top of the page.</p>
41
42 <li><p>Finally, click on the
43 "Zip Archive" link. This link will build a ZIP archive of the
44 complete source code and download it to your browser.
45 </ol>
46
@@ -54,11 +51,11 @@
54 ZIP archive you downloaded into that directory. You should be
55 in the top-level folder of that directory</p></li>
56
57 <li><p><b>(Optional:)</b>
58 Edit the Makefile to set it up like you want. You probably do not
59 need to do anything. Do not be intimidated: There are only 5
60 variables in the makefile that can be changed. The whole Makefile
61 is only a few dozen lines long and most of those lines are comments.</p>
62
63 <li><p>Type "<b>make</b>"
64 </ol>
65
--- www/build.wiki
+++ www/build.wiki
@@ -34,13 +34,10 @@
34
35 <li><p>Select a version of of fossil you want to download. Click on its
36 link. Note that you must successfully log in as "anonymous" in step 1
37 above in order to see the link to the detailed version information.</p></li>
38
 
 
 
39 <li><p>Finally, click on the
40 "Zip Archive" link. This link will build a ZIP archive of the
41 complete source code and download it to your browser.
42 </ol>
43
@@ -54,11 +51,11 @@
51 ZIP archive you downloaded into that directory. You should be
52 in the top-level folder of that directory</p></li>
53
54 <li><p><b>(Optional:)</b>
55 Edit the Makefile to set it up like you want. You probably do not
56 need to do anything. Do not be intimidated: There are less than 10
57 variables in the makefile that can be changed. The whole Makefile
58 is only a few dozen lines long and most of those lines are comments.</p>
59
60 <li><p>Type "<b>make</b>"
61 </ol>
62
M www/embeddeddoc.wiki
+21 -6
--- www/embeddeddoc.wiki
+++ www/embeddeddoc.wiki
@@ -58,12 +58,12 @@
5858
 only works when you start your server using the "<b>fossil server</b>"
5959
 or "<b>fossil ui</b>"
6060
 command line and is intended to show what the documentation you are currently
6161
 editing looks like before you check it in.
6262
63
-Finally, the <i>&lt;filename&gt;</i> element of the URL is the full
64
-pathname of the documentation file starting from the root of the source
63
+Finally, the <i>&lt;filename&gt;</i> element of the URL is the
64
+pathname of the documentation file relative to the root of the source
6565
 tree.
6666
6767
 The mimetype (and thus the rendering) of documentation files is
6868
 determined by the file suffix. Fossil currently understands 192
6969
 different file suffixes, including all the popular ones such as
@@ -110,14 +110,29 @@
110110
 For example, to see the version of this document associated with
111111
 check-in [9be1b00392], simply replace the "<b>/tip/</b>" with
112112
 "<b>/9be1b00392/</b>". You can also substitute the symbolic name
113113
 for a particular version or branch. For example, you might
114114
 replace "<b>/tip/</b>" with "<b>/trunk/</b>" to get the latest
115
-version of this document in the "trunk" branch. (As of this writing,
116
-the self-hosting fossil repository only has a single branch "trunk" and
117
-so "trunk" and "tip" amount to the same thing, but they would be different
118
-in a project with multiple branches.)
115
+version of this document in the "trunk" branch. The symbolic name
116
+can also be a date and time string in any of the following formats:</p>
117
+
118
+<ul>
119
+<li> <i>YYYY-MM-DD</i>
120
+<li> <i>YYYY-MM-DD</i><b>T</b><i>HH:MM</i>
121
+<li> <i>YYYY-MM-DD</i><b>T</b><i>HH:MM:SS</i>
122
+</ul>
123
+
124
+When the symbolic name is a date and time, fossil shows the version
125
+of the document that was most recently checked in as of the date
126
+and time specified. So, for example, to see what the fossil website
127
+looked like at the beginning of 2010, enter:
128
+
129
+<blockquote>
130
+<a href="http://www.fossil-scm.org/index.html/doc/2010-01-01/www/index.wiki">
131
+http://www.fossil-scm.org/index.html/doc/<b>2010-01-01</b>/www/index.wiki
132
+</a>
133
+</blockquote>
119134
120135
 The file that encodes this document is stored in the fossil source tree under
121136
 the name "<b>www/embeddeddoc.wiki</b>" and so that name forms the
122137
 last part of the URL for this document.
123138
124139
--- www/embeddeddoc.wiki
+++ www/embeddeddoc.wiki
@@ -58,12 +58,12 @@
58 only works when you start your server using the "<b>fossil server</b>"
59 or "<b>fossil ui</b>"
60 command line and is intended to show what the documentation you are currently
61 editing looks like before you check it in.
62
63 Finally, the <i>&lt;filename&gt;</i> element of the URL is the full
64 pathname of the documentation file starting from the root of the source
65 tree.
66
67 The mimetype (and thus the rendering) of documentation files is
68 determined by the file suffix. Fossil currently understands 192
69 different file suffixes, including all the popular ones such as
@@ -110,14 +110,29 @@
110 For example, to see the version of this document associated with
111 check-in [9be1b00392], simply replace the "<b>/tip/</b>" with
112 "<b>/9be1b00392/</b>". You can also substitute the symbolic name
113 for a particular version or branch. For example, you might
114 replace "<b>/tip/</b>" with "<b>/trunk/</b>" to get the latest
115 version of this document in the "trunk" branch. (As of this writing,
116 the self-hosting fossil repository only has a single branch "trunk" and
117 so "trunk" and "tip" amount to the same thing, but they would be different
118 in a project with multiple branches.)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
119
120 The file that encodes this document is stored in the fossil source tree under
121 the name "<b>www/embeddeddoc.wiki</b>" and so that name forms the
122 last part of the URL for this document.
123
124
--- www/embeddeddoc.wiki
+++ www/embeddeddoc.wiki
@@ -58,12 +58,12 @@
58 only works when you start your server using the "<b>fossil server</b>"
59 or "<b>fossil ui</b>"
60 command line and is intended to show what the documentation you are currently
61 editing looks like before you check it in.
62
63 Finally, the <i>&lt;filename&gt;</i> element of the URL is the
64 pathname of the documentation file relative to the root of the source
65 tree.
66
67 The mimetype (and thus the rendering) of documentation files is
68 determined by the file suffix. Fossil currently understands 192
69 different file suffixes, including all the popular ones such as
@@ -110,14 +110,29 @@
110 For example, to see the version of this document associated with
111 check-in [9be1b00392], simply replace the "<b>/tip/</b>" with
112 "<b>/9be1b00392/</b>". You can also substitute the symbolic name
113 for a particular version or branch. For example, you might
114 replace "<b>/tip/</b>" with "<b>/trunk/</b>" to get the latest
115 version of this document in the "trunk" branch. The symbolic name
116 can also be a date and time string in any of the following formats:</p>
117
118 <ul>
119 <li> <i>YYYY-MM-DD</i>
120 <li> <i>YYYY-MM-DD</i><b>T</b><i>HH:MM</i>
121 <li> <i>YYYY-MM-DD</i><b>T</b><i>HH:MM:SS</i>
122 </ul>
123
124 When the symbolic name is a date and time, fossil shows the version
125 of the document that was most recently checked in as of the date
126 and time specified. So, for example, to see what the fossil website
127 looked like at the beginning of 2010, enter:
128
129 <blockquote>
130 <a href="http://www.fossil-scm.org/index.html/doc/2010-01-01/www/index.wiki">
131 http://www.fossil-scm.org/index.html/doc/<b>2010-01-01</b>/www/index.wiki
132 </a>
133 </blockquote>
134
135 The file that encodes this document is stored in the fossil source tree under
136 the name "<b>www/embeddeddoc.wiki</b>" and so that name forms the
137 last part of the URL for this document.
138
139
M www/quickstart.wiki
+9 -8
--- www/quickstart.wiki
+++ www/quickstart.wiki
@@ -67,19 +67,20 @@
6767
6868
 <blockquote>
6969
 <b>fossil ui </b><i> repository-filename</i>
7070
 </blockquote>
7171
72
- <p>This starts a webserver listening on port 8080. You can
73
- specify a different port using the <b>-port</b> option on the command-line.
74
- After the server is running, fossil will then attempt to launch your
75
- web browser and make it point to this web server. If your system
72
+ <p>This starts a web server then automatically launches your
73
+ web browser and makes it point to this web server. If your system
7674
 has an unusual configuration, fossil might not be able to figure out
77
- how to start your web browser. In that case, start the web browser
78
- yourself and point it at http://localhost:8080/. Click on the
79
- "Admin" link on the menu bar to start configuring your repository.</p>
80
-
75
+ how to start your web browser. In that case, first tell fossil
76
+ where to find your web browser using a command like this:</p>
77
+
78
+ <blockquote>
79
+ <b>fossil setting web-browser </b><i> path-to-web-browser</i>
80
+ </blockquote>
81
+
8182
 <p>By default, fossil does not require a login for HTTP connections
8283
 coming in from the IP loopback address 127.0.0.1. You can, and perhaps
8384
 should, change this after you create a few users.</p>
8485
8586
 <p>When you are finished configuring, just press Control-C or use
8687
--- www/quickstart.wiki
+++ www/quickstart.wiki
@@ -67,19 +67,20 @@
67
68 <blockquote>
69 <b>fossil ui </b><i> repository-filename</i>
70 </blockquote>
71
72 <p>This starts a webserver listening on port 8080. You can
73 specify a different port using the <b>-port</b> option on the command-line.
74 After the server is running, fossil will then attempt to launch your
75 web browser and make it point to this web server. If your system
76 has an unusual configuration, fossil might not be able to figure out
77 how to start your web browser. In that case, start the web browser
78 yourself and point it at http://localhost:8080/. Click on the
79 "Admin" link on the menu bar to start configuring your repository.</p>
80
 
 
 
81 <p>By default, fossil does not require a login for HTTP connections
82 coming in from the IP loopback address 127.0.0.1. You can, and perhaps
83 should, change this after you create a few users.</p>
84
85 <p>When you are finished configuring, just press Control-C or use
86
--- www/quickstart.wiki
+++ www/quickstart.wiki
@@ -67,19 +67,20 @@
67
68 <blockquote>
69 <b>fossil ui </b><i> repository-filename</i>
70 </blockquote>
71
72 <p>This starts a web server then automatically launches your
73 web browser and makes it point to this web server. If your system
 
 
74 has an unusual configuration, fossil might not be able to figure out
75 how to start your web browser. In that case, first tell fossil
76 where to find your web browser using a command like this:</p>
77
78 <blockquote>
79 <b>fossil setting web-browser </b><i> path-to-web-browser</i>
80 </blockquote>
81
82 <p>By default, fossil does not require a login for HTTP connections
83 coming in from the IP loopback address 127.0.0.1. You can, and perhaps
84 should, change this after you create a few users.</p>
85
86 <p>When you are finished configuring, just press Control-C or use
87
M www/webui.wiki
-13
--- www/webui.wiki
+++ www/webui.wiki
@@ -148,18 +148,5 @@
148148
 </verbatim>
149149
150150
 As always, you'll want to adjust the pathnames to whatever is appropriate
151151
 for your system. The xinetd setup uses a different syntax but follows
152152
 the same idea.
153
-
154
-Once you have your new repository running on the network server, delete
155
-the original repository from your local machine, then clone the repository
156
-off of the server:
157
-
158
- <b>fossil clone http://user:[email protected]/cgi-bin/my-project</b>
159
-
160
-(As always, adjust the URL as appropriate for your installation.)
161
-After copying a repository, it is important to reclone it onto new machines.
162
-Each repository has a random "repository ID" and repositories will not
163
-sync with another repository having the same ID (to avoid sync loops).
164
-Cloning the repository will give you a new repository ID in your local
165
-copy and allow you to sync with the server.
166153
--- www/webui.wiki
+++ www/webui.wiki
@@ -148,18 +148,5 @@
148 </verbatim>
149
150 As always, you'll want to adjust the pathnames to whatever is appropriate
151 for your system. The xinetd setup uses a different syntax but follows
152 the same idea.
153
154 Once you have your new repository running on the network server, delete
155 the original repository from your local machine, then clone the repository
156 off of the server:
157
158 <b>fossil clone http://user:[email protected]/cgi-bin/my-project</b>
159
160 (As always, adjust the URL as appropriate for your installation.)
161 After copying a repository, it is important to reclone it onto new machines.
162 Each repository has a random "repository ID" and repositories will not
163 sync with another repository having the same ID (to avoid sync loops).
164 Cloning the repository will give you a new repository ID in your local
165 copy and allow you to sync with the server.
166
--- www/webui.wiki
+++ www/webui.wiki
@@ -148,18 +148,5 @@
148 </verbatim>
149
150 As always, you'll want to adjust the pathnames to whatever is appropriate
151 for your system. The xinetd setup uses a different syntax but follows
152 the same idea.
 
 
 
 
 
 
 
 
 
 
 
 
 
153
M www/wikitheory.wiki
+1 -1
--- www/wikitheory.wiki
+++ www/wikitheory.wiki
@@ -8,11 +8,11 @@
88
 * [./embeddeddoc.wiki | Embedded documentation] files whose
99
 name ends in "wiki".
1010
1111
 The [/wiki_rules | formatting rules] for fossil wiki
1212
 are designed to be simple and intuitive. The idea is that wiki provides
13
-paragaph breaks, numbered and bulletted lists, and hyperlinking for
13
+paragraph breaks, numbered and bulletted lists, and hyperlinking for
1414
 simple documents together with a safe subset of HTML for more complex
1515
 formatting tasks.
1616
1717
 Some commentators feel that the use of HTML is a mistake and that
1818
 fossil should use the markup language of the
1919
--- www/wikitheory.wiki
+++ www/wikitheory.wiki
@@ -8,11 +8,11 @@
8 * [./embeddeddoc.wiki | Embedded documentation] files whose
9 name ends in "wiki".
10
11 The [/wiki_rules | formatting rules] for fossil wiki
12 are designed to be simple and intuitive. The idea is that wiki provides
13 paragaph breaks, numbered and bulletted lists, and hyperlinking for
14 simple documents together with a safe subset of HTML for more complex
15 formatting tasks.
16
17 Some commentators feel that the use of HTML is a mistake and that
18 fossil should use the markup language of the
19
--- www/wikitheory.wiki
+++ www/wikitheory.wiki
@@ -8,11 +8,11 @@
8 * [./embeddeddoc.wiki | Embedded documentation] files whose
9 name ends in "wiki".
10
11 The [/wiki_rules | formatting rules] for fossil wiki
12 are designed to be simple and intuitive. The idea is that wiki provides
13 paragraph breaks, numbered and bulletted lists, and hyperlinking for
14 simple documents together with a safe subset of HTML for more complex
15 formatting tasks.
16
17 Some commentators feel that the use of HTML is a mistake and that
18 fossil should use the markup language of the
19

Keyboard Shortcuts

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