Fossil SCM
Minor documentation updates.
Commit
7794d72c5f29d2c029e98caf3ea45e67e63a8102
Parent
770fd05fe8595a2…
3 files changed
+17
-12
-4
+2
-1
+17
-12
| --- www/embeddeddoc.wiki | ||
| +++ www/embeddeddoc.wiki | ||
| @@ -63,20 +63,25 @@ | ||
| 63 | 63 | Finally, the <i><filename></i> element of the URL is the |
| 64 | 64 | pathname of the documentation file relative to the root of the source |
| 65 | 65 | tree. |
| 66 | 66 | |
| 67 | 67 | The mimetype (and thus the rendering) of documentation files is |
| 68 | -determined by the file suffix. Fossil currently understands 192 | |
| 68 | +determined by the file suffix. Fossil currently understands 197 | |
| 69 | 69 | different file suffixes, including all the popular ones such as |
| 70 | 70 | ".css", ".gif", ".htm", ".html", ".jpg", ".jpeg", ".png", and ".txt". |
| 71 | 71 | |
| 72 | 72 | Documentation files whose names end in ".wiki" use the |
| 73 | 73 | [/wiki_rules | same markup as wiki pages] - |
| 74 | 74 | a safe subset of HTML together with some wiki rules for paragraph |
| 75 | -breaks, lists, and hyperlinks. The ".wiki" and ".txt" pages | |
| 75 | +breaks, lists, and hyperlinks. | |
| 76 | +Documentation files ending in ".md" or ".markdown" use the | |
| 77 | +Markdown markup langauge. | |
| 78 | +Documentation files ending in ".txt" are plain text. | |
| 79 | +Wiki, markdown, and plain text documentation files | |
| 76 | 80 | are rendered with the standard fossil header and footer added. |
| 77 | -All other mimetypes are delivered directly to the requesting | |
| 81 | +All other mimetypes (including ".html" files) | |
| 82 | +are delivered directly to the requesting | |
| 78 | 83 | web browser without interpretation, additions, or changes. |
| 79 | 84 | |
| 80 | 85 | <h2>Examples</h2> |
| 81 | 86 | |
| 82 | 87 | This file that you are currently reading is an example of |
| @@ -83,11 +88,11 @@ | ||
| 83 | 88 | embedded documentation. The name of this file in the fossil |
| 84 | 89 | source tree is "<b>www/embeddeddoc.wiki</b>". |
| 85 | 90 | You are perhaps looking at this |
| 86 | 91 | file using the URL: |
| 87 | 92 | |
| 88 | - [http://www.fossil-scm.org/index.html/doc/tip/www/embeddeddoc.wiki]. | |
| 93 | + [http://www.fossil-scm.org/index.html/doc/trunk/www/embeddeddoc.wiki]. | |
| 89 | 94 | |
| 90 | 95 | The first part of this path, the "[http://www.fossil-scm.org/index.html]", |
| 91 | 96 | is the base URL. You might have originally typed: |
| 92 | 97 | [http://www.fossil-scm.org/]. The web server at the www.fossil-scm.org |
| 93 | 98 | site automatically redirects such links by appending "index.html". The |
| @@ -101,20 +106,20 @@ | ||
| 101 | 106 | </pre></blockquote> |
| 102 | 107 | |
| 103 | 108 | This is one of three ways to set up a |
| 104 | 109 | <a href="quickstart.wiki#serversetup">fossil web server</a>. |
| 105 | 110 | |
| 106 | -The "<b>/tip/</b>" part of the URL tells fossil to use | |
| 107 | -the documentation files from the check-in that was checked in most | |
| 108 | -recently. If you wanted to see an historical version of this document, | |
| 109 | -you could substitute the name of a check-in for "<b>/tip/</b>". | |
| 111 | +The "<b>/trunk/</b>" part of the URL tells fossil to use | |
| 112 | +the documentation files from the most recent trunk check-in. | |
| 113 | +If you wanted to see an historical version of this document, | |
| 114 | +you could substitute the name of a check-in for "<b>/trunk/</b>". | |
| 110 | 115 | For example, to see the version of this document associated with |
| 111 | -check-in [9be1b00392], simply replace the "<b>/tip/</b>" with | |
| 116 | +check-in [9be1b00392], simply replace the "<b>/trunk/</b>" with | |
| 112 | 117 | "<b>/9be1b00392/</b>". You can also substitute the symbolic name |
| 113 | 118 | 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 | |
| 119 | +replace "<b>/trunk/</b>" with "<b>/experimental/</b>" to get the latest | |
| 120 | +version of this document in the "experimental" branch. The symbolic name | |
| 116 | 121 | can also be a date and time string in any of the following formats:</p> |
| 117 | 122 | |
| 118 | 123 | <ul> |
| 119 | 124 | <li> <i>YYYY-MM-DD</i> |
| 120 | 125 | <li> <i>YYYY-MM-DD</i><b>T</b><i>HH:MM</i> |
| @@ -135,12 +140,12 @@ | ||
| 135 | 140 | The file that encodes this document is stored in the fossil source tree under |
| 136 | 141 | the name "<b>www/embeddeddoc.wiki</b>" and so that name forms the |
| 137 | 142 | last part of the URL for this document. |
| 138 | 143 | |
| 139 | 144 | As I sit writing this documentation file, I am testing my work by |
| 140 | -running the "<b>fossil server</b>" command line and viewing | |
| 145 | +running the "<b>fossil ui</b>" command line and viewing | |
| 141 | 146 | <b>http://localhost:8080/doc/ckout/www/embeddeddoc.wiki</b> in |
| 142 | 147 | Firefox. I am doing this even though I have not yet checked in |
| 143 | 148 | the "<b>www/embeddeddoc.wiki</b>" file for the first time. Using |
| 144 | 149 | the special "<b>ckout</b>" version identifier on the "<b>/doc</b>" page |
| 145 | 150 | it is easy to make multiple changes to multiple files and see how they all |
| 146 | 151 | look together before committing anything to the repository. |
| 147 | 152 |
| --- www/embeddeddoc.wiki | |
| +++ www/embeddeddoc.wiki | |
| @@ -63,20 +63,25 @@ | |
| 63 | Finally, the <i><filename></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 |
| 70 | ".css", ".gif", ".htm", ".html", ".jpg", ".jpeg", ".png", and ".txt". |
| 71 | |
| 72 | Documentation files whose names end in ".wiki" use the |
| 73 | [/wiki_rules | same markup as wiki pages] - |
| 74 | a safe subset of HTML together with some wiki rules for paragraph |
| 75 | breaks, lists, and hyperlinks. The ".wiki" and ".txt" pages |
| 76 | are rendered with the standard fossil header and footer added. |
| 77 | All other mimetypes are delivered directly to the requesting |
| 78 | web browser without interpretation, additions, or changes. |
| 79 | |
| 80 | <h2>Examples</h2> |
| 81 | |
| 82 | This file that you are currently reading is an example of |
| @@ -83,11 +88,11 @@ | |
| 83 | embedded documentation. The name of this file in the fossil |
| 84 | source tree is "<b>www/embeddeddoc.wiki</b>". |
| 85 | You are perhaps looking at this |
| 86 | file using the URL: |
| 87 | |
| 88 | [http://www.fossil-scm.org/index.html/doc/tip/www/embeddeddoc.wiki]. |
| 89 | |
| 90 | The first part of this path, the "[http://www.fossil-scm.org/index.html]", |
| 91 | is the base URL. You might have originally typed: |
| 92 | [http://www.fossil-scm.org/]. The web server at the www.fossil-scm.org |
| 93 | site automatically redirects such links by appending "index.html". The |
| @@ -101,20 +106,20 @@ | |
| 101 | </pre></blockquote> |
| 102 | |
| 103 | This is one of three ways to set up a |
| 104 | <a href="quickstart.wiki#serversetup">fossil web server</a>. |
| 105 | |
| 106 | The "<b>/tip/</b>" part of the URL tells fossil to use |
| 107 | the documentation files from the check-in that was checked in most |
| 108 | recently. If you wanted to see an historical version of this document, |
| 109 | you could substitute the name of a check-in for "<b>/tip/</b>". |
| 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> |
| @@ -135,12 +140,12 @@ | |
| 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 | As I sit writing this documentation file, I am testing my work by |
| 140 | running the "<b>fossil server</b>" command line and viewing |
| 141 | <b>http://localhost:8080/doc/ckout/www/embeddeddoc.wiki</b> in |
| 142 | Firefox. I am doing this even though I have not yet checked in |
| 143 | the "<b>www/embeddeddoc.wiki</b>" file for the first time. Using |
| 144 | the special "<b>ckout</b>" version identifier on the "<b>/doc</b>" page |
| 145 | it is easy to make multiple changes to multiple files and see how they all |
| 146 | look together before committing anything to the repository. |
| 147 |
| --- www/embeddeddoc.wiki | |
| +++ www/embeddeddoc.wiki | |
| @@ -63,20 +63,25 @@ | |
| 63 | Finally, the <i><filename></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 197 |
| 69 | different file suffixes, including all the popular ones such as |
| 70 | ".css", ".gif", ".htm", ".html", ".jpg", ".jpeg", ".png", and ".txt". |
| 71 | |
| 72 | Documentation files whose names end in ".wiki" use the |
| 73 | [/wiki_rules | same markup as wiki pages] - |
| 74 | a safe subset of HTML together with some wiki rules for paragraph |
| 75 | breaks, lists, and hyperlinks. |
| 76 | Documentation files ending in ".md" or ".markdown" use the |
| 77 | Markdown markup langauge. |
| 78 | Documentation files ending in ".txt" are plain text. |
| 79 | Wiki, markdown, and plain text documentation files |
| 80 | are rendered with the standard fossil header and footer added. |
| 81 | All other mimetypes (including ".html" files) |
| 82 | are delivered directly to the requesting |
| 83 | web browser without interpretation, additions, or changes. |
| 84 | |
| 85 | <h2>Examples</h2> |
| 86 | |
| 87 | This file that you are currently reading is an example of |
| @@ -83,11 +88,11 @@ | |
| 88 | embedded documentation. The name of this file in the fossil |
| 89 | source tree is "<b>www/embeddeddoc.wiki</b>". |
| 90 | You are perhaps looking at this |
| 91 | file using the URL: |
| 92 | |
| 93 | [http://www.fossil-scm.org/index.html/doc/trunk/www/embeddeddoc.wiki]. |
| 94 | |
| 95 | The first part of this path, the "[http://www.fossil-scm.org/index.html]", |
| 96 | is the base URL. You might have originally typed: |
| 97 | [http://www.fossil-scm.org/]. The web server at the www.fossil-scm.org |
| 98 | site automatically redirects such links by appending "index.html". The |
| @@ -101,20 +106,20 @@ | |
| 106 | </pre></blockquote> |
| 107 | |
| 108 | This is one of three ways to set up a |
| 109 | <a href="quickstart.wiki#serversetup">fossil web server</a>. |
| 110 | |
| 111 | The "<b>/trunk/</b>" part of the URL tells fossil to use |
| 112 | the documentation files from the most recent trunk check-in. |
| 113 | If you wanted to see an historical version of this document, |
| 114 | you could substitute the name of a check-in for "<b>/trunk/</b>". |
| 115 | For example, to see the version of this document associated with |
| 116 | check-in [9be1b00392], simply replace the "<b>/trunk/</b>" with |
| 117 | "<b>/9be1b00392/</b>". You can also substitute the symbolic name |
| 118 | for a particular version or branch. For example, you might |
| 119 | replace "<b>/trunk/</b>" with "<b>/experimental/</b>" to get the latest |
| 120 | version of this document in the "experimental" branch. The symbolic name |
| 121 | can also be a date and time string in any of the following formats:</p> |
| 122 | |
| 123 | <ul> |
| 124 | <li> <i>YYYY-MM-DD</i> |
| 125 | <li> <i>YYYY-MM-DD</i><b>T</b><i>HH:MM</i> |
| @@ -135,12 +140,12 @@ | |
| 140 | The file that encodes this document is stored in the fossil source tree under |
| 141 | the name "<b>www/embeddeddoc.wiki</b>" and so that name forms the |
| 142 | last part of the URL for this document. |
| 143 | |
| 144 | As I sit writing this documentation file, I am testing my work by |
| 145 | running the "<b>fossil ui</b>" command line and viewing |
| 146 | <b>http://localhost:8080/doc/ckout/www/embeddeddoc.wiki</b> in |
| 147 | Firefox. I am doing this even though I have not yet checked in |
| 148 | the "<b>www/embeddeddoc.wiki</b>" file for the first time. Using |
| 149 | the special "<b>ckout</b>" version identifier on the "<b>/doc</b>" page |
| 150 | it is easy to make multiple changes to multiple files and see how they all |
| 151 | look together before committing anything to the repository. |
| 152 |
-4
| --- www/reviews.wiki | ||
| +++ www/reviews.wiki | ||
| @@ -1,14 +1,10 @@ | ||
| 1 | 1 | <title>Reviews</title> |
| 2 | 2 | <b>External links:</b> |
| 3 | 3 | |
| 4 | - * [http://sheddingbikes.com/posts/1276624594.html | Why I Use Fossil] | |
| 5 | - by Zed A. Shaw. | |
| 6 | 4 | * [http://nixtu.blogspot.com/2010/03/fossil-dvcs-on-go-first-impressions.html | |
| 7 | 5 | Fossil DVCS on the Go - First Impressions] |
| 8 | - * [http://blog.fupps.com/2010/12/04/exploring-the-fossil-dvcs | | |
| 9 | - Exploring the Fossil DVCS] by Jan-Piet Mens. <b>(Dead link)</b> | |
| 10 | 6 | * [http://blog.mired.org/2011/02/fossil-sweet-spot-in-vcs-space.html | |
| 11 | 7 | Fossil - a sweet spot in the VCS space] by Mike Meyer. |
| 12 | 8 | * [http://blog.s11n.net/?p=72|Four reasons to take a closer look at the Fossil SCM] by Stephan Beal |
| 13 | 9 | |
| 14 | 10 | <b>See Also:</b> |
| 15 | 11 |
| --- www/reviews.wiki | |
| +++ www/reviews.wiki | |
| @@ -1,14 +1,10 @@ | |
| 1 | <title>Reviews</title> |
| 2 | <b>External links:</b> |
| 3 | |
| 4 | * [http://sheddingbikes.com/posts/1276624594.html | Why I Use Fossil] |
| 5 | by Zed A. Shaw. |
| 6 | * [http://nixtu.blogspot.com/2010/03/fossil-dvcs-on-go-first-impressions.html | |
| 7 | Fossil DVCS on the Go - First Impressions] |
| 8 | * [http://blog.fupps.com/2010/12/04/exploring-the-fossil-dvcs | |
| 9 | Exploring the Fossil DVCS] by Jan-Piet Mens. <b>(Dead link)</b> |
| 10 | * [http://blog.mired.org/2011/02/fossil-sweet-spot-in-vcs-space.html | |
| 11 | Fossil - a sweet spot in the VCS space] by Mike Meyer. |
| 12 | * [http://blog.s11n.net/?p=72|Four reasons to take a closer look at the Fossil SCM] by Stephan Beal |
| 13 | |
| 14 | <b>See Also:</b> |
| 15 |
| --- www/reviews.wiki | |
| +++ www/reviews.wiki | |
| @@ -1,14 +1,10 @@ | |
| 1 | <title>Reviews</title> |
| 2 | <b>External links:</b> |
| 3 | |
| 4 | * [http://nixtu.blogspot.com/2010/03/fossil-dvcs-on-go-first-impressions.html | |
| 5 | Fossil DVCS on the Go - First Impressions] |
| 6 | * [http://blog.mired.org/2011/02/fossil-sweet-spot-in-vcs-space.html | |
| 7 | Fossil - a sweet spot in the VCS space] by Mike Meyer. |
| 8 | * [http://blog.s11n.net/?p=72|Four reasons to take a closer look at the Fossil SCM] by Stephan Beal |
| 9 | |
| 10 | <b>See Also:</b> |
| 11 |
+2
-1
| --- www/tech_overview.wiki | ||
| +++ www/tech_overview.wiki | ||
| @@ -5,11 +5,12 @@ | ||
| 5 | 5 | |
| 6 | 6 | <h2>1.0 Introduction</h2> |
| 7 | 7 | |
| 8 | 8 | At its lowest level, a Fossil repository consists of an unordered set |
| 9 | 9 | of immutable "artifacts". You might think of these artifacts as "files", |
| 10 | -since in many cases the artifacts exactly that. But other "control artifacts" | |
| 10 | +since in many cases the artifacts are exactly that. | |
| 11 | +But other "control artifacts" | |
| 11 | 12 | are also included in the mix. These control artifacts define the relationships |
| 12 | 13 | between artifacts - which files go together to form a particular |
| 13 | 14 | version of the project, who checked in that version and when, what was |
| 14 | 15 | the check-in comment, what wiki pages are included with the project, what |
| 15 | 16 | are the edit histories of each wiki page, what bug reports or tickets are |
| 16 | 17 |
| --- www/tech_overview.wiki | |
| +++ www/tech_overview.wiki | |
| @@ -5,11 +5,12 @@ | |
| 5 | |
| 6 | <h2>1.0 Introduction</h2> |
| 7 | |
| 8 | At its lowest level, a Fossil repository consists of an unordered set |
| 9 | of immutable "artifacts". You might think of these artifacts as "files", |
| 10 | since in many cases the artifacts exactly that. But other "control artifacts" |
| 11 | are also included in the mix. These control artifacts define the relationships |
| 12 | between artifacts - which files go together to form a particular |
| 13 | version of the project, who checked in that version and when, what was |
| 14 | the check-in comment, what wiki pages are included with the project, what |
| 15 | are the edit histories of each wiki page, what bug reports or tickets are |
| 16 |
| --- www/tech_overview.wiki | |
| +++ www/tech_overview.wiki | |
| @@ -5,11 +5,12 @@ | |
| 5 | |
| 6 | <h2>1.0 Introduction</h2> |
| 7 | |
| 8 | At its lowest level, a Fossil repository consists of an unordered set |
| 9 | of immutable "artifacts". You might think of these artifacts as "files", |
| 10 | since in many cases the artifacts are exactly that. |
| 11 | But other "control artifacts" |
| 12 | are also included in the mix. These control artifacts define the relationships |
| 13 | between artifacts - which files go together to form a particular |
| 14 | version of the project, who checked in that version and when, what was |
| 15 | the check-in comment, what wiki pages are included with the project, what |
| 16 | are the edit histories of each wiki page, what bug reports or tickets are |
| 17 |