author | Lars Hjemli <hjemli@gmail.com> | 2009-01-12 07:57:23 (UTC) |
---|---|---|
committer | Lars Hjemli <hjemli@gmail.com> | 2009-01-12 07:57:23 (UTC) |
commit | e78186dcb63ec67a38dddfcd8f91d2108583320b (patch) (unidiff) | |
tree | e3aa15cee0b9705e3f4a5b56dab4de3d6091a5f2 | |
parent | 31665579c2779669c0cc56b8eb63f162b7e165df (diff) | |
parent | d529c6fbdca7ce3782e75b3a74baad21ef2f92c3 (diff) | |
download | cgit-e78186dcb63ec67a38dddfcd8f91d2108583320b.zip cgit-e78186dcb63ec67a38dddfcd8f91d2108583320b.tar.gz cgit-e78186dcb63ec67a38dddfcd8f91d2108583320b.tar.bz2 |
Merge branch 'stable'
-rw-r--r-- | Makefile | 15 | ||||
-rw-r--r-- | cgitrc.5.txt | 4 |
2 files changed, 11 insertions, 8 deletions
@@ -1,152 +1,155 @@ | |||
1 | CGIT_VERSION = v0.8.1 | 1 | CGIT_VERSION = v0.8.1 |
2 | CGIT_SCRIPT_NAME = cgit.cgi | 2 | CGIT_SCRIPT_NAME = cgit.cgi |
3 | CGIT_SCRIPT_PATH = /var/www/htdocs/cgit | 3 | CGIT_SCRIPT_PATH = /var/www/htdocs/cgit |
4 | CGIT_DATA_PATH = $(CGIT_SCRIPT_PATH) | ||
4 | CGIT_CONFIG = /etc/cgitrc | 5 | CGIT_CONFIG = /etc/cgitrc |
5 | CACHE_ROOT = /var/cache/cgit | 6 | CACHE_ROOT = /var/cache/cgit |
6 | SHA1_HEADER = <openssl/sha.h> | 7 | SHA1_HEADER = <openssl/sha.h> |
7 | GIT_VER = 1.6.1 | 8 | GIT_VER = 1.6.1 |
8 | GIT_URL = http://www.kernel.org/pub/software/scm/git/git-$(GIT_VER).tar.bz2 | 9 | GIT_URL = http://www.kernel.org/pub/software/scm/git/git-$(GIT_VER).tar.bz2 |
10 | INSTALL = install | ||
9 | 11 | ||
10 | # Define NO_STRCASESTR if you don't have strcasestr. | 12 | # Define NO_STRCASESTR if you don't have strcasestr. |
11 | # | 13 | # |
12 | # Define NEEDS_LIBICONV if linking with libc is not enough (eg. Darwin). | 14 | # Define NEEDS_LIBICONV if linking with libc is not enough (eg. Darwin). |
13 | # | 15 | # |
14 | 16 | ||
15 | #-include config.mak | 17 | #-include config.mak |
16 | 18 | ||
17 | # | 19 | # |
18 | # Platform specific tweaks | 20 | # Platform specific tweaks |
19 | # | 21 | # |
20 | 22 | ||
21 | uname_S := $(shell sh -c 'uname -s 2>/dev/null || echo not') | 23 | uname_S := $(shell sh -c 'uname -s 2>/dev/null || echo not') |
22 | uname_O := $(shell sh -c 'uname -o 2>/dev/null || echo not') | 24 | uname_O := $(shell sh -c 'uname -o 2>/dev/null || echo not') |
23 | uname_R := $(shell sh -c 'uname -r 2>/dev/null || echo not') | 25 | uname_R := $(shell sh -c 'uname -r 2>/dev/null || echo not') |
24 | 26 | ||
25 | ifeq ($(uname_O),Cygwin) | 27 | ifeq ($(uname_O),Cygwin) |
26 | NO_STRCASESTR = YesPlease | 28 | NO_STRCASESTR = YesPlease |
27 | NEEDS_LIBICONV = YesPlease | 29 | NEEDS_LIBICONV = YesPlease |
28 | endif | 30 | endif |
29 | 31 | ||
30 | # | 32 | # |
31 | # Let the user override the above settings. | 33 | # Let the user override the above settings. |
32 | # | 34 | # |
33 | -include cgit.conf | 35 | -include cgit.conf |
34 | 36 | ||
35 | # | 37 | # |
36 | # Define a way to invoke make in subdirs quietly, shamelessly ripped | 38 | # Define a way to invoke make in subdirs quietly, shamelessly ripped |
37 | # from git.git | 39 | # from git.git |
38 | # | 40 | # |
39 | QUIET_SUBDIR0 = +$(MAKE) -C # space to separate -C and subdir | 41 | QUIET_SUBDIR0 = +$(MAKE) -C # space to separate -C and subdir |
40 | QUIET_SUBDIR1 = | 42 | QUIET_SUBDIR1 = |
41 | 43 | ||
42 | ifneq ($(findstring $(MAKEFLAGS),w),w) | 44 | ifneq ($(findstring $(MAKEFLAGS),w),w) |
43 | PRINT_DIR = --no-print-directory | 45 | PRINT_DIR = --no-print-directory |
44 | else # "make -w" | 46 | else # "make -w" |
45 | NO_SUBDIR = : | 47 | NO_SUBDIR = : |
46 | endif | 48 | endif |
47 | 49 | ||
48 | ifndef V | 50 | ifndef V |
49 | QUIET_CC = @echo ' ' CC $@; | 51 | QUIET_CC = @echo ' ' CC $@; |
50 | QUIET_MM = @echo ' ' MM $@; | 52 | QUIET_MM = @echo ' ' MM $@; |
51 | QUIET_SUBDIR0 = +@subdir= | 53 | QUIET_SUBDIR0 = +@subdir= |
52 | QUIET_SUBDIR1 = ;$(NO_SUBDIR) echo ' ' SUBDIR $$subdir; \ | 54 | QUIET_SUBDIR1 = ;$(NO_SUBDIR) echo ' ' SUBDIR $$subdir; \ |
53 | $(MAKE) $(PRINT_DIR) -C $$subdir | 55 | $(MAKE) $(PRINT_DIR) -C $$subdir |
54 | endif | 56 | endif |
55 | 57 | ||
56 | # | 58 | # |
57 | # Define a pattern rule for automatic dependency building | 59 | # Define a pattern rule for automatic dependency building |
58 | # | 60 | # |
59 | %.d: %.c | 61 | %.d: %.c |
60 | $(QUIET_MM)$(CC) $(CFLAGS) -MM $< | sed -e 's/\($*\)\.o:/\1.o $@:/g' >$@ | 62 | $(QUIET_MM)$(CC) $(CFLAGS) -MM $< | sed -e 's/\($*\)\.o:/\1.o $@:/g' >$@ |
61 | 63 | ||
62 | # | 64 | # |
63 | # Define a pattern rule for silent object building | 65 | # Define a pattern rule for silent object building |
64 | # | 66 | # |
65 | %.o: %.c | 67 | %.o: %.c |
66 | $(QUIET_CC)$(CC) -o $*.o -c $(CFLAGS) $< | 68 | $(QUIET_CC)$(CC) -o $*.o -c $(CFLAGS) $< |
67 | 69 | ||
68 | 70 | ||
69 | EXTLIBS = git/libgit.a git/xdiff/lib.a -lz -lcrypto | 71 | EXTLIBS = git/libgit.a git/xdiff/lib.a -lz -lcrypto |
70 | OBJECTS = | 72 | OBJECTS = |
71 | OBJECTS += cache.o | 73 | OBJECTS += cache.o |
72 | OBJECTS += cgit.o | 74 | OBJECTS += cgit.o |
73 | OBJECTS += cmd.o | 75 | OBJECTS += cmd.o |
74 | OBJECTS += configfile.o | 76 | OBJECTS += configfile.o |
75 | OBJECTS += html.o | 77 | OBJECTS += html.o |
76 | OBJECTS += parsing.o | 78 | OBJECTS += parsing.o |
77 | OBJECTS += scan-tree.o | 79 | OBJECTS += scan-tree.o |
78 | OBJECTS += shared.o | 80 | OBJECTS += shared.o |
79 | OBJECTS += ui-atom.o | 81 | OBJECTS += ui-atom.o |
80 | OBJECTS += ui-blob.o | 82 | OBJECTS += ui-blob.o |
81 | OBJECTS += ui-clone.o | 83 | OBJECTS += ui-clone.o |
82 | OBJECTS += ui-commit.o | 84 | OBJECTS += ui-commit.o |
83 | OBJECTS += ui-diff.o | 85 | OBJECTS += ui-diff.o |
84 | OBJECTS += ui-log.o | 86 | OBJECTS += ui-log.o |
85 | OBJECTS += ui-patch.o | 87 | OBJECTS += ui-patch.o |
86 | OBJECTS += ui-plain.o | 88 | OBJECTS += ui-plain.o |
87 | OBJECTS += ui-refs.o | 89 | OBJECTS += ui-refs.o |
88 | OBJECTS += ui-repolist.o | 90 | OBJECTS += ui-repolist.o |
89 | OBJECTS += ui-shared.o | 91 | OBJECTS += ui-shared.o |
90 | OBJECTS += ui-snapshot.o | 92 | OBJECTS += ui-snapshot.o |
91 | OBJECTS += ui-summary.o | 93 | OBJECTS += ui-summary.o |
92 | OBJECTS += ui-tag.o | 94 | OBJECTS += ui-tag.o |
93 | OBJECTS += ui-tree.o | 95 | OBJECTS += ui-tree.o |
94 | 96 | ||
95 | ifdef NEEDS_LIBICONV | 97 | ifdef NEEDS_LIBICONV |
96 | EXTLIBS += -liconv | 98 | EXTLIBS += -liconv |
97 | endif | 99 | endif |
98 | 100 | ||
99 | 101 | ||
100 | .PHONY: all libgit test install uninstall clean force-version get-git | 102 | .PHONY: all libgit test install uninstall clean force-version get-git |
101 | 103 | ||
102 | all: cgit | 104 | all: cgit |
103 | 105 | ||
104 | VERSION: force-version | 106 | VERSION: force-version |
105 | @./gen-version.sh "$(CGIT_VERSION)" | 107 | @./gen-version.sh "$(CGIT_VERSION)" |
106 | -include VERSION | 108 | -include VERSION |
107 | 109 | ||
108 | 110 | ||
109 | CFLAGS += -g -Wall -Igit | 111 | CFLAGS += -g -Wall -Igit |
110 | CFLAGS += -DSHA1_HEADER='$(SHA1_HEADER)' | 112 | CFLAGS += -DSHA1_HEADER='$(SHA1_HEADER)' |
111 | CFLAGS += -DCGIT_VERSION='"$(CGIT_VERSION)"' | 113 | CFLAGS += -DCGIT_VERSION='"$(CGIT_VERSION)"' |
112 | CFLAGS += -DCGIT_CONFIG='"$(CGIT_CONFIG)"' | 114 | CFLAGS += -DCGIT_CONFIG='"$(CGIT_CONFIG)"' |
113 | CFLAGS += -DCGIT_SCRIPT_NAME='"$(CGIT_SCRIPT_NAME)"' | 115 | CFLAGS += -DCGIT_SCRIPT_NAME='"$(CGIT_SCRIPT_NAME)"' |
114 | CFLAGS += -DCGIT_CACHE_ROOT='"$(CACHE_ROOT)"' | 116 | CFLAGS += -DCGIT_CACHE_ROOT='"$(CACHE_ROOT)"' |
115 | 117 | ||
116 | ifdef NO_ICONV | 118 | ifdef NO_ICONV |
117 | CFLAGS += -DNO_ICONV | 119 | CFLAGS += -DNO_ICONV |
118 | endif | 120 | endif |
119 | ifdef NO_STRCASESTR | 121 | ifdef NO_STRCASESTR |
120 | CFLAGS += -DNO_STRCASESTR | 122 | CFLAGS += -DNO_STRCASESTR |
121 | endif | 123 | endif |
122 | 124 | ||
123 | cgit: $(OBJECTS) libgit | 125 | cgit: $(OBJECTS) libgit |
124 | $(QUIET_CC)$(CC) $(CFLAGS) $(LDFLAGS) -o cgit $(OBJECTS) $(EXTLIBS) | 126 | $(QUIET_CC)$(CC) $(CFLAGS) $(LDFLAGS) -o cgit $(OBJECTS) $(EXTLIBS) |
125 | 127 | ||
126 | cgit.o: VERSION | 128 | cgit.o: VERSION |
127 | 129 | ||
128 | -include $(OBJECTS:.o=.d) | 130 | -include $(OBJECTS:.o=.d) |
129 | 131 | ||
130 | libgit: | 132 | libgit: |
131 | $(QUIET_SUBDIR0)git $(QUIET_SUBDIR1) NO_CURL=1 libgit.a | 133 | $(QUIET_SUBDIR0)git $(QUIET_SUBDIR1) NO_CURL=1 libgit.a |
132 | $(QUIET_SUBDIR0)git $(QUIET_SUBDIR1) NO_CURL=1 xdiff/lib.a | 134 | $(QUIET_SUBDIR0)git $(QUIET_SUBDIR1) NO_CURL=1 xdiff/lib.a |
133 | 135 | ||
134 | test: all | 136 | test: all |
135 | $(QUIET_SUBDIR0)tests $(QUIET_SUBDIR1) all | 137 | $(QUIET_SUBDIR0)tests $(QUIET_SUBDIR1) all |
136 | 138 | ||
137 | install: all | 139 | install: all |
138 | mkdir -p $(DESTDIR)$(CGIT_SCRIPT_PATH) | 140 | $(INSTALL) -m 0755 -d $(DESTDIR)$(CGIT_SCRIPT_PATH) |
139 | install cgit $(DESTDIR)$(CGIT_SCRIPT_PATH)/$(CGIT_SCRIPT_NAME) | 141 | $(INSTALL) -m 0755 cgit $(DESTDIR)$(CGIT_SCRIPT_PATH)/$(CGIT_SCRIPT_NAME) |
140 | install -m 0644 cgit.css $(DESTDIR)$(CGIT_SCRIPT_PATH)/cgit.css | 142 | $(INSTALL) -m 0755 -d $(DESTDIR)$(CGIT_DATA_PATH) |
141 | install -m 0644 cgit.png $(DESTDIR)$(CGIT_SCRIPT_PATH)/cgit.png | 143 | $(INSTALL) -m 0644 cgit.css $(DESTDIR)$(CGIT_DATA_PATH)/cgit.css |
144 | $(INSTALL) -m 0644 cgit.png $(DESTDIR)$(CGIT_DATA_PATH)/cgit.png | ||
142 | 145 | ||
143 | uninstall: | 146 | uninstall: |
144 | rm -f $(CGIT_SCRIPT_PATH)/$(CGIT_SCRIPT_NAME) | 147 | rm -f $(CGIT_SCRIPT_PATH)/$(CGIT_SCRIPT_NAME) |
145 | rm -f $(CGIT_SCRIPT_PATH)/cgit.css | 148 | rm -f $(CGIT_DATA_PATH)/cgit.css |
146 | rm -f $(CGIT_SCRIPT_PATH)/cgit.png | 149 | rm -f $(CGIT_DATA_PATH)/cgit.png |
147 | 150 | ||
148 | clean: | 151 | clean: |
149 | rm -f cgit VERSION *.o *.d | 152 | rm -f cgit VERSION *.o *.d |
150 | 153 | ||
151 | get-git: | 154 | get-git: |
152 | curl $(GIT_URL) | tar -xj && rm -rf git && mv git-$(GIT_VER) git | 155 | curl $(GIT_URL) | tar -xj && rm -rf git && mv git-$(GIT_VER) git |
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 7887b02..ab9ab66 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt | |||
@@ -1,367 +1,367 @@ | |||
1 | CGITRC | 1 | CGITRC |
2 | ====== | 2 | ====== |
3 | 3 | ||
4 | 4 | ||
5 | NAME | 5 | NAME |
6 | ---- | 6 | ---- |
7 | cgitrc - runtime configuration for cgit | 7 | cgitrc - runtime configuration for cgit |
8 | 8 | ||
9 | 9 | ||
10 | DESCRIPTION | 10 | DESCRIPTION |
11 | ----------- | 11 | ----------- |
12 | Cgitrc contains all runtime settings for cgit, including the list of git | 12 | Cgitrc contains all runtime settings for cgit, including the list of git |
13 | repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank | 13 | repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank |
14 | lines, and lines starting with '#', are ignored. | 14 | lines, and lines starting with '#', are ignored. |
15 | 15 | ||
16 | 16 | ||
17 | GLOBAL SETTINGS | 17 | GLOBAL SETTINGS |
18 | --------------- | 18 | --------------- |
19 | agefile | 19 | agefile |
20 | Specifies a path, relative to each repository path, which can be used | 20 | Specifies a path, relative to each repository path, which can be used |
21 | to specify the date and time of the youngest commit in the repository. | 21 | to specify the date and time of the youngest commit in the repository. |
22 | The first line in the file is used as input to the "parse_date" | 22 | The first line in the file is used as input to the "parse_date" |
23 | function in libgit. Recommended timestamp-format is "yyyy-mm-dd | 23 | function in libgit. Recommended timestamp-format is "yyyy-mm-dd |
24 | hh:mm:ss". Default value: "info/web/last-modified". | 24 | hh:mm:ss". Default value: "info/web/last-modified". |
25 | 25 | ||
26 | cache-root | 26 | cache-root |
27 | Path used to store the cgit cache entries. Default value: | 27 | Path used to store the cgit cache entries. Default value: |
28 | "/var/cache/cgit". | 28 | "/var/cache/cgit". |
29 | 29 | ||
30 | cache-dynamic-ttl | 30 | cache-dynamic-ttl |
31 | Number which specifies the time-to-live, in minutes, for the cached | 31 | Number which specifies the time-to-live, in minutes, for the cached |
32 | version of repository pages accessed without a fixed SHA1. Default | 32 | version of repository pages accessed without a fixed SHA1. Default |
33 | value: "5". | 33 | value: "5". |
34 | 34 | ||
35 | cache-repo-ttl | 35 | cache-repo-ttl |
36 | Number which specifies the time-to-live, in minutes, for the cached | 36 | Number which specifies the time-to-live, in minutes, for the cached |
37 | version of the repository summary page. Default value: "5". | 37 | version of the repository summary page. Default value: "5". |
38 | 38 | ||
39 | cache-root-ttl | 39 | cache-root-ttl |
40 | Number which specifies the time-to-live, in minutes, for the cached | 40 | Number which specifies the time-to-live, in minutes, for the cached |
41 | version of the repository index page. Default value: "5". | 41 | version of the repository index page. Default value: "5". |
42 | 42 | ||
43 | cache-size | 43 | cache-size |
44 | The maximum number of entries in the cgit cache. Default value: "0" | 44 | The maximum number of entries in the cgit cache. Default value: "0" |
45 | (i.e. caching is disabled). | 45 | (i.e. caching is disabled). |
46 | 46 | ||
47 | cache-static-ttl | 47 | cache-static-ttl |
48 | Number which specifies the time-to-live, in minutes, for the cached | 48 | Number which specifies the time-to-live, in minutes, for the cached |
49 | version of repository pages accessed with a fixed SHA1. Default value: | 49 | version of repository pages accessed with a fixed SHA1. Default value: |
50 | "5". | 50 | "5". |
51 | 51 | ||
52 | clone-prefix | 52 | clone-prefix |
53 | Space-separated list of common prefixes which, when combined with a | 53 | Space-separated list of common prefixes which, when combined with a |
54 | repository url, generates valid clone urls for the repository. This | 54 | repository url, generates valid clone urls for the repository. This |
55 | setting is only used if `repo.clone-url` is unspecified. Default value: | 55 | setting is only used if `repo.clone-url` is unspecified. Default value: |
56 | none. | 56 | none. |
57 | 57 | ||
58 | css | 58 | css |
59 | Url which specifies the css document to include in all cgit pages. | 59 | Url which specifies the css document to include in all cgit pages. |
60 | Default value: "/cgit.css". | 60 | Default value: "/cgit.css". |
61 | 61 | ||
62 | enable-index-links | 62 | enable-index-links |
63 | Flag which, when set to "1", will make cgit generate extra links for | 63 | Flag which, when set to "1", will make cgit generate extra links for |
64 | each repo in the repository index (specifically, to the "summary", | 64 | each repo in the repository index (specifically, to the "summary", |
65 | "commit" and "tree" pages). Default value: "0". | 65 | "commit" and "tree" pages). Default value: "0". |
66 | 66 | ||
67 | enable-log-filecount | 67 | enable-log-filecount |
68 | Flag which, when set to "1", will make cgit print the number of | 68 | Flag which, when set to "1", will make cgit print the number of |
69 | modified files for each commit on the repository log page. Default | 69 | modified files for each commit on the repository log page. Default |
70 | value: "0". | 70 | value: "0". |
71 | 71 | ||
72 | enable-log-linecount | 72 | enable-log-linecount |
73 | Flag which, when set to "1", will make cgit print the number of added | 73 | Flag which, when set to "1", will make cgit print the number of added |
74 | and removed lines for each commit on the repository log page. Default | 74 | and removed lines for each commit on the repository log page. Default |
75 | value: "0". | 75 | value: "0". |
76 | 76 | ||
77 | favicon | 77 | favicon |
78 | Url used as link to a shortcut icon for cgit. If specified, it is | 78 | Url used as link to a shortcut icon for cgit. If specified, it is |
79 | suggested to use the value "/favicon.ico" since certain browsers will | 79 | suggested to use the value "/favicon.ico" since certain browsers will |
80 | ignore other values. Default value: none. | 80 | ignore other values. Default value: none. |
81 | 81 | ||
82 | footer | 82 | footer |
83 | The content of the file specified with this option will be included | 83 | The content of the file specified with this option will be included |
84 | verbatim at the bottom of all pages (i.e. it replaces the standard | 84 | verbatim at the bottom of all pages (i.e. it replaces the standard |
85 | "generated by..." message. Default value: none. | 85 | "generated by..." message. Default value: none. |
86 | 86 | ||
87 | include | 87 | include |
88 | Name of a configfile to include before the rest of the current config- | 88 | Name of a configfile to include before the rest of the current config- |
89 | file is parsed. Default value: none. | 89 | file is parsed. Default value: none. |
90 | 90 | ||
91 | index-header | 91 | index-header |
92 | The content of the file specified with this option will be included | 92 | The content of the file specified with this option will be included |
93 | verbatim above the repository index. This setting is deprecated, and | 93 | verbatim above the repository index. This setting is deprecated, and |
94 | will not be supported by cgit-1.0 (use root-readme instead). Default | 94 | will not be supported by cgit-1.0 (use root-readme instead). Default |
95 | value: none. | 95 | value: none. |
96 | 96 | ||
97 | index-info | 97 | index-info |
98 | The content of the file specified with this option will be included | 98 | The content of the file specified with this option will be included |
99 | verbatim below the heading on the repository index page. This setting | 99 | verbatim below the heading on the repository index page. This setting |
100 | is deprecated, and will not be supported by cgit-1.0 (use root-desc | 100 | is deprecated, and will not be supported by cgit-1.0 (use root-desc |
101 | instead). Default value: none. | 101 | instead). Default value: none. |
102 | 102 | ||
103 | local-time | 103 | local-time |
104 | Flag which, if set to "1", makes cgit print commit and tag times in the | 104 | Flag which, if set to "1", makes cgit print commit and tag times in the |
105 | servers timezone. Default value: "0". | 105 | servers timezone. Default value: "0". |
106 | 106 | ||
107 | logo | 107 | logo |
108 | Url which specifies the source of an image which will be used as a logo | 108 | Url which specifies the source of an image which will be used as a logo |
109 | on all cgit pages. | 109 | on all cgit pages. |
110 | 110 | ||
111 | logo-link | 111 | logo-link |
112 | Url loaded when clicking on the cgit logo image. If unspecified the | 112 | Url loaded when clicking on the cgit logo image. If unspecified the |
113 | calculated url of the repository index page will be used. Default | 113 | calculated url of the repository index page will be used. Default |
114 | value: none. | 114 | value: none. |
115 | 115 | ||
116 | max-commit-count | 116 | max-commit-count |
117 | Specifies the number of entries to list per page in "log" view. Default | 117 | Specifies the number of entries to list per page in "log" view. Default |
118 | value: "50". | 118 | value: "50". |
119 | 119 | ||
120 | max-message-length | 120 | max-message-length |
121 | Specifies the maximum number of commit message characters to display in | 121 | Specifies the maximum number of commit message characters to display in |
122 | "log" view. Default value: "80". | 122 | "log" view. Default value: "80". |
123 | 123 | ||
124 | max-repo-count | 124 | max-repo-count |
125 | Specifies the number of entries to list per page on therepository | 125 | Specifies the number of entries to list per page on therepository |
126 | index page. Default value: "50". | 126 | index page. Default value: "50". |
127 | 127 | ||
128 | max-repodesc-length | 128 | max-repodesc-length |
129 | Specifies the maximum number of repo description characters to display | 129 | Specifies the maximum number of repo description characters to display |
130 | on the repository index page. Default value: "80". | 130 | on the repository index page. Default value: "80". |
131 | 131 | ||
132 | module-link | 132 | module-link |
133 | Text which will be used as the formatstring for a hyperlink when a | 133 | Text which will be used as the formatstring for a hyperlink when a |
134 | submodule is printed in a directory listing. The arguments for the | 134 | submodule is printed in a directory listing. The arguments for the |
135 | formatstring are the path and SHA1 of the submodule commit. Default | 135 | formatstring are the path and SHA1 of the submodule commit. Default |
136 | value: "./?repo=%s&page=commit&id=%s" | 136 | value: "./?repo=%s&page=commit&id=%s" |
137 | 137 | ||
138 | nocache | 138 | nocache |
139 | If set to the value "1" caching will be disabled. This settings is | 139 | If set to the value "1" caching will be disabled. This settings is |
140 | deprecated, and will not be honored starting with cgit-1.0. Default | 140 | deprecated, and will not be honored starting with cgit-1.0. Default |
141 | value: "0". | 141 | value: "0". |
142 | 142 | ||
143 | renamelimit | 143 | renamelimit |
144 | Maximum number of files to consider when detecting renames. The value | 144 | Maximum number of files to consider when detecting renames. The value |
145 | "-1" uses the compiletime value in git (for further info, look at | 145 | "-1" uses the compiletime value in git (for further info, look at |
146 | `man git-diff`). Default value: "-1". | 146 | `man git-diff`). Default value: "-1". |
147 | 147 | ||
148 | repo.group | 148 | repo.group |
149 | A value for the current repository group, which all repositories | 149 | A value for the current repository group, which all repositories |
150 | specified after this setting will inherit. Default value: none. | 150 | specified after this setting will inherit. Default value: none. |
151 | 151 | ||
152 | robots | 152 | robots |
153 | Text used as content for the "robots" meta-tag. Default value: | 153 | Text used as content for the "robots" meta-tag. Default value: |
154 | "index, nofollow". | 154 | "index, nofollow". |
155 | 155 | ||
156 | root-desc | 156 | root-desc |
157 | Text printed below the heading on the repository index page. Default | 157 | Text printed below the heading on the repository index page. Default |
158 | value: "a fast webinterface for the git dscm". | 158 | value: "a fast webinterface for the git dscm". |
159 | 159 | ||
160 | root-readme: | 160 | root-readme: |
161 | The content of the file specified with this option will be included | 161 | The content of the file specified with this option will be included |
162 | verbatim below the "about" link on the repository index page. Default | 162 | verbatim below the "about" link on the repository index page. Default |
163 | value: none. | 163 | value: none. |
164 | 164 | ||
165 | root-title | 165 | root-title |
166 | Text printed as heading on the repository index page. Default value: | 166 | Text printed as heading on the repository index page. Default value: |
167 | "Git Repository Browser". | 167 | "Git Repository Browser". |
168 | 168 | ||
169 | snapshots | 169 | snapshots |
170 | Text which specifies the default (and allowed) set of snapshot formats | 170 | Text which specifies the default (and allowed) set of snapshot formats |
171 | supported by cgit. The value is a space-separated list of zero or more | 171 | supported by cgit. The value is a space-separated list of zero or more |
172 | of the following values: | 172 | of the following values: |
173 | "tar" uncompressed tar-file | 173 | "tar" uncompressed tar-file |
174 | "tar.gz"gzip-compressed tar-file | 174 | "tar.gz"gzip-compressed tar-file |
175 | "tar.bz2"bzip-compressed tar-file | 175 | "tar.bz2"bzip-compressed tar-file |
176 | "zip" zip-file | 176 | "zip" zip-file |
177 | Default value: none. | 177 | Default value: none. |
178 | 178 | ||
179 | summary-branches | 179 | summary-branches |
180 | Specifies the number of branches to display in the repository "summary" | 180 | Specifies the number of branches to display in the repository "summary" |
181 | view. Default value: "10". | 181 | view. Default value: "10". |
182 | 182 | ||
183 | summary-log | 183 | summary-log |
184 | Specifies the number of log entries to display in the repository | 184 | Specifies the number of log entries to display in the repository |
185 | "summary" view. Default value: "10". | 185 | "summary" view. Default value: "10". |
186 | 186 | ||
187 | summary-tags | 187 | summary-tags |
188 | Specifies the number of tags to display in the repository "summary" | 188 | Specifies the number of tags to display in the repository "summary" |
189 | view. Default value: "10". | 189 | view. Default value: "10". |
190 | 190 | ||
191 | virtual-root | 191 | virtual-root |
192 | Url which, if specified, will be used as root for all cgit links. It | 192 | Url which, if specified, will be used as root for all cgit links. It |
193 | will also cause cgit to generate 'virtual urls', i.e. urls like | 193 | will also cause cgit to generate 'virtual urls', i.e. urls like |
194 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default | 194 | '/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default |
195 | value: none. | 195 | value: none. |
196 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the | 196 | NOTE: cgit has recently learned how to use PATH_INFO to achieve the |
197 | same kind of virtual urls, so this option will probably be deprecated. | 197 | same kind of virtual urls, so this option will probably be deprecated. |
198 | 198 | ||
199 | REPOSITORY SETTINGS | 199 | REPOSITORY SETTINGS |
200 | ------------------- | 200 | ------------------- |
201 | repo.clone-url | 201 | repo.clone-url |
202 | A list of space-separated urls which can be used to clone this repo. | 202 | A list of space-separated urls which can be used to clone this repo. |
203 | Default value: none. | 203 | Default value: none. |
204 | 204 | ||
205 | repo.defbranch | 205 | repo.defbranch |
206 | The name of the default branch for this repository. If no such branch | 206 | The name of the default branch for this repository. If no such branch |
207 | exists in the repository, the first branch name (when sorted) is used | 207 | exists in the repository, the first branch name (when sorted) is used |
208 | as default instead. Default value: "master". | 208 | as default instead. Default value: "master". |
209 | 209 | ||
210 | repo.desc | 210 | repo.desc |
211 | The value to show as repository description. Default value: none. | 211 | The value to show as repository description. Default value: none. |
212 | 212 | ||
213 | repo.enable-log-filecount | 213 | repo.enable-log-filecount |
214 | A flag which can be used to disable the global setting | 214 | A flag which can be used to disable the global setting |
215 | `enable-log-filecount'. Default value: none. | 215 | `enable-log-filecount'. Default value: none. |
216 | 216 | ||
217 | repo.enable-log-linecount | 217 | repo.enable-log-linecount |
218 | A flag which can be used to disable the global setting | 218 | A flag which can be used to disable the global setting |
219 | `enable-log-linecount'. Default value: none. | 219 | `enable-log-linecount'. Default value: none. |
220 | 220 | ||
221 | repo.name | 221 | repo.name |
222 | The value to show as repository name. Default value: <repo.url>. | 222 | The value to show as repository name. Default value: <repo.url>. |
223 | 223 | ||
224 | repo.owner | 224 | repo.owner |
225 | A value used to identify the owner of the repository. Default value: | 225 | A value used to identify the owner of the repository. Default value: |
226 | none. | 226 | none. |
227 | 227 | ||
228 | repo.path | 228 | repo.path |
229 | An absolute path to the repository directory. For non-bare repositories | 229 | An absolute path to the repository directory. For non-bare repositories |
230 | this is the .git-directory. Default value: none. | 230 | this is the .git-directory. Default value: none. |
231 | 231 | ||
232 | repo.readme | 232 | repo.readme |
233 | A path (relative to <repo.path>) which specifies a file to include | 233 | A path (relative to <repo.path>) which specifies a file to include |
234 | verbatim as the "About" page for this repo. Default value: none. | 234 | verbatim as the "About" page for this repo. Default value: none. |
235 | 235 | ||
236 | repo.snapshots | 236 | repo.snapshots |
237 | A mask of allowed snapshot-formats for this repo, restricted by the | 237 | A mask of allowed snapshot-formats for this repo, restricted by the |
238 | "snapshots" global setting. Default value: <snapshots>. | 238 | "snapshots" global setting. Default value: <snapshots>. |
239 | 239 | ||
240 | repo.url | 240 | repo.url |
241 | The relative url used to access the repository. This must be the first | 241 | The relative url used to access the repository. This must be the first |
242 | setting specified for each repo. Default value: none. | 242 | setting specified for each repo. Default value: none. |
243 | 243 | ||
244 | 244 | ||
245 | EXAMPLE CGITRC FILE | 245 | EXAMPLE CGITRC FILE |
246 | ------------------- | 246 | ------------------- |
247 | 247 | ||
248 | # Enable caching of up to 1000 output entriess | 248 | # Enable caching of up to 1000 output entriess |
249 | cache-size=1000 | 249 | cache-size=1000 |
250 | 250 | ||
251 | 251 | ||
252 | # Specify some default clone prefixes | 252 | # Specify some default clone prefixes |
253 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git | 253 | clone-prefix=git://foobar.com ssh://foobar.com/pub/git http://foobar.com/git |
254 | 254 | ||
255 | # Specify the css url | 255 | # Specify the css url |
256 | css=/css/cgit.css | 256 | css=/css/cgit.css |
257 | 257 | ||
258 | 258 | ||
259 | # Show extra links for each repository on the index page | 259 | # Show extra links for each repository on the index page |
260 | enable-index-links=1 | 260 | enable-index-links=1 |
261 | 261 | ||
262 | 262 | ||
263 | # Show number of affected files per commit on the log pages | 263 | # Show number of affected files per commit on the log pages |
264 | enable-log-filecount=1 | 264 | enable-log-filecount=1 |
265 | 265 | ||
266 | 266 | ||
267 | # Show number of added/removed lines per commit on the log pages | 267 | # Show number of added/removed lines per commit on the log pages |
268 | enable-log-linecount=1 | 268 | enable-log-linecount=1 |
269 | 269 | ||
270 | 270 | ||
271 | # Add a cgit favicon | 271 | # Add a cgit favicon |
272 | favicon=/favicon.ico | 272 | favicon=/favicon.ico |
273 | 273 | ||
274 | 274 | ||
275 | # Use a custom logo | 275 | # Use a custom logo |
276 | logo=/img/mylogo.png | 276 | logo=/img/mylogo.png |
277 | 277 | ||
278 | 278 | ||
279 | # Set the title and heading of the repository index page | 279 | # Set the title and heading of the repository index page |
280 | root-title=foobar.com git repositories | 280 | root-title=foobar.com git repositories |
281 | 281 | ||
282 | 282 | ||
283 | # Set a subheading for the repository index page | 283 | # Set a subheading for the repository index page |
284 | root-desc=tracking the foobar development | 284 | root-desc=tracking the foobar development |
285 | 285 | ||
286 | 286 | ||
287 | # Include some more info about foobar.com on the index page | 287 | # Include some more info about foobar.com on the index page |
288 | root-readme=/var/www/htdocs/about.html | 288 | root-readme=/var/www/htdocs/about.html |
289 | 289 | ||
290 | 290 | ||
291 | # Allow download of tar.gz, tar.bz and zip-files | 291 | # Allow download of tar.gz, tar.bz2 and zip-files |
292 | snapshots=tar.gz tar.bz zip | 292 | snapshots=tar.gz tar.bz2 zip |
293 | 293 | ||
294 | 294 | ||
295 | ## | 295 | ## |
296 | ## List of repositories. | 296 | ## List of repositories. |
297 | ## PS: Any repositories listed when repo.group is unset will not be | 297 | ## PS: Any repositories listed when repo.group is unset will not be |
298 | ## displayed under a group heading | 298 | ## displayed under a group heading |
299 | ## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos') | 299 | ## PPS: This list could be kept in a different file (e.g. '/etc/cgitrepos') |
300 | ## and included like this: | 300 | ## and included like this: |
301 | ## include=/etc/cgitrepos | 301 | ## include=/etc/cgitrepos |
302 | ## | 302 | ## |
303 | 303 | ||
304 | 304 | ||
305 | repo.url=foo | 305 | repo.url=foo |
306 | repo.path=/pub/git/foo.git | 306 | repo.path=/pub/git/foo.git |
307 | repo.desc=the master foo repository | 307 | repo.desc=the master foo repository |
308 | repo.owner=fooman@foobar.com | 308 | repo.owner=fooman@foobar.com |
309 | repo.readme=info/web/about.html | 309 | repo.readme=info/web/about.html |
310 | 310 | ||
311 | 311 | ||
312 | repo.url=bar | 312 | repo.url=bar |
313 | repo.path=/pub/git/bar.git | 313 | repo.path=/pub/git/bar.git |
314 | repo.desc=the bars for your foo | 314 | repo.desc=the bars for your foo |
315 | repo.owner=barman@foobar.com | 315 | repo.owner=barman@foobar.com |
316 | repo.readme=info/web/about.html | 316 | repo.readme=info/web/about.html |
317 | 317 | ||
318 | 318 | ||
319 | # The next repositories will be displayed under the 'extras' heading | 319 | # The next repositories will be displayed under the 'extras' heading |
320 | repo.group=extras | 320 | repo.group=extras |
321 | 321 | ||
322 | 322 | ||
323 | repo.url=baz | 323 | repo.url=baz |
324 | repo.path=/pub/git/baz.git | 324 | repo.path=/pub/git/baz.git |
325 | repo.desc=a set of extensions for bar users | 325 | repo.desc=a set of extensions for bar users |
326 | 326 | ||
327 | repo.url=wiz | 327 | repo.url=wiz |
328 | repo.path=/pub/git/wiz.git | 328 | repo.path=/pub/git/wiz.git |
329 | repo.desc=the wizard of foo | 329 | repo.desc=the wizard of foo |
330 | 330 | ||
331 | 331 | ||
332 | # Add some mirrored repositories | 332 | # Add some mirrored repositories |
333 | repo.group=mirrors | 333 | repo.group=mirrors |
334 | 334 | ||
335 | 335 | ||
336 | repo.url=git | 336 | repo.url=git |
337 | repo.path=/pub/git/git.git | 337 | repo.path=/pub/git/git.git |
338 | repo.desc=the dscm | 338 | repo.desc=the dscm |
339 | 339 | ||
340 | 340 | ||
341 | repo.url=linux | 341 | repo.url=linux |
342 | repo.path=/pub/git/linux.git | 342 | repo.path=/pub/git/linux.git |
343 | repo.desc=the kernel | 343 | repo.desc=the kernel |
344 | 344 | ||
345 | # Disable adhoc downloads of this repo | 345 | # Disable adhoc downloads of this repo |
346 | repo.snapshots=0 | 346 | repo.snapshots=0 |
347 | 347 | ||
348 | # Disable line-counts for this repo | 348 | # Disable line-counts for this repo |
349 | repo.enable-log-linecount=0 | 349 | repo.enable-log-linecount=0 |
350 | 350 | ||
351 | 351 | ||
352 | BUGS | 352 | BUGS |
353 | ---- | 353 | ---- |
354 | Comments currently cannot appear on the same line as a setting; the comment | 354 | Comments currently cannot appear on the same line as a setting; the comment |
355 | will be included as part of the value. E.g. this line: | 355 | will be included as part of the value. E.g. this line: |
356 | 356 | ||
357 | robots=index # allow indexing | 357 | robots=index # allow indexing |
358 | 358 | ||
359 | will generate the following html element: | 359 | will generate the following html element: |
360 | 360 | ||
361 | <meta name='robots' content='index # allow indexing'/> | 361 | <meta name='robots' content='index # allow indexing'/> |
362 | 362 | ||
363 | 363 | ||
364 | 364 | ||
365 | AUTHOR | 365 | AUTHOR |
366 | ------ | 366 | ------ |
367 | Lars Hjemli <hjemli@gmail.com> | 367 | Lars Hjemli <hjemli@gmail.com> |