diff options
| author | Jason A. Donenfeld | 2013-05-25 20:30:57 +0200 |
|---|---|---|
| committer | Jason A. Donenfeld | 2013-05-25 20:33:28 +0200 |
| commit | 2a1ead3efb940b7359bcc706c19bd8ddb0de7a11 (patch) | |
| tree | f6e85c5eb710cafa90d236c4e5a281101af8f5ca | |
| parent | readme: Accept multiple candidates and test them. (diff) | |
| download | cgit-2a1ead3efb940b7359bcc706c19bd8ddb0de7a11.tar.gz cgit-2a1ead3efb940b7359bcc706c19bd8ddb0de7a11.zip | |
cgitrc.5: information on directory traversal and multiple readme files
Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
| -rw-r--r-- | cgitrc.5.txt | 17 |
1 files changed, 11 insertions, 6 deletions
| diff --git a/cgitrc.5.txt b/cgitrc.5.txt index ea0bbe7..12a843b 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
| @@ -29,9 +29,10 @@ GLOBAL SETTINGS | |||
| 29 | about-filter:: | 29 | about-filter:: |
| 30 | Specifies a command which will be invoked to format the content of | 30 | Specifies a command which will be invoked to format the content of |
| 31 | about pages (both top-level and for each repository). The command will | 31 | about pages (both top-level and for each repository). The command will |
| 32 | get the content of the about-file on its STDIN, and the STDOUT from the | 32 | get the content of the about-file on its STDIN, the name of the file |
| 33 | command will be included verbatim on the about page. Default value: | 33 | as the first argument, and the STDOUT from the command will be |
| 34 | none. See also: "FILTER API". | 34 | included verbatim on the about page. Default value: none. See |
| 35 | also: "FILTER API". | ||
| 35 | 36 | ||
| 36 | agefile:: | 37 | agefile:: |
| 37 | Specifies a path, relative to each repository path, which can be used | 38 | Specifies a path, relative to each repository path, which can be used |
| @@ -288,8 +289,9 @@ project-list:: | |||
| 288 | EXPANSION". | 289 | EXPANSION". |
| 289 | 290 | ||
| 290 | readme:: | 291 | readme:: |
| 291 | Text which will be used as default value for "repo.readme". Default | 292 | Text which will be used as default value for "repo.readme". Multiple |
| 292 | value: none. | 293 | files may be specified, separated by a space, and cgit will use the |
| 294 | first found file in this list. Default value: none. | ||
| 293 | 295 | ||
| 294 | remove-suffix:: | 296 | remove-suffix:: |
| 295 | If set to "1" and scan-path is enabled, if any repositories are found | 297 | If set to "1" and scan-path is enabled, if any repositories are found |
| @@ -507,7 +509,10 @@ repo.readme:: | |||
| 507 | git refspec by head or by hash by prepending the refspec followed by | 509 | git refspec by head or by hash by prepending the refspec followed by |
| 508 | a colon. For example, "master:docs/readme.mkd". If the value begins | 510 | a colon. For example, "master:docs/readme.mkd". If the value begins |
| 509 | with a colon, i.e. ":docs/readme.rst", the default branch of the | 511 | with a colon, i.e. ":docs/readme.rst", the default branch of the |
| 510 | repository will be used. Default value: <readme>. | 512 | repository will be used. Sharing any file will expose that entire |
| 513 | directory tree to the "/about/PATH" endpoints, so be sure that there | ||
| 514 | are no non-public files located in the same directory as the readme | ||
| 515 | file. Default value: <readme>. | ||
| 511 | 516 | ||
| 512 | repo.snapshots:: | 517 | repo.snapshots:: |
| 513 | A mask of allowed snapshot-formats for this repo, restricted by the | 518 | A mask of allowed snapshot-formats for this repo, restricted by the |