-rw-r--r-- | cgit.c | 15 | ||||
-rw-r--r-- | cgit.h | 1 | ||||
-rw-r--r-- | cgitrc.5.txt | 21 |
3 files changed, 26 insertions, 11 deletions
@@ -37,126 +37,129 @@ struct cgit_filter *new_filter(const char *cmd, int extra_args) | |||
37 | f->argv = xmalloc((2 + extra_args) * sizeof(char *)); | 37 | f->argv = xmalloc((2 + extra_args) * sizeof(char *)); |
38 | f->argv[0] = f->cmd; | 38 | f->argv[0] = f->cmd; |
39 | f->argv[1] = NULL; | 39 | f->argv[1] = NULL; |
40 | return f; | 40 | return f; |
41 | } | 41 | } |
42 | 42 | ||
43 | static void process_cached_repolist(const char *path); | 43 | static void process_cached_repolist(const char *path); |
44 | 44 | ||
45 | void repo_config(struct cgit_repo *repo, const char *name, const char *value) | 45 | void repo_config(struct cgit_repo *repo, const char *name, const char *value) |
46 | { | 46 | { |
47 | if (!strcmp(name, "name")) | 47 | if (!strcmp(name, "name")) |
48 | repo->name = xstrdup(value); | 48 | repo->name = xstrdup(value); |
49 | else if (!strcmp(name, "clone-url")) | 49 | else if (!strcmp(name, "clone-url")) |
50 | repo->clone_url = xstrdup(value); | 50 | repo->clone_url = xstrdup(value); |
51 | else if (!strcmp(name, "desc")) | 51 | else if (!strcmp(name, "desc")) |
52 | repo->desc = xstrdup(value); | 52 | repo->desc = xstrdup(value); |
53 | else if (!strcmp(name, "owner")) | 53 | else if (!strcmp(name, "owner")) |
54 | repo->owner = xstrdup(value); | 54 | repo->owner = xstrdup(value); |
55 | else if (!strcmp(name, "defbranch")) | 55 | else if (!strcmp(name, "defbranch")) |
56 | repo->defbranch = xstrdup(value); | 56 | repo->defbranch = xstrdup(value); |
57 | else if (!strcmp(name, "snapshots")) | 57 | else if (!strcmp(name, "snapshots")) |
58 | repo->snapshots = ctx.cfg.snapshots & cgit_parse_snapshots_mask(value); | 58 | repo->snapshots = ctx.cfg.snapshots & cgit_parse_snapshots_mask(value); |
59 | else if (!strcmp(name, "enable-log-filecount")) | 59 | else if (!strcmp(name, "enable-log-filecount")) |
60 | repo->enable_log_filecount = ctx.cfg.enable_log_filecount * atoi(value); | 60 | repo->enable_log_filecount = ctx.cfg.enable_log_filecount * atoi(value); |
61 | else if (!strcmp(name, "enable-log-linecount")) | 61 | else if (!strcmp(name, "enable-log-linecount")) |
62 | repo->enable_log_linecount = ctx.cfg.enable_log_linecount * atoi(value); | 62 | repo->enable_log_linecount = ctx.cfg.enable_log_linecount * atoi(value); |
63 | else if (!strcmp(name, "max-stats")) | 63 | else if (!strcmp(name, "max-stats")) |
64 | repo->max_stats = cgit_find_stats_period(value, NULL); | 64 | repo->max_stats = cgit_find_stats_period(value, NULL); |
65 | else if (!strcmp(name, "module-link")) | 65 | else if (!strcmp(name, "module-link")) |
66 | repo->module_link= xstrdup(value); | 66 | repo->module_link= xstrdup(value); |
67 | else if (!strcmp(name, "section")) | 67 | else if (!strcmp(name, "section")) |
68 | repo->section = xstrdup(value); | 68 | repo->section = xstrdup(value); |
69 | else if (!strcmp(name, "about-filter")) | ||
70 | repo->about_filter = new_filter(value, 0); | ||
71 | else if (!strcmp(name, "commit-filter")) | ||
72 | repo->commit_filter = new_filter(value, 0); | ||
73 | else if (!strcmp(name, "source-filter")) | ||
74 | repo->source_filter = new_filter(value, 1); | ||
75 | else if (!strcmp(name, "readme") && value != NULL) { | 69 | else if (!strcmp(name, "readme") && value != NULL) { |
76 | if (*value == '/') | 70 | if (*value == '/') |
77 | ctx.repo->readme = xstrdup(value); | 71 | ctx.repo->readme = xstrdup(value); |
78 | else | 72 | else |
79 | ctx.repo->readme = xstrdup(fmt("%s/%s", ctx.repo->path, value)); | 73 | ctx.repo->readme = xstrdup(fmt("%s/%s", ctx.repo->path, value)); |
74 | } else if (ctx.cfg.enable_filter_overrides) { | ||
75 | if (!strcmp(name, "about-filter")) | ||
76 | repo->about_filter = new_filter(value, 0); | ||
77 | else if (!strcmp(name, "commit-filter")) | ||
78 | repo->commit_filter = new_filter(value, 0); | ||
79 | else if (!strcmp(name, "source-filter")) | ||
80 | repo->source_filter = new_filter(value, 1); | ||
80 | } | 81 | } |
81 | } | 82 | } |
82 | 83 | ||
83 | void config_cb(const char *name, const char *value) | 84 | void config_cb(const char *name, const char *value) |
84 | { | 85 | { |
85 | if (!strcmp(name, "section") || !strcmp(name, "repo.group")) | 86 | if (!strcmp(name, "section") || !strcmp(name, "repo.group")) |
86 | ctx.cfg.section = xstrdup(value); | 87 | ctx.cfg.section = xstrdup(value); |
87 | else if (!strcmp(name, "repo.url")) | 88 | else if (!strcmp(name, "repo.url")) |
88 | ctx.repo = cgit_add_repo(value); | 89 | ctx.repo = cgit_add_repo(value); |
89 | else if (ctx.repo && !strcmp(name, "repo.path")) | 90 | else if (ctx.repo && !strcmp(name, "repo.path")) |
90 | ctx.repo->path = trim_end(value, '/'); | 91 | ctx.repo->path = trim_end(value, '/'); |
91 | else if (ctx.repo && !prefixcmp(name, "repo.")) | 92 | else if (ctx.repo && !prefixcmp(name, "repo.")) |
92 | repo_config(ctx.repo, name + 5, value); | 93 | repo_config(ctx.repo, name + 5, value); |
93 | else if (!strcmp(name, "root-title")) | 94 | else if (!strcmp(name, "root-title")) |
94 | ctx.cfg.root_title = xstrdup(value); | 95 | ctx.cfg.root_title = xstrdup(value); |
95 | else if (!strcmp(name, "root-desc")) | 96 | else if (!strcmp(name, "root-desc")) |
96 | ctx.cfg.root_desc = xstrdup(value); | 97 | ctx.cfg.root_desc = xstrdup(value); |
97 | else if (!strcmp(name, "root-readme")) | 98 | else if (!strcmp(name, "root-readme")) |
98 | ctx.cfg.root_readme = xstrdup(value); | 99 | ctx.cfg.root_readme = xstrdup(value); |
99 | else if (!strcmp(name, "css")) | 100 | else if (!strcmp(name, "css")) |
100 | ctx.cfg.css = xstrdup(value); | 101 | ctx.cfg.css = xstrdup(value); |
101 | else if (!strcmp(name, "favicon")) | 102 | else if (!strcmp(name, "favicon")) |
102 | ctx.cfg.favicon = xstrdup(value); | 103 | ctx.cfg.favicon = xstrdup(value); |
103 | else if (!strcmp(name, "footer")) | 104 | else if (!strcmp(name, "footer")) |
104 | ctx.cfg.footer = xstrdup(value); | 105 | ctx.cfg.footer = xstrdup(value); |
105 | else if (!strcmp(name, "head-include")) | 106 | else if (!strcmp(name, "head-include")) |
106 | ctx.cfg.head_include = xstrdup(value); | 107 | ctx.cfg.head_include = xstrdup(value); |
107 | else if (!strcmp(name, "header")) | 108 | else if (!strcmp(name, "header")) |
108 | ctx.cfg.header = xstrdup(value); | 109 | ctx.cfg.header = xstrdup(value); |
109 | else if (!strcmp(name, "logo")) | 110 | else if (!strcmp(name, "logo")) |
110 | ctx.cfg.logo = xstrdup(value); | 111 | ctx.cfg.logo = xstrdup(value); |
111 | else if (!strcmp(name, "index-header")) | 112 | else if (!strcmp(name, "index-header")) |
112 | ctx.cfg.index_header = xstrdup(value); | 113 | ctx.cfg.index_header = xstrdup(value); |
113 | else if (!strcmp(name, "index-info")) | 114 | else if (!strcmp(name, "index-info")) |
114 | ctx.cfg.index_info = xstrdup(value); | 115 | ctx.cfg.index_info = xstrdup(value); |
115 | else if (!strcmp(name, "logo-link")) | 116 | else if (!strcmp(name, "logo-link")) |
116 | ctx.cfg.logo_link = xstrdup(value); | 117 | ctx.cfg.logo_link = xstrdup(value); |
117 | else if (!strcmp(name, "module-link")) | 118 | else if (!strcmp(name, "module-link")) |
118 | ctx.cfg.module_link = xstrdup(value); | 119 | ctx.cfg.module_link = xstrdup(value); |
119 | else if (!strcmp(name, "virtual-root")) { | 120 | else if (!strcmp(name, "virtual-root")) { |
120 | ctx.cfg.virtual_root = trim_end(value, '/'); | 121 | ctx.cfg.virtual_root = trim_end(value, '/'); |
121 | if (!ctx.cfg.virtual_root && (!strcmp(value, "/"))) | 122 | if (!ctx.cfg.virtual_root && (!strcmp(value, "/"))) |
122 | ctx.cfg.virtual_root = ""; | 123 | ctx.cfg.virtual_root = ""; |
123 | } else if (!strcmp(name, "nocache")) | 124 | } else if (!strcmp(name, "nocache")) |
124 | ctx.cfg.nocache = atoi(value); | 125 | ctx.cfg.nocache = atoi(value); |
125 | else if (!strcmp(name, "noplainemail")) | 126 | else if (!strcmp(name, "noplainemail")) |
126 | ctx.cfg.noplainemail = atoi(value); | 127 | ctx.cfg.noplainemail = atoi(value); |
127 | else if (!strcmp(name, "noheader")) | 128 | else if (!strcmp(name, "noheader")) |
128 | ctx.cfg.noheader = atoi(value); | 129 | ctx.cfg.noheader = atoi(value); |
129 | else if (!strcmp(name, "snapshots")) | 130 | else if (!strcmp(name, "snapshots")) |
130 | ctx.cfg.snapshots = cgit_parse_snapshots_mask(value); | 131 | ctx.cfg.snapshots = cgit_parse_snapshots_mask(value); |
132 | else if (!strcmp(name, "enable-filter-overrides")) | ||
133 | ctx.cfg.enable_filter_overrides = atoi(value); | ||
131 | else if (!strcmp(name, "enable-index-links")) | 134 | else if (!strcmp(name, "enable-index-links")) |
132 | ctx.cfg.enable_index_links = atoi(value); | 135 | ctx.cfg.enable_index_links = atoi(value); |
133 | else if (!strcmp(name, "enable-log-filecount")) | 136 | else if (!strcmp(name, "enable-log-filecount")) |
134 | ctx.cfg.enable_log_filecount = atoi(value); | 137 | ctx.cfg.enable_log_filecount = atoi(value); |
135 | else if (!strcmp(name, "enable-log-linecount")) | 138 | else if (!strcmp(name, "enable-log-linecount")) |
136 | ctx.cfg.enable_log_linecount = atoi(value); | 139 | ctx.cfg.enable_log_linecount = atoi(value); |
137 | else if (!strcmp(name, "max-stats")) | 140 | else if (!strcmp(name, "max-stats")) |
138 | ctx.cfg.max_stats = cgit_find_stats_period(value, NULL); | 141 | ctx.cfg.max_stats = cgit_find_stats_period(value, NULL); |
139 | else if (!strcmp(name, "cache-size")) | 142 | else if (!strcmp(name, "cache-size")) |
140 | ctx.cfg.cache_size = atoi(value); | 143 | ctx.cfg.cache_size = atoi(value); |
141 | else if (!strcmp(name, "cache-root")) | 144 | else if (!strcmp(name, "cache-root")) |
142 | ctx.cfg.cache_root = xstrdup(value); | 145 | ctx.cfg.cache_root = xstrdup(value); |
143 | else if (!strcmp(name, "cache-root-ttl")) | 146 | else if (!strcmp(name, "cache-root-ttl")) |
144 | ctx.cfg.cache_root_ttl = atoi(value); | 147 | ctx.cfg.cache_root_ttl = atoi(value); |
145 | else if (!strcmp(name, "cache-repo-ttl")) | 148 | else if (!strcmp(name, "cache-repo-ttl")) |
146 | ctx.cfg.cache_repo_ttl = atoi(value); | 149 | ctx.cfg.cache_repo_ttl = atoi(value); |
147 | else if (!strcmp(name, "cache-scanrc-ttl")) | 150 | else if (!strcmp(name, "cache-scanrc-ttl")) |
148 | ctx.cfg.cache_scanrc_ttl = atoi(value); | 151 | ctx.cfg.cache_scanrc_ttl = atoi(value); |
149 | else if (!strcmp(name, "cache-static-ttl")) | 152 | else if (!strcmp(name, "cache-static-ttl")) |
150 | ctx.cfg.cache_static_ttl = atoi(value); | 153 | ctx.cfg.cache_static_ttl = atoi(value); |
151 | else if (!strcmp(name, "cache-dynamic-ttl")) | 154 | else if (!strcmp(name, "cache-dynamic-ttl")) |
152 | ctx.cfg.cache_dynamic_ttl = atoi(value); | 155 | ctx.cfg.cache_dynamic_ttl = atoi(value); |
153 | else if (!strcmp(name, "about-filter")) | 156 | else if (!strcmp(name, "about-filter")) |
154 | ctx.cfg.about_filter = new_filter(value, 0); | 157 | ctx.cfg.about_filter = new_filter(value, 0); |
155 | else if (!strcmp(name, "commit-filter")) | 158 | else if (!strcmp(name, "commit-filter")) |
156 | ctx.cfg.commit_filter = new_filter(value, 0); | 159 | ctx.cfg.commit_filter = new_filter(value, 0); |
157 | else if (!strcmp(name, "embedded")) | 160 | else if (!strcmp(name, "embedded")) |
158 | ctx.cfg.embedded = atoi(value); | 161 | ctx.cfg.embedded = atoi(value); |
159 | else if (!strcmp(name, "max-message-length")) | 162 | else if (!strcmp(name, "max-message-length")) |
160 | ctx.cfg.max_msg_len = atoi(value); | 163 | ctx.cfg.max_msg_len = atoi(value); |
161 | else if (!strcmp(name, "max-repodesc-length")) | 164 | else if (!strcmp(name, "max-repodesc-length")) |
162 | ctx.cfg.max_repodesc_len = atoi(value); | 165 | ctx.cfg.max_repodesc_len = atoi(value); |
@@ -145,64 +145,65 @@ struct cgit_query { | |||
145 | int showmsg; | 145 | int showmsg; |
146 | }; | 146 | }; |
147 | 147 | ||
148 | struct cgit_config { | 148 | struct cgit_config { |
149 | char *agefile; | 149 | char *agefile; |
150 | char *cache_root; | 150 | char *cache_root; |
151 | char *clone_prefix; | 151 | char *clone_prefix; |
152 | char *css; | 152 | char *css; |
153 | char *favicon; | 153 | char *favicon; |
154 | char *footer; | 154 | char *footer; |
155 | char *head_include; | 155 | char *head_include; |
156 | char *header; | 156 | char *header; |
157 | char *index_header; | 157 | char *index_header; |
158 | char *index_info; | 158 | char *index_info; |
159 | char *logo; | 159 | char *logo; |
160 | char *logo_link; | 160 | char *logo_link; |
161 | char *module_link; | 161 | char *module_link; |
162 | char *robots; | 162 | char *robots; |
163 | char *root_title; | 163 | char *root_title; |
164 | char *root_desc; | 164 | char *root_desc; |
165 | char *root_readme; | 165 | char *root_readme; |
166 | char *script_name; | 166 | char *script_name; |
167 | char *section; | 167 | char *section; |
168 | char *virtual_root; | 168 | char *virtual_root; |
169 | int cache_size; | 169 | int cache_size; |
170 | int cache_dynamic_ttl; | 170 | int cache_dynamic_ttl; |
171 | int cache_max_create_time; | 171 | int cache_max_create_time; |
172 | int cache_repo_ttl; | 172 | int cache_repo_ttl; |
173 | int cache_root_ttl; | 173 | int cache_root_ttl; |
174 | int cache_scanrc_ttl; | 174 | int cache_scanrc_ttl; |
175 | int cache_static_ttl; | 175 | int cache_static_ttl; |
176 | int embedded; | 176 | int embedded; |
177 | int enable_filter_overrides; | ||
177 | int enable_index_links; | 178 | int enable_index_links; |
178 | int enable_log_filecount; | 179 | int enable_log_filecount; |
179 | int enable_log_linecount; | 180 | int enable_log_linecount; |
180 | int local_time; | 181 | int local_time; |
181 | int max_repo_count; | 182 | int max_repo_count; |
182 | int max_commit_count; | 183 | int max_commit_count; |
183 | int max_lock_attempts; | 184 | int max_lock_attempts; |
184 | int max_msg_len; | 185 | int max_msg_len; |
185 | int max_repodesc_len; | 186 | int max_repodesc_len; |
186 | int max_stats; | 187 | int max_stats; |
187 | int nocache; | 188 | int nocache; |
188 | int noplainemail; | 189 | int noplainemail; |
189 | int noheader; | 190 | int noheader; |
190 | int renamelimit; | 191 | int renamelimit; |
191 | int snapshots; | 192 | int snapshots; |
192 | int summary_branches; | 193 | int summary_branches; |
193 | int summary_log; | 194 | int summary_log; |
194 | int summary_tags; | 195 | int summary_tags; |
195 | struct string_list mimetypes; | 196 | struct string_list mimetypes; |
196 | struct cgit_filter *about_filter; | 197 | struct cgit_filter *about_filter; |
197 | struct cgit_filter *commit_filter; | 198 | struct cgit_filter *commit_filter; |
198 | struct cgit_filter *source_filter; | 199 | struct cgit_filter *source_filter; |
199 | }; | 200 | }; |
200 | 201 | ||
201 | struct cgit_page { | 202 | struct cgit_page { |
202 | time_t modified; | 203 | time_t modified; |
203 | time_t expires; | 204 | time_t expires; |
204 | size_t size; | 205 | size_t size; |
205 | char *mimetype; | 206 | char *mimetype; |
206 | char *charset; | 207 | char *charset; |
207 | char *filename; | 208 | char *filename; |
208 | char *etag; | 209 | char *etag; |
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 46df291..617b7c3 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -59,64 +59,68 @@ cache-scanrc-ttl:: | |||
59 | of scanning a path for git repositories. Default value: "15". | 59 | of scanning a path for git repositories. Default value: "15". |
60 | 60 | ||
61 | cache-size:: | 61 | cache-size:: |
62 | The maximum number of entries in the cgit cache. Default value: "0" | 62 | The maximum number of entries in the cgit cache. Default value: "0" |
63 | (i.e. caching is disabled). | 63 | (i.e. caching is disabled). |
64 | 64 | ||
65 | cache-static-ttl:: | 65 | cache-static-ttl:: |
66 | Number which specifies the time-to-live, in minutes, for the cached | 66 | Number which specifies the time-to-live, in minutes, for the cached |
67 | version of repository pages accessed with a fixed SHA1. Default value: | 67 | version of repository pages accessed with a fixed SHA1. Default value: |
68 | "5". | 68 | "5". |
69 | 69 | ||
70 | clone-prefix:: | 70 | clone-prefix:: |
71 | Space-separated list of common prefixes which, when combined with a | 71 | Space-separated list of common prefixes which, when combined with a |
72 | repository url, generates valid clone urls for the repository. This | 72 | repository url, generates valid clone urls for the repository. This |
73 | setting is only used if `repo.clone-url` is unspecified. Default value: | 73 | setting is only used if `repo.clone-url` is unspecified. Default value: |
74 | none. | 74 | none. |
75 | 75 | ||
76 | commit-filter:: | 76 | commit-filter:: |
77 | Specifies a command which will be invoked to format commit messages. | 77 | Specifies a command which will be invoked to format commit messages. |
78 | The command will get the message on its STDIN, and the STDOUT from the | 78 | The command will get the message on its STDIN, and the STDOUT from the |
79 | command will be included verbatim as the commit message, i.e. this can | 79 | command will be included verbatim as the commit message, i.e. this can |
80 | be used to implement bugtracker integration. Default value: none. | 80 | be used to implement bugtracker integration. Default value: none. |
81 | 81 | ||
82 | css:: | 82 | css:: |
83 | Url which specifies the css document to include in all cgit pages. | 83 | Url which specifies the css document to include in all cgit pages. |
84 | Default value: "/cgit.css". | 84 | Default value: "/cgit.css". |
85 | 85 | ||
86 | embedded:: | 86 | embedded:: |
87 | Flag which, when set to "1", will make cgit generate a html fragment | 87 | Flag which, when set to "1", will make cgit generate a html fragment |
88 | suitable for embedding in other html pages. Default value: none. See | 88 | suitable for embedding in other html pages. Default value: none. See |
89 | also: "noheader". | 89 | also: "noheader". |
90 | 90 | ||
91 | enable-filter-overrides:: | ||
92 | Flag which, when set to "1", allows all filter settings to be | ||
93 | overridden in repository-specific cgitrc files. Default value: none. | ||
94 | |||
91 | enable-index-links:: | 95 | enable-index-links:: |
92 | Flag which, when set to "1", will make cgit generate extra links for | 96 | Flag which, when set to "1", will make cgit generate extra links for |
93 | each repo in the repository index (specifically, to the "summary", | 97 | each repo in the repository index (specifically, to the "summary", |
94 | "commit" and "tree" pages). Default value: "0". | 98 | "commit" and "tree" pages). Default value: "0". |
95 | 99 | ||
96 | enable-log-filecount:: | 100 | enable-log-filecount:: |
97 | Flag which, when set to "1", will make cgit print the number of | 101 | Flag which, when set to "1", will make cgit print the number of |
98 | modified files for each commit on the repository log page. Default | 102 | modified files for each commit on the repository log page. Default |
99 | value: "0". | 103 | value: "0". |
100 | 104 | ||
101 | enable-log-linecount:: | 105 | enable-log-linecount:: |
102 | Flag which, when set to "1", will make cgit print the number of added | 106 | Flag which, when set to "1", will make cgit print the number of added |
103 | and removed lines for each commit on the repository log page. Default | 107 | and removed lines for each commit on the repository log page. Default |
104 | value: "0". | 108 | value: "0". |
105 | 109 | ||
106 | favicon:: | 110 | favicon:: |
107 | Url used as link to a shortcut icon for cgit. If specified, it is | 111 | Url used as link to a shortcut icon for cgit. If specified, it is |
108 | suggested to use the value "/favicon.ico" since certain browsers will | 112 | suggested to use the value "/favicon.ico" since certain browsers will |
109 | ignore other values. Default value: none. | 113 | ignore other values. Default value: none. |
110 | 114 | ||
111 | footer:: | 115 | footer:: |
112 | The content of the file specified with this option will be included | 116 | The content of the file specified with this option will be included |
113 | verbatim at the bottom of all pages (i.e. it replaces the standard | 117 | verbatim at the bottom of all pages (i.e. it replaces the standard |
114 | "generated by..." message. Default value: none. | 118 | "generated by..." message. Default value: none. |
115 | 119 | ||
116 | head-include:: | 120 | head-include:: |
117 | The content of the file specified with this option will be included | 121 | The content of the file specified with this option will be included |
118 | verbatim in the html HEAD section on all pages. Default value: none. | 122 | verbatim in the html HEAD section on all pages. Default value: none. |
119 | 123 | ||
120 | header:: | 124 | header:: |
121 | The content of the file specified with this option will be included | 125 | The content of the file specified with this option will be included |
122 | verbatim at the top of all pages. Default value: none. | 126 | verbatim at the top of all pages. Default value: none. |
@@ -237,132 +241,139 @@ snapshots:: | |||
237 | 241 | ||
238 | source-filter:: | 242 | source-filter:: |
239 | Specifies a command which will be invoked to format plaintext blobs | 243 | Specifies a command which will be invoked to format plaintext blobs |
240 | in the tree view. The command will get the blob content on its STDIN | 244 | in the tree view. The command will get the blob content on its STDIN |
241 | and the name of the blob as its only command line argument. The STDOUT | 245 | and the name of the blob as its only command line argument. The STDOUT |
242 | from the command will be included verbatim as the blob contents, i.e. | 246 | from the command will be included verbatim as the blob contents, i.e. |
243 | this can be used to implement e.g. syntax highlighting. Default value: | 247 | this can be used to implement e.g. syntax highlighting. Default value: |
244 | none. | 248 | none. |
245 | 249 | ||
246 | summary-branches:: | 250 | summary-branches:: |
247 | Specifies the number of branches to display in the repository "summary" | 251 | Specifies the number of branches to display in the repository "summary" |
248 | view. Default value: "10". | 252 | view. Default value: "10". |
249 | 253 | ||
250 | summary-log:: | 254 | summary-log:: |
251 | Specifies the number of log entries to display in the repository | 255 | Specifies the number of log entries to display in the repository |
252 | "summary" view. Default value: "10". | 256 | "summary" view. Default value: "10". |
253 | 257 | ||
254 | summary-tags:: | 258 | summary-tags:: |
255 | Specifies the number of tags to display in the repository "summary" | 259 | Specifies the number of tags to display in the repository "summary" |
256 | view. Default value: "10". | 260 | view. Default value: "10". |
257 | 261 | ||
258 | virtual-root:: | 262 | virtual-root:: |
259 | Url which, if specified, will be used as root for all cgit links. It | 263 | Url which, if specified, will be used as root for all cgit links. It |
260 | will also cause cgit to generate 'virtual urls', i.e. urls like | 264 | will also cause cgit to generate 'virtual urls', i.e. urls like |
261 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default | 265 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
262 | value: none. | 266 | value: none. |
263 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 267 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the |
264 | same kind of virtual urls, so this option will probably be deprecated. | 268 | same kind of virtual urls, so this option will probably be deprecated. |
265 | 269 | ||
266 | REPOSITORY SETTINGS | 270 | REPOSITORY SETTINGS |
267 | ------------------- | 271 | ------------------- |
268 | repo.about-filter:: | 272 | repo.about-filter:: |
269 | Override the default about-filter. Default value: <about-filter>. | 273 | Override the default about-filter. Default value: none. See also: |
274 | "enable-filter-overrides". | ||
270 | 275 | ||
271 | repo.clone-url:: | 276 | repo.clone-url:: |
272 | A list of space-separated urls which can be used to clone this repo. | 277 | A list of space-separated urls which can be used to clone this repo. |
273 | Default value: none. | 278 | Default value: none. |
274 | 279 | ||
275 | repo.commit-filter:: | 280 | repo.commit-filter:: |
276 | Override the default commit-filter. Default value: <commit-filter>. | 281 | Override the default commit-filter. Default value: none. See also: |
282 | "enable-filter-overrides". | ||
277 | 283 | ||
278 | repo.defbranch:: | 284 | repo.defbranch:: |
279 | The name of the default branch for this repository. If no such branch | 285 | The name of the default branch for this repository. If no such branch |
280 | exists in the repository, the first branch name (when sorted) is used | 286 | exists in the repository, the first branch name (when sorted) is used |
281 | as default instead. Default value: "master". | 287 | as default instead. Default value: "master". |
282 | 288 | ||
283 | repo.desc:: | 289 | repo.desc:: |
284 | The value to show as repository description. Default value: none. | 290 | The value to show as repository description. Default value: none. |
285 | 291 | ||
286 | repo.enable-log-filecount:: | 292 | repo.enable-log-filecount:: |
287 | A flag which can be used to disable the global setting | 293 | A flag which can be used to disable the global setting |
288 | `enable-log-filecount'. Default value: none. | 294 | `enable-log-filecount'. Default value: none. |
289 | 295 | ||
290 | repo.enable-log-linecount:: | 296 | repo.enable-log-linecount:: |
291 | A flag which can be used to disable the global setting | 297 | A flag which can be used to disable the global setting |
292 | `enable-log-linecount'. Default value: none. | 298 | `enable-log-linecount'. Default value: none. |
293 | 299 | ||
294 | repo.max-stats:: | 300 | repo.max-stats:: |
295 | Override the default maximum statistics period. Valid values are equal | 301 | Override the default maximum statistics period. Valid values are equal |
296 | to the values specified for the global "max-stats" setting. Default | 302 | to the values specified for the global "max-stats" setting. Default |
297 | value: none. | 303 | value: none. |
298 | 304 | ||
299 | repo.name:: | 305 | repo.name:: |
300 | The value to show as repository name. Default value: <repo.url>. | 306 | The value to show as repository name. Default value: <repo.url>. |
301 | 307 | ||
302 | repo.owner:: | 308 | repo.owner:: |
303 | A value used to identify the owner of the repository. Default value: | 309 | A value used to identify the owner of the repository. Default value: |
304 | none. | 310 | none. |
305 | 311 | ||
306 | repo.path:: | 312 | repo.path:: |
307 | An absolute path to the repository directory. For non-bare repositories | 313 | An absolute path to the repository directory. For non-bare repositories |
308 | this is the .git-directory. Default value: none. | 314 | this is the .git-directory. Default value: none. |
309 | 315 | ||
310 | repo.readme:: | 316 | repo.readme:: |
311 | A path (relative to <repo.path>) which specifies a file to include | 317 | A path (relative to <repo.path>) which specifies a file to include |
312 | verbatim as the "About" page for this repo. Default value: none. | 318 | verbatim as the "About" page for this repo. Default value: none. |
313 | 319 | ||
314 | repo.snapshots:: | 320 | repo.snapshots:: |
315 | A mask of allowed snapshot-formats for this repo, restricted by the | 321 | A mask of allowed snapshot-formats for this repo, restricted by the |
316 | "snapshots" global setting. Default value: <snapshots>. | 322 | "snapshots" global setting. Default value: <snapshots>. |
317 | 323 | ||
318 | repo.section:: | 324 | repo.section:: |
319 | Override the current section name for this repository. Default value: | 325 | Override the current section name for this repository. Default value: |
320 | none. | 326 | none. |
321 | 327 | ||
322 | repo.source-filter:: | 328 | repo.source-filter:: |
323 | Override the default source-filter. Default value: <source-filter>. | 329 | Override the default source-filter. Default value: none. See also: |
330 | "enable-filter-overrides". | ||
324 | 331 | ||
325 | repo.url:: | 332 | repo.url:: |
326 | The relative url used to access the repository. This must be the first | 333 | The relative url used to access the repository. This must be the first |
327 | setting specified for each repo. Default value: none. | 334 | setting specified for each repo. Default value: none. |
328 | 335 | ||
329 | 336 | ||
330 | REPOSITORY-SPECIFIC CGITRC FILE | 337 | REPOSITORY-SPECIFIC CGITRC FILE |
331 | ------------------------------- | 338 | ------------------------------- |
332 | When the option "scan-path" is used to auto-discover git repositories, cgit | 339 | When the option "scan-path" is used to auto-discover git repositories, cgit |
333 | will try to parse the file "cgitrc" within any found repository. Such a | 340 | will try to parse the file "cgitrc" within any found repository. Such a |
334 | repo-specific config file may contain any of the repo-specific options | 341 | repo-specific config file may contain any of the repo-specific options |
335 | described above, except "repo.url" and "repo.path". Also, in a repo-specific | 342 | described above, except "repo.url" and "repo.path". Additionally, the "filter" |
336 | config file, the "repo." prefix is dropped from the config option names. | 343 | options are only acknowledged in repo-specific config files when |
344 | "enable-filter-overrides" is set to "1". | ||
345 | |||
346 | Note: the "repo." prefix is dropped from the option names in repo-specific | ||
347 | config files, e.g. "repo.desc" becomes "desc". | ||
337 | 348 | ||
338 | 349 | ||
339 | EXAMPLE CGITRC FILE | 350 | EXAMPLE CGITRC FILE |
340 | ------------------- | 351 | ------------------- |
341 | 352 | ||
342 | .... | 353 | .... |
343 | # Enable caching of up to 1000 output entriess | 354 | # Enable caching of up to 1000 output entriess |
344 | cache-size=1000 | 355 | cache-size=1000 |
345 | 356 | ||
346 | 357 | ||
347 | # Specify some default clone prefixes | 358 | # Specify some default clone prefixes |
348 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git | 359 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git |
349 | 360 | ||
350 | # Specify the css url | 361 | # Specify the css url |
351 | css=/css/cgit.css | 362 | css=/css/cgit.css |
352 | 363 | ||
353 | 364 | ||
354 | # Show extra links for each repository on the index page | 365 | # Show extra links for each repository on the index page |
355 | enable-index-links=1 | 366 | enable-index-links=1 |
356 | 367 | ||
357 | 368 | ||
358 | # Show number of affected files per commit on the log pages | 369 | # Show number of affected files per commit on the log pages |
359 | enable-log-filecount=1 | 370 | enable-log-filecount=1 |
360 | 371 | ||
361 | 372 | ||
362 | # Show number of added/removed lines per commit on the log pages | 373 | # Show number of added/removed lines per commit on the log pages |
363 | enable-log-linecount=1 | 374 | enable-log-linecount=1 |
364 | 375 | ||
365 | 376 | ||
366 | # Add a cgit favicon | 377 | # Add a cgit favicon |
367 | favicon=/favicon.ico | 378 | favicon=/favicon.ico |
368 | 379 | ||