Fossil SCM
Documentation updates.
Commit
c8893c69ac8ffda38d4891e9b13c4d6eef22f4fb
Parent
bf75ea9852c061e…
7 files changed
+2
-1
+8
-18
+10
+24
-50
+4
-1
+1
-1
+1
-1
+2
-1
| --- src/wiki.c | ||
| +++ src/wiki.c | ||
| @@ -543,11 +543,12 @@ | ||
| 543 | 543 | @ list is supported by wiki. For nested enumerations or for |
| 544 | 544 | @ enumerations that count using letters or roman numerials, use HTML.</p> |
| 545 | 545 | @ <li> <p><b>Indented Paragraphs</b>. |
| 546 | 546 | @ Any paragraph that begins with two or more spaces or a tab and |
| 547 | 547 | @ which is not a bullet or enumeration list item is rendered |
| 548 | - @ indented. Only a single level of indentation is supported by</p> | |
| 548 | + @ indented. Only a single level of indentation is supported by wiki; use | |
| 549 | + @ HTML for deeper indentation.</p> | |
| 549 | 550 | @ <li> <p><b>Hyperlinks</b>. |
| 550 | 551 | @ Text within square brackets ("[...]") becomes a hyperlink. The |
| 551 | 552 | @ target can be a wiki page name, the UUID of a check-in or ticket, |
| 552 | 553 | @ the name of an image, or a URL. By default, the target is displayed |
| 553 | 554 | @ as the text of the hyperlink. But you can specify alternative text |
| 554 | 555 |
| --- src/wiki.c | |
| +++ src/wiki.c | |
| @@ -543,11 +543,12 @@ | |
| 543 | @ list is supported by wiki. For nested enumerations or for |
| 544 | @ enumerations that count using letters or roman numerials, use HTML.</p> |
| 545 | @ <li> <p><b>Indented Paragraphs</b>. |
| 546 | @ Any paragraph that begins with two or more spaces or a tab and |
| 547 | @ which is not a bullet or enumeration list item is rendered |
| 548 | @ indented. Only a single level of indentation is supported by</p> |
| 549 | @ <li> <p><b>Hyperlinks</b>. |
| 550 | @ Text within square brackets ("[...]") becomes a hyperlink. The |
| 551 | @ target can be a wiki page name, the UUID of a check-in or ticket, |
| 552 | @ the name of an image, or a URL. By default, the target is displayed |
| 553 | @ as the text of the hyperlink. But you can specify alternative text |
| 554 |
| --- src/wiki.c | |
| +++ src/wiki.c | |
| @@ -543,11 +543,12 @@ | |
| 543 | @ list is supported by wiki. For nested enumerations or for |
| 544 | @ enumerations that count using letters or roman numerials, use HTML.</p> |
| 545 | @ <li> <p><b>Indented Paragraphs</b>. |
| 546 | @ Any paragraph that begins with two or more spaces or a tab and |
| 547 | @ which is not a bullet or enumeration list item is rendered |
| 548 | @ indented. Only a single level of indentation is supported by wiki; use |
| 549 | @ HTML for deeper indentation.</p> |
| 550 | @ <li> <p><b>Hyperlinks</b>. |
| 551 | @ Text within square brackets ("[...]") becomes a hyperlink. The |
| 552 | @ target can be a wiki page name, the UUID of a check-in or ticket, |
| 553 | @ the name of an image, or a URL. By default, the target is displayed |
| 554 | @ as the text of the hyperlink. But you can specify alternative text |
| 555 |
+8
-18
| --- www/embeddeddoc.wiki | ||
| +++ www/embeddeddoc.wiki | ||
| @@ -1,8 +1,9 @@ | ||
| 1 | 1 | <h1>Managing Project Documentation</h1> |
| 2 | 2 | |
| 3 | -Fossil provides a built-in [/wiki | wiki] that can be used to store the | |
| 3 | +Fossil provides a built-in <a href="wikitheory.wiki">wiki</a> | |
| 4 | +that can be used to store the | |
| 4 | 5 | documentation for a project. This is sufficient for many projects. |
| 5 | 6 | If your project is well-served by wiki documentation, then you |
| 6 | 7 | need read no further. |
| 7 | 8 | |
| 8 | 9 | But fossil also supports embedding project documentation as |
| @@ -58,42 +59,31 @@ | ||
| 58 | 59 | Finally, the <i><filename></i> element of the URL is the full |
| 59 | 60 | pathname of the documentation file starting from the root of the source |
| 60 | 61 | tree. |
| 61 | 62 | |
| 62 | 63 | The mimetype (and thus the rendering) of documentation files is |
| 63 | -determined by the file suffix. Fossil currently understands the | |
| 64 | -following file suffixes or embedded documents: | |
| 65 | - | |
| 66 | - * .css | |
| 67 | - * .gif | |
| 68 | - * .htm | |
| 69 | - * .html | |
| 70 | - * .jpg | |
| 71 | - * .jpeg | |
| 72 | - * .png | |
| 73 | - * .txt | |
| 74 | - * .wiki | |
| 64 | +determined by the file suffix. Fossil currently understands 192 | |
| 65 | +different file suffixes, including all the popular ones such as | |
| 66 | +".css", ".gif", ".htm", ".html", ".jpg", ".jpeg", ".png", and ".txt". | |
| 75 | 67 | |
| 76 | 68 | Documentation files whose names end in ".wiki" use the |
| 77 | 69 | [/wiki_rules | same markup as wiki pages] - |
| 78 | 70 | a safe subset of HTML together with some rules for paragraph |
| 79 | 71 | breaks, lists, and hyperlinks. The ".wiki" and ".txt" pages |
| 80 | 72 | are rendered with the standard fossil header and footer added. |
| 81 | 73 | All other mimetypes are delivered directly to the requesting |
| 82 | 74 | web browser without interpretation, additions, or changes. |
| 83 | 75 | |
| 84 | -The list of allowed suffixes for embedded documents is likely to | |
| 85 | -grow and become user-configurable in future releases of fossil. | |
| 86 | - | |
| 87 | 76 | <h2>Examples</h2> |
| 88 | 77 | |
| 89 | 78 | This file that you are currently reading is an example of |
| 90 | 79 | embedded documentation. The name of this file in the fossil |
| 91 | 80 | source tree is "<b>www/embeddeddoc.wiki</b>". |
| 92 | 81 | You are perhaps looking at this |
| 93 | -file using the URL: | |
| 94 | -[http://www.fossil-scm.org/index.html/doc/tip/www/embeddeddoc.wiki]. | |
| 82 | +file using the URL: | |
| 83 | + | |
| 84 | + [http://www.fossil-scm.org/index.html/doc/tip/www/embeddeddoc.wiki]. | |
| 95 | 85 | |
| 96 | 86 | The first part of this path, the "[http://www.fossil-scm.org/index.html]", |
| 97 | 87 | is the base URL. You might have originally typed: |
| 98 | 88 | [http://www.fossil-scm.org/]. The web server at the www.fossil-scm.org |
| 99 | 89 | site automatically redirects such links by appending "index.html". The |
| 100 | 90 |
| --- www/embeddeddoc.wiki | |
| +++ www/embeddeddoc.wiki | |
| @@ -1,8 +1,9 @@ | |
| 1 | <h1>Managing Project Documentation</h1> |
| 2 | |
| 3 | Fossil provides a built-in [/wiki | wiki] that can be used to store the |
| 4 | documentation for a project. This is sufficient for many projects. |
| 5 | If your project is well-served by wiki documentation, then you |
| 6 | need read no further. |
| 7 | |
| 8 | But fossil also supports embedding project documentation as |
| @@ -58,42 +59,31 @@ | |
| 58 | Finally, the <i><filename></i> element of the URL is the full |
| 59 | pathname of the documentation file starting from the root of the source |
| 60 | tree. |
| 61 | |
| 62 | The mimetype (and thus the rendering) of documentation files is |
| 63 | determined by the file suffix. Fossil currently understands the |
| 64 | following file suffixes or embedded documents: |
| 65 | |
| 66 | * .css |
| 67 | * .gif |
| 68 | * .htm |
| 69 | * .html |
| 70 | * .jpg |
| 71 | * .jpeg |
| 72 | * .png |
| 73 | * .txt |
| 74 | * .wiki |
| 75 | |
| 76 | Documentation files whose names end in ".wiki" use the |
| 77 | [/wiki_rules | same markup as wiki pages] - |
| 78 | a safe subset of HTML together with some rules for paragraph |
| 79 | breaks, lists, and hyperlinks. The ".wiki" and ".txt" pages |
| 80 | are rendered with the standard fossil header and footer added. |
| 81 | All other mimetypes are delivered directly to the requesting |
| 82 | web browser without interpretation, additions, or changes. |
| 83 | |
| 84 | The list of allowed suffixes for embedded documents is likely to |
| 85 | grow and become user-configurable in future releases of fossil. |
| 86 | |
| 87 | <h2>Examples</h2> |
| 88 | |
| 89 | This file that you are currently reading is an example of |
| 90 | embedded documentation. The name of this file in the fossil |
| 91 | source tree is "<b>www/embeddeddoc.wiki</b>". |
| 92 | You are perhaps looking at this |
| 93 | file using the URL: |
| 94 | [http://www.fossil-scm.org/index.html/doc/tip/www/embeddeddoc.wiki]. |
| 95 | |
| 96 | The first part of this path, the "[http://www.fossil-scm.org/index.html]", |
| 97 | is the base URL. You might have originally typed: |
| 98 | [http://www.fossil-scm.org/]. The web server at the www.fossil-scm.org |
| 99 | site automatically redirects such links by appending "index.html". The |
| 100 |
| --- www/embeddeddoc.wiki | |
| +++ www/embeddeddoc.wiki | |
| @@ -1,8 +1,9 @@ | |
| 1 | <h1>Managing Project Documentation</h1> |
| 2 | |
| 3 | Fossil provides a built-in <a href="wikitheory.wiki">wiki</a> |
| 4 | that can be used to store the |
| 5 | documentation for a project. This is sufficient for many projects. |
| 6 | If your project is well-served by wiki documentation, then you |
| 7 | need read no further. |
| 8 | |
| 9 | But fossil also supports embedding project documentation as |
| @@ -58,42 +59,31 @@ | |
| 59 | Finally, the <i><filename></i> element of the URL is the full |
| 60 | pathname of the documentation file starting from the root of the source |
| 61 | tree. |
| 62 | |
| 63 | The mimetype (and thus the rendering) of documentation files is |
| 64 | determined by the file suffix. Fossil currently understands 192 |
| 65 | different file suffixes, including all the popular ones such as |
| 66 | ".css", ".gif", ".htm", ".html", ".jpg", ".jpeg", ".png", and ".txt". |
| 67 | |
| 68 | Documentation files whose names end in ".wiki" use the |
| 69 | [/wiki_rules | same markup as wiki pages] - |
| 70 | a safe subset of HTML together with some rules for paragraph |
| 71 | breaks, lists, and hyperlinks. The ".wiki" and ".txt" pages |
| 72 | are rendered with the standard fossil header and footer added. |
| 73 | All other mimetypes are delivered directly to the requesting |
| 74 | web browser without interpretation, additions, or changes. |
| 75 | |
| 76 | <h2>Examples</h2> |
| 77 | |
| 78 | This file that you are currently reading is an example of |
| 79 | embedded documentation. The name of this file in the fossil |
| 80 | source tree is "<b>www/embeddeddoc.wiki</b>". |
| 81 | You are perhaps looking at this |
| 82 | file using the URL: |
| 83 | |
| 84 | [http://www.fossil-scm.org/index.html/doc/tip/www/embeddeddoc.wiki]. |
| 85 | |
| 86 | The first part of this path, the "[http://www.fossil-scm.org/index.html]", |
| 87 | is the base URL. You might have originally typed: |
| 88 | [http://www.fossil-scm.org/]. The web server at the www.fossil-scm.org |
| 89 | site automatically redirects such links by appending "index.html". The |
| 90 |
+10
| --- www/fileformat.wiki | ||
| +++ www/fileformat.wiki | ||
| @@ -35,10 +35,20 @@ | ||
| 35 | 35 | <li> Wiki Pages </li> |
| 36 | 36 | <li> Ticket Changes </li> |
| 37 | 37 | </ul> |
| 38 | 38 | |
| 39 | 39 | <p>These five artifact types are described in the sequel.</p> |
| 40 | + | |
| 41 | +<p>In the current implementation (as of 2008-10-04) the artifacts that | |
| 42 | +make up a fossil repository are stored in in as delta- and zlib-compressed | |
| 43 | +blobs in an <a href="http://www.sqlite.org/">SQLite</a> database. This | |
| 44 | +is an implementation detail and might change in a future release. For | |
| 45 | +the purpose of this article "file format" means the format of the artifacts, | |
| 46 | +not how the artifacts are stored on disk. It is the artifact format that | |
| 47 | +is intended to be enduring. The specifics of how artifacts are stored on | |
| 48 | +disk, though stable, is not intended to have as long a lifespan as the | |
| 49 | +artifact format.</p> | |
| 40 | 50 | |
| 41 | 51 | <h2>1.0 The Manifest</h2> |
| 42 | 52 | |
| 43 | 53 | <p>A manifest defines a baseline or version of the project |
| 44 | 54 | source tree. The manifest contains a list of artifacts for |
| 45 | 55 |
| --- www/fileformat.wiki | |
| +++ www/fileformat.wiki | |
| @@ -35,10 +35,20 @@ | |
| 35 | <li> Wiki Pages </li> |
| 36 | <li> Ticket Changes </li> |
| 37 | </ul> |
| 38 | |
| 39 | <p>These five artifact types are described in the sequel.</p> |
| 40 | |
| 41 | <h2>1.0 The Manifest</h2> |
| 42 | |
| 43 | <p>A manifest defines a baseline or version of the project |
| 44 | source tree. The manifest contains a list of artifacts for |
| 45 |
| --- www/fileformat.wiki | |
| +++ www/fileformat.wiki | |
| @@ -35,10 +35,20 @@ | |
| 35 | <li> Wiki Pages </li> |
| 36 | <li> Ticket Changes </li> |
| 37 | </ul> |
| 38 | |
| 39 | <p>These five artifact types are described in the sequel.</p> |
| 40 | |
| 41 | <p>In the current implementation (as of 2008-10-04) the artifacts that |
| 42 | make up a fossil repository are stored in in as delta- and zlib-compressed |
| 43 | blobs in an <a href="http://www.sqlite.org/">SQLite</a> database. This |
| 44 | is an implementation detail and might change in a future release. For |
| 45 | the purpose of this article "file format" means the format of the artifacts, |
| 46 | not how the artifacts are stored on disk. It is the artifact format that |
| 47 | is intended to be enduring. The specifics of how artifacts are stored on |
| 48 | disk, though stable, is not intended to have as long a lifespan as the |
| 49 | artifact format.</p> |
| 50 | |
| 51 | <h2>1.0 The Manifest</h2> |
| 52 | |
| 53 | <p>A manifest defines a baseline or version of the project |
| 54 | source tree. The manifest contains a list of artifacts for |
| 55 |
+24
-50
| --- www/index.wiki | ||
| +++ www/index.wiki | ||
| @@ -1,9 +1,9 @@ | ||
| 1 | 1 | <h1>Fossil: Distributed Revision Control, Wiki, and Bug-Tracking</h1> |
| 2 | 2 | |
| 3 | 3 | <p> |
| 4 | -Fossil is a new | |
| 4 | +Fossil is a | |
| 5 | 5 | <a href="http://en.wikipedia.org/wiki/Revision_control"> |
| 6 | 6 | distributed software revision control system</a> that includes an integrated |
| 7 | 7 | <a href="wikitheory.wiki">wiki</a> and an integrated |
| 8 | 8 | <a href="bugtheory.wiki">bug-tracking system</a> all in a single, |
| 9 | 9 | easy-to-use, stand-alone executable. |
| @@ -15,74 +15,48 @@ | ||
| 15 | 15 | <a href="build.wiki">compile it yourself</a>. |
| 16 | 16 | Or you can grab |
| 17 | 17 | <a href="http://www.fossil-scm.org/download.html">precompiled binaries</a>. |
| 18 | 18 | </p> |
| 19 | 19 | |
| 20 | -<p>Features Of Fossil:</p> | |
| 20 | +<p>Feature Summary:</p> | |
| 21 | 21 | |
| 22 | 22 | <ul> |
| 23 | -<li>Supports disconnected, distributed development (like | |
| 24 | -<a href="http://kerneltrap.org/node/4982">git</a>, | |
| 25 | -<a href="http://www.monotone.ca/">monotone</a>, | |
| 26 | -<a href="http://www.selenic.com/mercurial/wiki/index.cgi">mercurial</a>, or | |
| 27 | -<a href="http://www.bitkeeper.com/">bitkeeper</a>) | |
| 28 | -or client/server operation (like | |
| 29 | -<a href="http://www.nongnu.org/cvs/">CVS</a> or | |
| 30 | -<a href="http://subversion.tigris.org/">subversion</a>), | |
| 31 | -or operations on local repositories, | |
| 32 | -or all three at the same time</li> | |
| 33 | -<li>Integrated <a href="bugtheory.wiki">bug tracking</a> and | |
| 34 | -<a href="wikitheory.wiki">wiki</a>, inspired by | |
| 35 | -<a href="http://www.cvstrac.org/">CVSTrac</a> and | |
| 36 | -<a href="http://www.edgewall.com/trac/">Trac</a> but enhanced to | |
| 37 | -support distributed, disconnected operation.</li> | |
| 23 | +<li>Flexible workflow:<ul> | |
| 24 | + <li>Disconnected, distributed development like | |
| 25 | + <a href="http://kerneltrap.org/node/4982">git</a>, | |
| 26 | + <a href="http://www.monotone.ca/">monotone</a>, | |
| 27 | + <a href="http://www.selenic.com/mercurial/wiki/index.cgi">mercurial</a>, | |
| 28 | + and <a href="http://www.bitkeeper.com/">bitkeeper</a> | |
| 29 | + <li>Or, client/server operation like | |
| 30 | + <a href="http://www.nongnu.org/cvs/">CVS</a> and | |
| 31 | + <a href="http://subversion.tigris.org/">subversion</a>, | |
| 32 | + <li>Or, operations on local repositories, | |
| 33 | + <li>Or, all of the above at the same time</ul></li> | |
| 34 | +<li>Integrated, distributed <a href="bugtheory.wiki">bug tracking</a> and | |
| 35 | +<a href="wikitheory.wiki">wiki</a>.</li> | |
| 38 | 36 | <li>Built-in web interface that supports deep archaeological digs through |
| 39 | 37 | the project history.</li> |
| 40 | 38 | <li>All network communication via |
| 41 | 39 | <a href="http://en.wikipedia.org/wiki/HTTP">HTTP</a> with |
| 42 | 40 | <a href="quickstart.wiki#proxy">proxy support</a> |
| 43 | 41 | so that everything works from behind restrictive firewalls.</li> |
| 44 | 42 | <li>Everything (client, server, and utilities) is included in a |
| 45 | 43 | single self-contained executable - trivial to install</li> |
| 46 | -<li>Server runs as <a href="http://www.w3.org/CGI/">CGI</a>, using | |
| 47 | -<a href="http://en.wikipedia.org/wiki/inetd">inetd</a>/<a | |
| 48 | - href="http://www.xinetd.org/">xinetd</a>, or using its own built-in, | |
| 49 | -standalone web server.</li> | |
| 50 | -<li>An entire project contained in single disk file (which also | |
| 51 | -happens to be an <a href="http://www.sqlite.org/">SQLite</a> database.)</li> | |
| 52 | -<li>Trivial to setup and administer</li> | |
| 53 | -<li>Files and versions are identified by their | |
| 54 | -<a href="http://en.wikipedia.org/wiki/SHA-1">SHA1</a> signature.</a> | |
| 55 | -Any unique prefix is sufficient to identify a file | |
| 56 | -or version - usually the first 4 or 5 characters suffice.</li> | |
| 57 | -<li>The <a href="fileformat.wiki">file format</a> designed to be enduring. | |
| 58 | -It is deliberately kept simple, requiring nothing more complex | |
| 59 | -than a text editor and an SHA1 checksum generator to encode or decode.</li> | |
| 44 | +<li>Server runs as <a href="quickstart.wiki#cgiserver">CGI</a>, using | |
| 45 | +<a href="quickstart.wiki#inetdserver">inetd/xinetd</a> | |
| 46 | +or using its own | |
| 47 | +<a href="quickstart.wiki#serversetup">built-in, standalone web server</a>.</li> | |
| 48 | +<li>An entire project contained in single disk file | |
| 49 | +(an <a href="http://www.sqlite.org/">SQLite</a> database.)</li> | |
| 50 | +<li>Uses an <a href="fileformat.wiki">enduring file format</a> that is | |
| 51 | +designed to be readable, searchable, and extensible by people not yet born.</li> | |
| 60 | 52 | <li>Automatic <a href="selfcheck.wiki">self-check</a> |
| 61 | 53 | on repository changes makes it exceedingly |
| 62 | 54 | unlikely that data will ever be lost because of a software bug.</li> |
| 63 | -</ul> | |
| 64 | - | |
| 65 | -<p>Objectives Of Fossil:</p> | |
| 66 | - | |
| 67 | -<ul> | |
| 68 | -<li>Fossil should be ridiculously easy to | |
| 55 | +<li>Ridiculously easy to | |
| 69 | 56 | <a href="build.wiki">install</a> and |
| 70 | 57 | <a href="quickstart.wiki">operate</a>.</li> |
| 71 | -<li>With fossil, it should be possible (and | |
| 72 | -<a href="quickstart.wiki#serversetup">easy</a>) to set up a project | |
| 73 | -on an inexpensive shared-hosting ISP | |
| 74 | -(example: <a href="http://www.he.net/hosting.html">Hurricane Electric</a>) | |
| 75 | -that provides nothing more than web space and CGI capability. | |
| 76 | -Here is <a href="http://www.hwaci.com/cgi-bin/fossil/timeline">a demo</a>.</li> | |
| 77 | -<li>Fossil should provide in-depth historical and status information about the | |
| 78 | -project through a web interface</li> | |
| 79 | -<li>Fossil should provide an historical record of a project that endures | |
| 80 | -for decades or centuries and across multiple generations of hardward | |
| 81 | -and software.</li> | |
| 82 | -<li>Fossil should be easily adaptable to different workflows. Fossil | |
| 83 | -implements mechanism, not policy.</li> | |
| 84 | 58 | </ul> |
| 85 | 59 | |
| 86 | 60 | <p>User Links:</p> |
| 87 | 61 | |
| 88 | 62 | <ul> |
| 89 | 63 |
| --- www/index.wiki | |
| +++ www/index.wiki | |
| @@ -1,9 +1,9 @@ | |
| 1 | <h1>Fossil: Distributed Revision Control, Wiki, and Bug-Tracking</h1> |
| 2 | |
| 3 | <p> |
| 4 | Fossil is a new |
| 5 | <a href="http://en.wikipedia.org/wiki/Revision_control"> |
| 6 | distributed software revision control system</a> that includes an integrated |
| 7 | <a href="wikitheory.wiki">wiki</a> and an integrated |
| 8 | <a href="bugtheory.wiki">bug-tracking system</a> all in a single, |
| 9 | easy-to-use, stand-alone executable. |
| @@ -15,74 +15,48 @@ | |
| 15 | <a href="build.wiki">compile it yourself</a>. |
| 16 | Or you can grab |
| 17 | <a href="http://www.fossil-scm.org/download.html">precompiled binaries</a>. |
| 18 | </p> |
| 19 | |
| 20 | <p>Features Of Fossil:</p> |
| 21 | |
| 22 | <ul> |
| 23 | <li>Supports disconnected, distributed development (like |
| 24 | <a href="http://kerneltrap.org/node/4982">git</a>, |
| 25 | <a href="http://www.monotone.ca/">monotone</a>, |
| 26 | <a href="http://www.selenic.com/mercurial/wiki/index.cgi">mercurial</a>, or |
| 27 | <a href="http://www.bitkeeper.com/">bitkeeper</a>) |
| 28 | or client/server operation (like |
| 29 | <a href="http://www.nongnu.org/cvs/">CVS</a> or |
| 30 | <a href="http://subversion.tigris.org/">subversion</a>), |
| 31 | or operations on local repositories, |
| 32 | or all three at the same time</li> |
| 33 | <li>Integrated <a href="bugtheory.wiki">bug tracking</a> and |
| 34 | <a href="wikitheory.wiki">wiki</a>, inspired by |
| 35 | <a href="http://www.cvstrac.org/">CVSTrac</a> and |
| 36 | <a href="http://www.edgewall.com/trac/">Trac</a> but enhanced to |
| 37 | support distributed, disconnected operation.</li> |
| 38 | <li>Built-in web interface that supports deep archaeological digs through |
| 39 | the project history.</li> |
| 40 | <li>All network communication via |
| 41 | <a href="http://en.wikipedia.org/wiki/HTTP">HTTP</a> with |
| 42 | <a href="quickstart.wiki#proxy">proxy support</a> |
| 43 | so that everything works from behind restrictive firewalls.</li> |
| 44 | <li>Everything (client, server, and utilities) is included in a |
| 45 | single self-contained executable - trivial to install</li> |
| 46 | <li>Server runs as <a href="http://www.w3.org/CGI/">CGI</a>, using |
| 47 | <a href="http://en.wikipedia.org/wiki/inetd">inetd</a>/<a |
| 48 | href="http://www.xinetd.org/">xinetd</a>, or using its own built-in, |
| 49 | standalone web server.</li> |
| 50 | <li>An entire project contained in single disk file (which also |
| 51 | happens to be an <a href="http://www.sqlite.org/">SQLite</a> database.)</li> |
| 52 | <li>Trivial to setup and administer</li> |
| 53 | <li>Files and versions are identified by their |
| 54 | <a href="http://en.wikipedia.org/wiki/SHA-1">SHA1</a> signature.</a> |
| 55 | Any unique prefix is sufficient to identify a file |
| 56 | or version - usually the first 4 or 5 characters suffice.</li> |
| 57 | <li>The <a href="fileformat.wiki">file format</a> designed to be enduring. |
| 58 | It is deliberately kept simple, requiring nothing more complex |
| 59 | than a text editor and an SHA1 checksum generator to encode or decode.</li> |
| 60 | <li>Automatic <a href="selfcheck.wiki">self-check</a> |
| 61 | on repository changes makes it exceedingly |
| 62 | unlikely that data will ever be lost because of a software bug.</li> |
| 63 | </ul> |
| 64 | |
| 65 | <p>Objectives Of Fossil:</p> |
| 66 | |
| 67 | <ul> |
| 68 | <li>Fossil should be ridiculously easy to |
| 69 | <a href="build.wiki">install</a> and |
| 70 | <a href="quickstart.wiki">operate</a>.</li> |
| 71 | <li>With fossil, it should be possible (and |
| 72 | <a href="quickstart.wiki#serversetup">easy</a>) to set up a project |
| 73 | on an inexpensive shared-hosting ISP |
| 74 | (example: <a href="http://www.he.net/hosting.html">Hurricane Electric</a>) |
| 75 | that provides nothing more than web space and CGI capability. |
| 76 | Here is <a href="http://www.hwaci.com/cgi-bin/fossil/timeline">a demo</a>.</li> |
| 77 | <li>Fossil should provide in-depth historical and status information about the |
| 78 | project through a web interface</li> |
| 79 | <li>Fossil should provide an historical record of a project that endures |
| 80 | for decades or centuries and across multiple generations of hardward |
| 81 | and software.</li> |
| 82 | <li>Fossil should be easily adaptable to different workflows. Fossil |
| 83 | implements mechanism, not policy.</li> |
| 84 | </ul> |
| 85 | |
| 86 | <p>User Links:</p> |
| 87 | |
| 88 | <ul> |
| 89 |
| --- www/index.wiki | |
| +++ www/index.wiki | |
| @@ -1,9 +1,9 @@ | |
| 1 | <h1>Fossil: Distributed Revision Control, Wiki, and Bug-Tracking</h1> |
| 2 | |
| 3 | <p> |
| 4 | Fossil is a |
| 5 | <a href="http://en.wikipedia.org/wiki/Revision_control"> |
| 6 | distributed software revision control system</a> that includes an integrated |
| 7 | <a href="wikitheory.wiki">wiki</a> and an integrated |
| 8 | <a href="bugtheory.wiki">bug-tracking system</a> all in a single, |
| 9 | easy-to-use, stand-alone executable. |
| @@ -15,74 +15,48 @@ | |
| 15 | <a href="build.wiki">compile it yourself</a>. |
| 16 | Or you can grab |
| 17 | <a href="http://www.fossil-scm.org/download.html">precompiled binaries</a>. |
| 18 | </p> |
| 19 | |
| 20 | <p>Feature Summary:</p> |
| 21 | |
| 22 | <ul> |
| 23 | <li>Flexible workflow:<ul> |
| 24 | <li>Disconnected, distributed development like |
| 25 | <a href="http://kerneltrap.org/node/4982">git</a>, |
| 26 | <a href="http://www.monotone.ca/">monotone</a>, |
| 27 | <a href="http://www.selenic.com/mercurial/wiki/index.cgi">mercurial</a>, |
| 28 | and <a href="http://www.bitkeeper.com/">bitkeeper</a> |
| 29 | <li>Or, client/server operation like |
| 30 | <a href="http://www.nongnu.org/cvs/">CVS</a> and |
| 31 | <a href="http://subversion.tigris.org/">subversion</a>, |
| 32 | <li>Or, operations on local repositories, |
| 33 | <li>Or, all of the above at the same time</ul></li> |
| 34 | <li>Integrated, distributed <a href="bugtheory.wiki">bug tracking</a> and |
| 35 | <a href="wikitheory.wiki">wiki</a>.</li> |
| 36 | <li>Built-in web interface that supports deep archaeological digs through |
| 37 | the project history.</li> |
| 38 | <li>All network communication via |
| 39 | <a href="http://en.wikipedia.org/wiki/HTTP">HTTP</a> with |
| 40 | <a href="quickstart.wiki#proxy">proxy support</a> |
| 41 | so that everything works from behind restrictive firewalls.</li> |
| 42 | <li>Everything (client, server, and utilities) is included in a |
| 43 | single self-contained executable - trivial to install</li> |
| 44 | <li>Server runs as <a href="quickstart.wiki#cgiserver">CGI</a>, using |
| 45 | <a href="quickstart.wiki#inetdserver">inetd/xinetd</a> |
| 46 | or using its own |
| 47 | <a href="quickstart.wiki#serversetup">built-in, standalone web server</a>.</li> |
| 48 | <li>An entire project contained in single disk file |
| 49 | (an <a href="http://www.sqlite.org/">SQLite</a> database.)</li> |
| 50 | <li>Uses an <a href="fileformat.wiki">enduring file format</a> that is |
| 51 | designed to be readable, searchable, and extensible by people not yet born.</li> |
| 52 | <li>Automatic <a href="selfcheck.wiki">self-check</a> |
| 53 | on repository changes makes it exceedingly |
| 54 | unlikely that data will ever be lost because of a software bug.</li> |
| 55 | <li>Ridiculously easy to |
| 56 | <a href="build.wiki">install</a> and |
| 57 | <a href="quickstart.wiki">operate</a>.</li> |
| 58 | </ul> |
| 59 | |
| 60 | <p>User Links:</p> |
| 61 | |
| 62 | <ul> |
| 63 |
+4
-1
| --- www/quickstart.wiki | ||
| +++ www/quickstart.wiki | ||
| @@ -210,11 +210,13 @@ | ||
| 210 | 210 | but you can specify a different port using the <b>-port</b> command.</p> |
| 211 | 211 | |
| 212 | 212 | <p>Command-line servers like this are useful when two people want |
| 213 | 213 | to share a repository on temporary or ad-hoc basis. For a more |
| 214 | 214 | permanent installation, you should use either the CGI server or the |
| 215 | - inetd server. To use the CGI server, create a CGI script that | |
| 215 | + inetd server. | |
| 216 | + <a name="cgiserver"></a> | |
| 217 | + To use the CGI server, create a CGI script that | |
| 216 | 218 | looks something like this:</p> |
| 217 | 219 | |
| 218 | 220 | <blockquote><b> |
| 219 | 221 | #!/usr/local/bin/fossil<br> |
| 220 | 222 | repository: /home/proj1/repos1.fossil |
| @@ -223,10 +225,11 @@ | ||
| 223 | 225 | <p>Adjust the paths in this CGI script to match your installation |
| 224 | 226 | and make sure that repository file at the directory that contains it |
| 225 | 227 | are both readable and writable by the user that CGI scripts run as. |
| 226 | 228 | Then point clients at the CGI script. That's all there is to it!</p> |
| 227 | 229 | |
| 230 | + <a name="inetdserver"></a> | |
| 228 | 231 | <p>You can also run fossil off of inetd or xinetd. For an inetd |
| 229 | 232 | installation, make an entry in /etc/inetd.conf that looks something |
| 230 | 233 | like this:</p> |
| 231 | 234 | |
| 232 | 235 | <blockquote><b> |
| 233 | 236 |
| --- www/quickstart.wiki | |
| +++ www/quickstart.wiki | |
| @@ -210,11 +210,13 @@ | |
| 210 | but you can specify a different port using the <b>-port</b> command.</p> |
| 211 | |
| 212 | <p>Command-line servers like this are useful when two people want |
| 213 | to share a repository on temporary or ad-hoc basis. For a more |
| 214 | permanent installation, you should use either the CGI server or the |
| 215 | inetd server. To use the CGI server, create a CGI script that |
| 216 | looks something like this:</p> |
| 217 | |
| 218 | <blockquote><b> |
| 219 | #!/usr/local/bin/fossil<br> |
| 220 | repository: /home/proj1/repos1.fossil |
| @@ -223,10 +225,11 @@ | |
| 223 | <p>Adjust the paths in this CGI script to match your installation |
| 224 | and make sure that repository file at the directory that contains it |
| 225 | are both readable and writable by the user that CGI scripts run as. |
| 226 | Then point clients at the CGI script. That's all there is to it!</p> |
| 227 | |
| 228 | <p>You can also run fossil off of inetd or xinetd. For an inetd |
| 229 | installation, make an entry in /etc/inetd.conf that looks something |
| 230 | like this:</p> |
| 231 | |
| 232 | <blockquote><b> |
| 233 |
| --- www/quickstart.wiki | |
| +++ www/quickstart.wiki | |
| @@ -210,11 +210,13 @@ | |
| 210 | but you can specify a different port using the <b>-port</b> command.</p> |
| 211 | |
| 212 | <p>Command-line servers like this are useful when two people want |
| 213 | to share a repository on temporary or ad-hoc basis. For a more |
| 214 | permanent installation, you should use either the CGI server or the |
| 215 | inetd server. |
| 216 | <a name="cgiserver"></a> |
| 217 | To use the CGI server, create a CGI script that |
| 218 | looks something like this:</p> |
| 219 | |
| 220 | <blockquote><b> |
| 221 | #!/usr/local/bin/fossil<br> |
| 222 | repository: /home/proj1/repos1.fossil |
| @@ -223,10 +225,11 @@ | |
| 225 | <p>Adjust the paths in this CGI script to match your installation |
| 226 | and make sure that repository file at the directory that contains it |
| 227 | are both readable and writable by the user that CGI scripts run as. |
| 228 | Then point clients at the CGI script. That's all there is to it!</p> |
| 229 | |
| 230 | <a name="inetdserver"></a> |
| 231 | <p>You can also run fossil off of inetd or xinetd. For an inetd |
| 232 | installation, make an entry in /etc/inetd.conf that looks something |
| 233 | like this:</p> |
| 234 | |
| 235 | <blockquote><b> |
| 236 |
+1
-1
| --- www/selfcheck.wiki | ||
| +++ www/selfcheck.wiki | ||
| @@ -10,11 +10,11 @@ | ||
| 10 | 10 | lose your files. This note describes the defensive measures that |
| 11 | 11 | fossil uses to help prevent file loss due to bugs. |
| 12 | 12 | </p> |
| 13 | 13 | |
| 14 | 14 | <p><i>Follow-up as of 2007-11-24:</i> |
| 15 | -<i>Reiterated on 2008-05-16:</i> | |
| 15 | +<i>Reiterated on 2008-05-16 and again on 2008-10-04:</i> | |
| 16 | 16 | Fossil has been hosting itself and many other projects for |
| 17 | 17 | months now. Many bugs have been encountered. But, thanks in large |
| 18 | 18 | part to the defensive measures described here, no data has been |
| 19 | 19 | lost. The integrity checks are doing their job well.</p> |
| 20 | 20 | |
| 21 | 21 |
| --- www/selfcheck.wiki | |
| +++ www/selfcheck.wiki | |
| @@ -10,11 +10,11 @@ | |
| 10 | lose your files. This note describes the defensive measures that |
| 11 | fossil uses to help prevent file loss due to bugs. |
| 12 | </p> |
| 13 | |
| 14 | <p><i>Follow-up as of 2007-11-24:</i> |
| 15 | <i>Reiterated on 2008-05-16:</i> |
| 16 | Fossil has been hosting itself and many other projects for |
| 17 | months now. Many bugs have been encountered. But, thanks in large |
| 18 | part to the defensive measures described here, no data has been |
| 19 | lost. The integrity checks are doing their job well.</p> |
| 20 | |
| 21 |
| --- www/selfcheck.wiki | |
| +++ www/selfcheck.wiki | |
| @@ -10,11 +10,11 @@ | |
| 10 | lose your files. This note describes the defensive measures that |
| 11 | fossil uses to help prevent file loss due to bugs. |
| 12 | </p> |
| 13 | |
| 14 | <p><i>Follow-up as of 2007-11-24:</i> |
| 15 | <i>Reiterated on 2008-05-16 and again on 2008-10-04:</i> |
| 16 | Fossil has been hosting itself and many other projects for |
| 17 | months now. Many bugs have been encountered. But, thanks in large |
| 18 | part to the defensive measures described here, no data has been |
| 19 | lost. The integrity checks are doing their job well.</p> |
| 20 | |
| 21 |
+1
-1
| --- www/wikitheory.wiki | ||
| +++ www/wikitheory.wiki | ||
| @@ -19,11 +19,11 @@ | ||
| 19 | 19 | |
| 20 | 20 | Each wiki page has its own revision history which is independent of |
| 21 | 21 | the sequence of baselines (check-ins). Wiki pages can branch and merge |
| 22 | 22 | just like baselines, though as of this writing (2008-07-29) there is |
| 23 | 23 | no mechanism in the user interface to support branching and merging. |
| 24 | -The currently implementation of the wiki shows the version of the wiki | |
| 24 | +The current implementation of the wiki shows the version of the wiki | |
| 25 | 25 | pages that has the most recent timestamp. |
| 26 | 26 | |
| 27 | 27 | In other words, if two users make unrelated changes to the same wiki |
| 28 | 28 | page on separate repositories, then those repositories are synced, |
| 29 | 29 | the wiki page will fork. The web interface will display whichever edit |
| 30 | 30 |
| --- www/wikitheory.wiki | |
| +++ www/wikitheory.wiki | |
| @@ -19,11 +19,11 @@ | |
| 19 | |
| 20 | Each wiki page has its own revision history which is independent of |
| 21 | the sequence of baselines (check-ins). Wiki pages can branch and merge |
| 22 | just like baselines, though as of this writing (2008-07-29) there is |
| 23 | no mechanism in the user interface to support branching and merging. |
| 24 | The currently implementation of the wiki shows the version of the wiki |
| 25 | pages that has the most recent timestamp. |
| 26 | |
| 27 | In other words, if two users make unrelated changes to the same wiki |
| 28 | page on separate repositories, then those repositories are synced, |
| 29 | the wiki page will fork. The web interface will display whichever edit |
| 30 |
| --- www/wikitheory.wiki | |
| +++ www/wikitheory.wiki | |
| @@ -19,11 +19,11 @@ | |
| 19 | |
| 20 | Each wiki page has its own revision history which is independent of |
| 21 | the sequence of baselines (check-ins). Wiki pages can branch and merge |
| 22 | just like baselines, though as of this writing (2008-07-29) there is |
| 23 | no mechanism in the user interface to support branching and merging. |
| 24 | The current implementation of the wiki shows the version of the wiki |
| 25 | pages that has the most recent timestamp. |
| 26 | |
| 27 | In other words, if two users make unrelated changes to the same wiki |
| 28 | page on separate repositories, then those repositories are synced, |
| 29 | the wiki page will fork. The web interface will display whichever edit |
| 30 |