Fossil SCM
www/cgi.wiki: document the new repolist behavior introduced in [9584806cc6a8].
Commit
c7b9f05f2e20846039a8f273b994388b9a72d64fed1fed5e0b9756394dc11049
Parent
b7e638f8e5baa1e…
1 file changed
+24
-4
+24
-4
| --- www/cgi.wiki | ||
| +++ www/cgi.wiki | ||
| @@ -48,14 +48,16 @@ | ||
| 48 | 48 | |
| 49 | 49 | |
| 50 | 50 | <h2 id="directory">directory: <i>PATH</i></h2> |
| 51 | 51 | |
| 52 | 52 | The PATH is the name of a directory that contains one or more Fossil |
| 53 | -repository files having the suffix ".fossil". If this property is used | |
| 54 | -instead of [#repository|<b>repository:</b>], then the Fossil server is | |
| 55 | -able to serve all of the repositories in the directory. The specific | |
| 56 | -repository used is selected by a prefix on the PATH_INFO. | |
| 53 | +repository files having the suffix ".fossil". If this property is | |
| 54 | +used instead of [#repository|<b>repository:</b>], then the Fossil | |
| 55 | +server is able to serve all of the repositories in the directory. The | |
| 56 | +specific repository used is selected by a prefix on the PATH_INFO. See | |
| 57 | +the notes for the [#repolist|<b>repolist</b>] option regarding name | |
| 58 | +collisions between subdirectories and repository files. | |
| 57 | 59 | |
| 58 | 60 | |
| 59 | 61 | <h2 id="notfound">notfound: <i>URL</i></h2> |
| 60 | 62 | |
| 61 | 63 | If the [#directory|<b>directory:</b>] option is used and if the PATH_INFO |
| @@ -73,10 +75,28 @@ | ||
| 73 | 75 | The "skin" of the reply is determined by the first |
| 74 | 76 | repository in the list that has a non-zero |
| 75 | 77 | [/help?cmd=repolist-skin|repolist-skin] setting. |
| 76 | 78 | If no repository has such a non-zero repolist-skin setting, then |
| 77 | 79 | the repository list is generic HTML without any decoration. |
| 80 | + | |
| 81 | +The repolist-generated page recurses into subdirectories and will list | |
| 82 | +all <tt>*.fossil</tt> files found, with the following exceptions: | |
| 83 | + | |
| 84 | + * Filenames starting with a period are treated as "hidden" and skipped. | |
| 85 | + | |
| 86 | + * Subdirectory names which match the base name of a fossil file in | |
| 87 | + the same directory are listed in the resulting page but are not | |
| 88 | + hyperlinked because the links would be ambiguous and the | |
| 89 | + repositories in the subdirectories would be unreachable to | |
| 90 | + clients. For example, any repositories under subdirectory | |
| 91 | + <tt>XYZ</tt> are unreachable if <tt>XYZ.fossil</tt> exists in | |
| 92 | + the same directory as <tt>XYZ</tt>, noting that this particular | |
| 93 | + name check is case-insensitive. The entries for such | |
| 94 | + repositories are clearly marked in the repolist page's output to | |
| 95 | + make the user aware of the problem. To make them accessible, | |
| 96 | + move them into a directory which does not share a base name with | |
| 97 | + a repository file. | |
| 78 | 98 | |
| 79 | 99 | |
| 80 | 100 | <h2 id="localauth">localauth</h2> |
| 81 | 101 | |
| 82 | 102 | This is a Boolean property. |
| 83 | 103 |
| --- www/cgi.wiki | |
| +++ www/cgi.wiki | |
| @@ -48,14 +48,16 @@ | |
| 48 | |
| 49 | |
| 50 | <h2 id="directory">directory: <i>PATH</i></h2> |
| 51 | |
| 52 | The PATH is the name of a directory that contains one or more Fossil |
| 53 | repository files having the suffix ".fossil". If this property is used |
| 54 | instead of [#repository|<b>repository:</b>], then the Fossil server is |
| 55 | able to serve all of the repositories in the directory. The specific |
| 56 | repository used is selected by a prefix on the PATH_INFO. |
| 57 | |
| 58 | |
| 59 | <h2 id="notfound">notfound: <i>URL</i></h2> |
| 60 | |
| 61 | If the [#directory|<b>directory:</b>] option is used and if the PATH_INFO |
| @@ -73,10 +75,28 @@ | |
| 73 | The "skin" of the reply is determined by the first |
| 74 | repository in the list that has a non-zero |
| 75 | [/help?cmd=repolist-skin|repolist-skin] setting. |
| 76 | If no repository has such a non-zero repolist-skin setting, then |
| 77 | the repository list is generic HTML without any decoration. |
| 78 | |
| 79 | |
| 80 | <h2 id="localauth">localauth</h2> |
| 81 | |
| 82 | This is a Boolean property. |
| 83 |
| --- www/cgi.wiki | |
| +++ www/cgi.wiki | |
| @@ -48,14 +48,16 @@ | |
| 48 | |
| 49 | |
| 50 | <h2 id="directory">directory: <i>PATH</i></h2> |
| 51 | |
| 52 | The PATH is the name of a directory that contains one or more Fossil |
| 53 | repository files having the suffix ".fossil". If this property is |
| 54 | used instead of [#repository|<b>repository:</b>], then the Fossil |
| 55 | server is able to serve all of the repositories in the directory. The |
| 56 | specific repository used is selected by a prefix on the PATH_INFO. See |
| 57 | the notes for the [#repolist|<b>repolist</b>] option regarding name |
| 58 | collisions between subdirectories and repository files. |
| 59 | |
| 60 | |
| 61 | <h2 id="notfound">notfound: <i>URL</i></h2> |
| 62 | |
| 63 | If the [#directory|<b>directory:</b>] option is used and if the PATH_INFO |
| @@ -73,10 +75,28 @@ | |
| 75 | The "skin" of the reply is determined by the first |
| 76 | repository in the list that has a non-zero |
| 77 | [/help?cmd=repolist-skin|repolist-skin] setting. |
| 78 | If no repository has such a non-zero repolist-skin setting, then |
| 79 | the repository list is generic HTML without any decoration. |
| 80 | |
| 81 | The repolist-generated page recurses into subdirectories and will list |
| 82 | all <tt>*.fossil</tt> files found, with the following exceptions: |
| 83 | |
| 84 | * Filenames starting with a period are treated as "hidden" and skipped. |
| 85 | |
| 86 | * Subdirectory names which match the base name of a fossil file in |
| 87 | the same directory are listed in the resulting page but are not |
| 88 | hyperlinked because the links would be ambiguous and the |
| 89 | repositories in the subdirectories would be unreachable to |
| 90 | clients. For example, any repositories under subdirectory |
| 91 | <tt>XYZ</tt> are unreachable if <tt>XYZ.fossil</tt> exists in |
| 92 | the same directory as <tt>XYZ</tt>, noting that this particular |
| 93 | name check is case-insensitive. The entries for such |
| 94 | repositories are clearly marked in the repolist page's output to |
| 95 | make the user aware of the problem. To make them accessible, |
| 96 | move them into a directory which does not share a base name with |
| 97 | a repository file. |
| 98 | |
| 99 | |
| 100 | <h2 id="localauth">localauth</h2> |
| 101 | |
| 102 | This is a Boolean property. |
| 103 |