author | Johan Herland <johan@herland.net> | 2010-11-15 19:41:00 (UTC) |
---|---|---|
committer | Lars Hjemli <hjemli@gmail.com> | 2011-02-19 13:25:14 (UTC) |
commit | df522794c38934be3229a11e0e2432a1f2a3bc8d (patch) (unidiff) | |
tree | f11aef6d303a5327303a4471d47444764bea53d8 /cgitrc.5.txt | |
parent | 682adbc0cad2baa1a6119013b166f52de3ee3352 (diff) | |
download | cgit-df522794c38934be3229a11e0e2432a1f2a3bc8d.zip cgit-df522794c38934be3229a11e0e2432a1f2a3bc8d.tar.gz cgit-df522794c38934be3229a11e0e2432a1f2a3bc8d.tar.bz2 |
scan_path(): Do not recurse into hidden directories by default
Paths that start with a period ('.') are considered hidden in the Unix world.
scan_path() should arguably not recurse into these directories by default.
This patch makes it so, and introduces the "scan-hidden-path" config variable
for overriding the new default and revert to the old behaviour (scanning _all_
directories, including hidden .directories).
Signed-off-by: Johan Herland <johan@herland.net>
Signed-off-by: Lars Hjemli <larsh@prediktor.no>
-rw-r--r-- | cgitrc.5.txt | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 8e51ca5..1dc3cce 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -176,192 +176,200 @@ logo-link:: | |||
176 | Url loaded when clicking on the cgit logo image. If unspecified the | 176 | Url loaded when clicking on the cgit logo image. If unspecified the |
177 | calculated url of the repository index page will be used. Default | 177 | calculated url of the repository index page will be used. Default |
178 | value: none. | 178 | value: none. |
179 | 179 | ||
180 | max-atom-items:: | 180 | max-atom-items:: |
181 | Specifies the number of items to display in atom feeds view. Default | 181 | Specifies the number of items to display in atom feeds view. Default |
182 | value: "10". | 182 | value: "10". |
183 | 183 | ||
184 | max-commit-count:: | 184 | max-commit-count:: |
185 | Specifies the number of entries to list per page in "log" view. Default | 185 | Specifies the number of entries to list per page in "log" view. Default |
186 | value: "50". | 186 | value: "50". |
187 | 187 | ||
188 | max-message-length:: | 188 | max-message-length:: |
189 | Specifies the maximum number of commit message characters to display in | 189 | Specifies the maximum number of commit message characters to display in |
190 | "log" view. Default value: "80". | 190 | "log" view. Default value: "80". |
191 | 191 | ||
192 | max-repo-count:: | 192 | max-repo-count:: |
193 | Specifies the number of entries to list per page on therepository | 193 | Specifies the number of entries to list per page on therepository |
194 | index page. Default value: "50". | 194 | index page. Default value: "50". |
195 | 195 | ||
196 | max-repodesc-length:: | 196 | max-repodesc-length:: |
197 | Specifies the maximum number of repo description characters to display | 197 | Specifies the maximum number of repo description characters to display |
198 | on the repository index page. Default value: "80". | 198 | on the repository index page. Default value: "80". |
199 | 199 | ||
200 | max-blob-size:: | 200 | max-blob-size:: |
201 | Specifies the maximum size of a blob to display HTML for in KBytes. | 201 | Specifies the maximum size of a blob to display HTML for in KBytes. |
202 | Default value: "0" (limit disabled). | 202 | Default value: "0" (limit disabled). |
203 | 203 | ||
204 | max-stats:: | 204 | max-stats:: |
205 | Set the default maximum statistics period. Valid values are "week", | 205 | Set the default maximum statistics period. Valid values are "week", |
206 | "month", "quarter" and "year". If unspecified, statistics are | 206 | "month", "quarter" and "year". If unspecified, statistics are |
207 | disabled. Default value: none. See also: "repo.max-stats". | 207 | disabled. Default value: none. See also: "repo.max-stats". |
208 | 208 | ||
209 | mimetype.<ext>:: | 209 | mimetype.<ext>:: |
210 | Set the mimetype for the specified filename extension. This is used | 210 | Set the mimetype for the specified filename extension. This is used |
211 | by the `plain` command when returning blob content. | 211 | by the `plain` command when returning blob content. |
212 | 212 | ||
213 | module-link:: | 213 | module-link:: |
214 | Text which will be used as the formatstring for a hyperlink when a | 214 | Text which will be used as the formatstring for a hyperlink when a |
215 | submodule is printed in a directory listing. The arguments for the | 215 | submodule is printed in a directory listing. The arguments for the |
216 | formatstring are the path and SHA1 of the submodule commit. Default | 216 | formatstring are the path and SHA1 of the submodule commit. Default |
217 | value: "./?repo=%s&page=commit&id=%s" | 217 | value: "./?repo=%s&page=commit&id=%s" |
218 | 218 | ||
219 | nocache:: | 219 | nocache:: |
220 | If set to the value "1" caching will be disabled. This settings is | 220 | If set to the value "1" caching will be disabled. This settings is |
221 | deprecated, and will not be honored starting with cgit-1.0. Default | 221 | deprecated, and will not be honored starting with cgit-1.0. Default |
222 | value: "0". | 222 | value: "0". |
223 | 223 | ||
224 | noplainemail:: | 224 | noplainemail:: |
225 | If set to "1" showing full author email adresses will be disabled. | 225 | If set to "1" showing full author email adresses will be disabled. |
226 | Default value: "0". | 226 | Default value: "0". |
227 | 227 | ||
228 | noheader:: | 228 | noheader:: |
229 | Flag which, when set to "1", will make cgit omit the standard header | 229 | Flag which, when set to "1", will make cgit omit the standard header |
230 | on all pages. Default value: none. See also: "embedded". | 230 | on all pages. Default value: none. See also: "embedded". |
231 | 231 | ||
232 | project-list:: | 232 | project-list:: |
233 | A list of subdirectories inside of scan-path, relative to it, that | 233 | A list of subdirectories inside of scan-path, relative to it, that |
234 | should loaded as git repositories. This must be defined prior to | 234 | should loaded as git repositories. This must be defined prior to |
235 | scan-path. Default value: none. See also: scan-path. | 235 | scan-path. Default value: none. See also: scan-path. |
236 | 236 | ||
237 | readme:: | 237 | readme:: |
238 | Text which will be used as default value for "repo.readme". Default | 238 | Text which will be used as default value for "repo.readme". Default |
239 | value: none. | 239 | value: none. |
240 | 240 | ||
241 | remove-suffix:: | 241 | remove-suffix:: |
242 | If set to "1" and scan-path is enabled, if any repositories are found | 242 | If set to "1" and scan-path is enabled, if any repositories are found |
243 | with a suffix of ".git", this suffix will be removed for the url and | 243 | with a suffix of ".git", this suffix will be removed for the url and |
244 | name. Default value: "0". See also: scan-path. | 244 | name. Default value: "0". See also: scan-path. |
245 | 245 | ||
246 | renamelimit:: | 246 | renamelimit:: |
247 | Maximum number of files to consider when detecting renames. The value | 247 | Maximum number of files to consider when detecting renames. The value |
248 | "-1" uses the compiletime value in git (for further info, look at | 248 | "-1" uses the compiletime value in git (for further info, look at |
249 | `man git-diff`). Default value: "-1". | 249 | `man git-diff`). Default value: "-1". |
250 | 250 | ||
251 | repo.group:: | 251 | repo.group:: |
252 | Legacy alias for "section". This option is deprecated and will not be | 252 | Legacy alias for "section". This option is deprecated and will not be |
253 | supported in cgit-1.0. | 253 | supported in cgit-1.0. |
254 | 254 | ||
255 | robots:: | 255 | robots:: |
256 | Text used as content for the "robots" meta-tag. Default value: | 256 | Text used as content for the "robots" meta-tag. Default value: |
257 | "index, nofollow". | 257 | "index, nofollow". |
258 | 258 | ||
259 | root-desc:: | 259 | root-desc:: |
260 | Text printed below the heading on the repository index page. Default | 260 | Text printed below the heading on the repository index page. Default |
261 | value: "a fast webinterface for the git dscm". | 261 | value: "a fast webinterface for the git dscm". |
262 | 262 | ||
263 | root-readme:: | 263 | root-readme:: |
264 | The content of the file specified with this option will be included | 264 | The content of the file specified with this option will be included |
265 | verbatim below the "about" link on the repository index page. Default | 265 | verbatim below the "about" link on the repository index page. Default |
266 | value: none. | 266 | value: none. |
267 | 267 | ||
268 | root-title:: | 268 | root-title:: |
269 | Text printed as heading on the repository index page. Default value: | 269 | Text printed as heading on the repository index page. Default value: |
270 | "Git Repository Browser". | 270 | "Git Repository Browser". |
271 | 271 | ||
272 | scan-hidden-path:: | ||
273 | If set to "1" and scan-path is enabled, scan-path will recurse into | ||
274 | directories whose name starts with a period ('.'). Otherwise, | ||
275 | scan-path will stay away from such directories (considered as | ||
276 | "hidden"). Note that this does not apply to the ".git" directory in | ||
277 | non-bare repos. This must be defined prior to scan-path. | ||
278 | Default value: 0. See also: scan-path. | ||
279 | |||
272 | scan-path:: | 280 | scan-path:: |
273 | A path which will be scanned for repositories. If caching is enabled, | 281 | A path which will be scanned for repositories. If caching is enabled, |
274 | the result will be cached as a cgitrc include-file in the cache | 282 | the result will be cached as a cgitrc include-file in the cache |
275 | directory. If project-list has been defined prior to scan-path, | 283 | directory. If project-list has been defined prior to scan-path, |
276 | scan-path loads only the directories listed in the file pointed to by | 284 | scan-path loads only the directories listed in the file pointed to by |
277 | project-list. Default value: none. See also: cache-scanrc-ttl, | 285 | project-list. Default value: none. See also: cache-scanrc-ttl, |
278 | project-list. | 286 | project-list. |
279 | 287 | ||
280 | section:: | 288 | section:: |
281 | The name of the current repository section - all repositories defined | 289 | The name of the current repository section - all repositories defined |
282 | after this option will inherit the current section name. Default value: | 290 | after this option will inherit the current section name. Default value: |
283 | none. | 291 | none. |
284 | 292 | ||
285 | section-from-path:: | 293 | section-from-path:: |
286 | A number which, if specified before scan-path, specifies how many | 294 | A number which, if specified before scan-path, specifies how many |
287 | path elements from each repo path to use as a default section name. | 295 | path elements from each repo path to use as a default section name. |
288 | If negative, cgit will discard the specified number of path elements | 296 | If negative, cgit will discard the specified number of path elements |
289 | above the repo directory. Default value: 0. | 297 | above the repo directory. Default value: 0. |
290 | 298 | ||
291 | side-by-side-diffs:: | 299 | side-by-side-diffs:: |
292 | If set to "1" shows side-by-side diffs instead of unidiffs per | 300 | If set to "1" shows side-by-side diffs instead of unidiffs per |
293 | default. Default value: "0". | 301 | default. Default value: "0". |
294 | 302 | ||
295 | snapshots:: | 303 | snapshots:: |
296 | Text which specifies the default set of snapshot formats generated by | 304 | Text which specifies the default set of snapshot formats generated by |
297 | cgit. The value is a space-separated list of zero or more of the | 305 | cgit. The value is a space-separated list of zero or more of the |
298 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. | 306 | values "tar", "tar.gz", "tar.bz2" and "zip". Default value: none. |
299 | 307 | ||
300 | source-filter:: | 308 | source-filter:: |
301 | Specifies a command which will be invoked to format plaintext blobs | 309 | Specifies a command which will be invoked to format plaintext blobs |
302 | in the tree view. The command will get the blob content on its STDIN | 310 | in the tree view. The command will get the blob content on its STDIN |
303 | and the name of the blob as its only command line argument. The STDOUT | 311 | and the name of the blob as its only command line argument. The STDOUT |
304 | from the command will be included verbatim as the blob contents, i.e. | 312 | from the command will be included verbatim as the blob contents, i.e. |
305 | this can be used to implement e.g. syntax highlighting. Default value: | 313 | this can be used to implement e.g. syntax highlighting. Default value: |
306 | none. | 314 | none. |
307 | 315 | ||
308 | summary-branches:: | 316 | summary-branches:: |
309 | Specifies the number of branches to display in the repository "summary" | 317 | Specifies the number of branches to display in the repository "summary" |
310 | view. Default value: "10". | 318 | view. Default value: "10". |
311 | 319 | ||
312 | summary-log:: | 320 | summary-log:: |
313 | Specifies the number of log entries to display in the repository | 321 | Specifies the number of log entries to display in the repository |
314 | "summary" view. Default value: "10". | 322 | "summary" view. Default value: "10". |
315 | 323 | ||
316 | summary-tags:: | 324 | summary-tags:: |
317 | Specifies the number of tags to display in the repository "summary" | 325 | Specifies the number of tags to display in the repository "summary" |
318 | view. Default value: "10". | 326 | view. Default value: "10". |
319 | 327 | ||
320 | strict-export:: | 328 | strict-export:: |
321 | Filename which, if specified, needs to be present within the repository | 329 | Filename which, if specified, needs to be present within the repository |
322 | for cgit to allow access to that repository. This can be used to emulate | 330 | for cgit to allow access to that repository. This can be used to emulate |
323 | gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's | 331 | gitweb's EXPORT_OK and STRICT_EXPORT functionality and limit cgit's |
324 | repositories to match those exported by git-daemon. This option MUST come | 332 | repositories to match those exported by git-daemon. This option MUST come |
325 | before 'scan-path'. | 333 | before 'scan-path'. |
326 | 334 | ||
327 | virtual-root:: | 335 | virtual-root:: |
328 | Url which, if specified, will be used as root for all cgit links. It | 336 | Url which, if specified, will be used as root for all cgit links. It |
329 | will also cause cgit to generate 'virtual urls', i.e. urls like | 337 | will also cause cgit to generate 'virtual urls', i.e. urls like |
330 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default | 338 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
331 | value: none. | 339 | value: none. |
332 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 340 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the |
333 | same kind of virtual urls, so this option will probably be deprecated. | 341 | same kind of virtual urls, so this option will probably be deprecated. |
334 | 342 | ||
335 | REPOSITORY SETTINGS | 343 | REPOSITORY SETTINGS |
336 | ------------------- | 344 | ------------------- |
337 | repo.about-filter:: | 345 | repo.about-filter:: |
338 | Override the default about-filter. Default value: none. See also: | 346 | Override the default about-filter. Default value: none. See also: |
339 | "enable-filter-overrides". | 347 | "enable-filter-overrides". |
340 | 348 | ||
341 | repo.clone-url:: | 349 | repo.clone-url:: |
342 | A list of space-separated urls which can be used to clone this repo. | 350 | A list of space-separated urls which can be used to clone this repo. |
343 | Default value: none. | 351 | Default value: none. |
344 | 352 | ||
345 | repo.commit-filter:: | 353 | repo.commit-filter:: |
346 | Override the default commit-filter. Default value: none. See also: | 354 | Override the default commit-filter. Default value: none. See also: |
347 | "enable-filter-overrides". | 355 | "enable-filter-overrides". |
348 | 356 | ||
349 | repo.defbranch:: | 357 | repo.defbranch:: |
350 | The name of the default branch for this repository. If no such branch | 358 | The name of the default branch for this repository. If no such branch |
351 | exists in the repository, the first branch name (when sorted) is used | 359 | exists in the repository, the first branch name (when sorted) is used |
352 | as default instead. Default value: "master". | 360 | as default instead. Default value: "master". |
353 | 361 | ||
354 | repo.desc:: | 362 | repo.desc:: |
355 | The value to show as repository description. Default value: none. | 363 | The value to show as repository description. Default value: none. |
356 | 364 | ||
357 | repo.enable-log-filecount:: | 365 | repo.enable-log-filecount:: |
358 | A flag which can be used to disable the global setting | 366 | A flag which can be used to disable the global setting |
359 | `enable-log-filecount'. Default value: none. | 367 | `enable-log-filecount'. Default value: none. |
360 | 368 | ||
361 | repo.enable-log-linecount:: | 369 | repo.enable-log-linecount:: |
362 | A flag which can be used to disable the global setting | 370 | A flag which can be used to disable the global setting |
363 | `enable-log-linecount'. Default value: none. | 371 | `enable-log-linecount'. Default value: none. |
364 | 372 | ||
365 | repo.enable-remote-branches:: | 373 | repo.enable-remote-branches:: |
366 | Flag which, when set to "1", will make cgit display remote branches | 374 | Flag which, when set to "1", will make cgit display remote branches |
367 | in the summary and refs views. Default value: <enable-remote-branches>. | 375 | in the summary and refs views. Default value: <enable-remote-branches>. |