repos / darcsweb / annotate_shade
summary | shortlog | log | tree | commit | commitdiff | headdiff | annotate | headblob | headfilediff | filehistory
normal | plain | shade | zebra
Add support for calling an external program to generate README markup
Annotate for file /config.py.sample
2005-07-01 albertogli 1
02:55:14 ' 2 # base configuration, common to all repos
' 3 class base:
' 4 # location of the darcs logo
' 5 darcslogo = "darcs.png"
' 6
' 7 # location of the darcs favicon
' 8 darcsfav = "minidarcs.png"
' 9
' 10 # the CSS file to use
' 11 cssfile = 'style.css'
' 12
2006-07-31 albertito 13 # this script's name, usually just "darcsweb.cgi" unless you rename
04:10:20 ' 14 # it; if you leave this commented it will be detected automatically
' 15 #myname = "darcsweb.cgi"
' 16
' 17 # our url, used only to generate RSS links, without the script name;
' 18 # if you leave this commented it will be detected automatically
' 19 #myurl = "http://example.com/darcsweb"
' 20
2005-08-23 albertogli 21 # optionally, you can specify the path to the darcs executable; if you
23:16:47 ' 22 # leave this commented, the one on $PATH will be used (this is
' 23 # normally what you want)
2005-08-24 remko.tronco 24 #darcspath = "/home/me/bin/"
2005-08-23 albertogli 25
2005-08-24 albertogli 26 # the text to appear in the top of repo list; this is also optional,
18:38:04 ' 27 # and html-formatted
' 28 #summary = "I love darcs!"
' 29
' 30 # in case you want to change the beautiful default, you can specify an
' 31 # alternative footer here; it's optional, of course
' 32 #footer = "I don't like shoes"
' 33
2005-11-17 albertogli 34 # It is possible to have a cache where darcsweb will store the pages
03:10:28 ' 35 # it generates; entries are automatically updated when the repository
' 36 # changes. This will speed things up significatively, specially for
' 37 # popular sites.
' 38 # It's recommended that you clean the directory with some regularity,
' 39 # to avoid having too many unused files. A simple rm will do just
' 40 # fine.
' 41 # If you leave the entry commented, no cache will be ever used;
' 42 # otherwise the directory is assumed to exist and be writeable.
2006-07-31 albertito 43 # If you use this option you must set the "myname" and "myurl"
04:10:20 ' 44 # variables.
2005-11-17 albertogli 45 #cachedir = '/tmp/darcsweb-cache'
2006-01-09 albertogli 46
05:24:26 ' 47 # By default, darcsweb's search looks in the last 100 commits; you can
' 48 # change that number by specifying it here.
' 49 # Note that search are not cached, so if you have tons of commits and
' 50 # set the limit to a very high number, they will take time.
' 51 #searchlimit = 100
2006-02-20 albertogli 52
03:23:19 ' 53 # If you want to log the times it took darcsweb to present a page,
' 54 # uncomment this option. The value should be a file writeable by
' 55 # darcsweb.
' 56 #logtimes = "/tmp/darcsweb_times"
2006-12-25 albertito 57
22:18:20 ' 58 # If you want darcsweb to automatically detect embedded URLs,
' 59 # define them here, using python-style regexps like the examples
' 60 # below. They will be replaced in summaries, logs, and commits.
' 61 # The following variables are replaced:
' 62 # myreponame: repository link (darcsweb.cgi?r=repo)
' 63 # reponame: repository name (repo)
' 64 #
' 65 #url_links = (
' 66 # Format is: (regexp, replacement)
' 67 # Some examples:
' 68 #
' 69 # Detect '#NNN' as a reference to bug database
' 70 #(r'#([0-9]+)',
' 71 # r'<a href="/bugs/show_bug.cgi?id=\1">#\1</a>'),
' 72 #
' 73 # Replace hashes with commit-links.
' 74 #(r'(\d{14}-[0-9a-f]{5}-[0-9a-f]{40}\.gz)',
' 75 # r'<a href="%(myreponame)s;a=commit;h=\1">\1</a>'),
' 76 #)
2007-02-01 vmiklos 77
17:30:50 ' 78 # If you want to generate links from patch author names, define the url
' 79 # here. Example for CIA:
' 80 #author_links = "http://cia.navi.cx/stats/author/%(author)s"
2007-03-16 vmiklos 81
19:27:14 ' 82 # If you want to disable the annotate feature (for performance reasons,
' 83 # the http connection will time out on slow machines), uncomment this
' 84 # option.
' 85 #disable_annotate = True
2007-02-01 vmiklos 86
2011-11-13 pix 87 # If you'd like a wider range of README file types than darcsweb
11:23:24 ' 88 # provides, set readme_converter to a program which takes a single
' 89 # argument--the name of the readme file--and outputs HTML.
' 90 #readme_converter = 'ruby -rubygems /var/lib/gems/1.8/gems/github-markup-0.5.3/bin/github-markup'
2005-11-17 albertogli 91
2005-07-01 albertogli 92
02:55:14 ' 93 #
' 94 # From now on, every class is a repo configuration, with the same format
' 95 # There are no restrictions on the class' name, except that it can't be named
2005-08-12 mark 96 # "base" (because it's the name of the one above).
2005-07-01 albertogli 97 #
2005-07-01 albertogli 98 # If you have a lot of repos and/or you're too lazy to do this by hand, you
04:36:53 ' 99 # can use the configuration generator that comes with darcsweb, called
' 100 # "mkconfig.py".
' 101 #
2005-07-01 albertogli 102
02:55:14 ' 103 class repo1:
' 104 # the descriptive name
' 105 reponame = 'repo1'
' 106
' 107 # a brief description
' 108 repodesc = 'Example repository'
' 109
' 110 # the real path to the repository
' 111 repodir = '/usr/src/repo1'
' 112
' 113 # an url so people know where to do "darcs get" from
2006-07-31 albertito 114 repourl = 'http://example.com/repos/repo1/'
2005-07-01 albertogli 115
02:55:14 ' 116 # the encoding used in the repo
' 117 # NOTE: if you use utf8, you _must_ write 'utf8' (and not the variants
' 118 # like 'utf-8' or 'UTF8') if you expect darcsweb to work properly.
' 119 # This is because to workaround a bug in darcs we need to do some
' 120 # codec mangling and it needs special cases for UTF8.
2006-02-24 albertogli 121 # You can, optionally, specify multiple encodings; they're tried in
00:31:28 ' 122 # order, and if one fails to decode a string, the next one is tried.
' 123 # Example: repoencoding = "utf8", "latin1"
2005-07-01 albertogli 124 repoencoding = "latin1"
2005-08-24 albertogli 125
18:38:04 ' 126 # as with the base configuration, the footer is also optional, and it
' 127 # affects only this repository; if you don't specify, the one
' 128 # specified in base is used (and if you don't specify one there
' 129 # either, a default one is used)
' 130 #footer = "I don't like being cold"
2005-07-01 albertogli 131
2006-07-31 albertito 132 # Each repository may show a link to some website associated with it.
04:54:05 ' 133 # This is typically useful if you've got a website describing the
' 134 # software in your repository.
' 135 #repoprojurl = 'http://example.com/projects/repo1/'
' 136
2005-07-01 albertogli 137
02:55:14 ' 138 class repo2:
' 139 reponame = 'repo2'
' 140 repodesc = 'Second example repository'
' 141 repodir = '/usr/src/repo2'
2006-07-31 albertito 142 repourl = 'http://example.com/repos/repo2/'
2005-07-01 albertogli 143 repoencoding = 'latin1'
02:55:14 ' 144
' 145
2005-11-09 albertogli 146 #
00:17:31 ' 147 # If you have several repositories in a single directory and don't want to
' 148 # create a configuration entry for each one, you can use a "multidir" entry,
' 149 # which serves as a "template" for all the repositories in that directory.
' 150 # The name is taken from the directory, and inside the variables the string
2008-03-27 albertito 151 # "%(name)s" gets expanded to the it. If displayname is set, "%(dname)s" gets
01:02:58 ' 152 # expanded to it; otherwise it's the same as "%(name)s".
2005-11-09 albertogli 153 #
2005-12-21 albertogli 154 # If you set multidir_deep to True (note the capitalization) then all
14:29:46 ' 155 # subdirectories are searched for darcs repositories. Subdirectories starting
' 156 # with a dot (.) are not searched. This may be slow, if huge directory trees
' 157 # must be searched. It's unnecesary unless you have a multidir with several
' 158 # nested repositories. It defaults to False, and it's optional.
2005-12-20 nils 159 #
2005-11-09 albertogli 160
00:17:31 ' 161 class multi1:
' 162 multidir = '/usr/local/src'
2005-12-21 albertogli 163 #multidir_deep = False
2005-11-09 albertogli 164 repodesc = 'Repository for %(name)s'
2006-07-31 albertito 165 repourl = 'http://example.com/repos/%(name)s/'
2005-11-09 albertogli 166 repoencoding = 'latin1'
00:17:31 ' 167
2008-03-27 albertito 168 # if you want to change the display name of the repositories (i.e. the
01:02:58 ' 169 # name it will have on the listings, urls, etc.), you can set it here.
' 170 # You can use "%(name)s" expansion, see above.
' 171 #displayname = "local/%(name)s"
' 172
2006-07-31 albertito 173 # optional, see above
04:54:05 ' 174 #repoprojurl = 'http://example.com/projects/%(name)s/'
' 175
2005-11-09 albertogli 176 # if you want to exclude some directories, add them to this list (note
23:59:47 ' 177 # they're relative to multidir, not absolute)
2005-11-10 luca 178 #exclude = 'dir1', 'dir2'
2005-12-30 albertogli 179
23:44:19 ' 180 # if you want the descriptions to be picked up automatically from the
' 181 # file named "_darcs/third_party/darcsweb/desc" (one line only), set
' 182 # this to True. It defaults to False
' 183 #autodesc = True
' 184
' 185 # if you want to exclude all the repositories which do NOT have a
' 186 # directory named "_darcs/third_party/darcsweb/" inside, set this to
' 187 # True. It defaults to False.
' 188 #autoexclude = True
2005-11-09 albertogli 189
2006-07-14 albertogli 190 # if you want urls to be picked up automatically from the file named
19:27:30 ' 191 # "_darcs/third_party/darcsweb/url" (one line only), set this to
' 192 # True. It defaults to False.
' 193 #autourl = True
2005-11-09 albertogli 194
2006-07-31 albertito 195 # if you want the projects urls to be picked up automatically from the
2007-04-04 alexandre.ro 196 # file named "_darcs/third_party/darcsweb/projurl" (one line only), set
2006-07-31 albertito 197 # this to True. It defaults to False.
04:54:05 ' 198 #autoprojurl = True
' 199
Sally sells sea-shells by the sea shore.