Merge branch 'asciidoc'
This commit is contained in:
Lars Hjemli
commit
942a4c2001
19
Makefile
19
Makefile
@ -100,7 +100,8 @@ ifdef NEEDS_LIBICONV
|
||||
endif
|
||||
|
||||
|
||||
.PHONY: all libgit test install uninstall clean force-version get-git
|
||||
.PHONY: all libgit test install uninstall clean force-version get-git \
|
||||
doc man-doc html-doc clean-doc
|
||||
|
||||
all: cgit
|
||||
|
||||
@ -149,8 +150,22 @@ uninstall:
|
||||
rm -f $(CGIT_DATA_PATH)/cgit.css
|
||||
rm -f $(CGIT_DATA_PATH)/cgit.png
|
||||
|
||||
clean:
|
||||
doc: man-doc html-doc pdf-doc
|
||||
|
||||
man-doc: cgitrc.5.txt
|
||||
a2x -f manpage cgitrc.5.txt
|
||||
|
||||
html-doc: cgitrc.5.txt
|
||||
a2x -f xhtml --stylesheet=cgit-doc.css cgitrc.5.txt
|
||||
|
||||
pdf-doc: cgitrc.5.txt
|
||||
a2x -f pdf cgitrc.5.txt
|
||||
|
||||
clean: clean-doc
|
||||
rm -f cgit VERSION *.o *.d
|
||||
|
||||
clean-doc:
|
||||
rm -f cgitrc.5 cgitrc.5.xhtml cgitrc.5.pdf
|
||||
|
||||
get-git:
|
||||
curl $(GIT_URL) | tar -xj && rm -rf git && mv git-$(GIT_VER) git
|
||||
|
||||
3
cgit-doc.css
Normal file
3
cgit-doc.css
Normal file
@ -0,0 +1,3 @@
|
||||
div.variablelist dt {
|
||||
margin-top: 1em;
|
||||
}
|
||||
114
cgitrc.5.txt
114
cgitrc.5.txt
@ -1,14 +1,14 @@
|
||||
CGITRC
|
||||
======
|
||||
CGITRC(5)
|
||||
========
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cgitrc - runtime configuration for cgit
|
||||
cgitrc - runtime configuration for cgit
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
SYNOPSIS
|
||||
--------
|
||||
Cgitrc contains all runtime settings for cgit, including the list of git
|
||||
repositories, formatted as a line-separated list of NAME=VALUE pairs. Blank
|
||||
lines, and lines starting with '#', are ignored.
|
||||
@ -16,166 +16,166 @@ lines, and lines starting with '#', are ignored.
|
||||
|
||||
GLOBAL SETTINGS
|
||||
---------------
|
||||
agefile
|
||||
agefile::
|
||||
Specifies a path, relative to each repository path, which can be used
|
||||
to specify the date and time of the youngest commit in the repository.
|
||||
The first line in the file is used as input to the "parse_date"
|
||||
function in libgit. Recommended timestamp-format is "yyyy-mm-dd
|
||||
hh:mm:ss". Default value: "info/web/last-modified".
|
||||
|
||||
cache-root
|
||||
cache-root::
|
||||
Path used to store the cgit cache entries. Default value:
|
||||
"/var/cache/cgit".
|
||||
|
||||
cache-dynamic-ttl
|
||||
cache-dynamic-ttl::
|
||||
Number which specifies the time-to-live, in minutes, for the cached
|
||||
version of repository pages accessed without a fixed SHA1. Default
|
||||
value: "5".
|
||||
|
||||
cache-repo-ttl
|
||||
cache-repo-ttl::
|
||||
Number which specifies the time-to-live, in minutes, for the cached
|
||||
version of the repository summary page. Default value: "5".
|
||||
|
||||
cache-root-ttl
|
||||
cache-root-ttl::
|
||||
Number which specifies the time-to-live, in minutes, for the cached
|
||||
version of the repository index page. Default value: "5".
|
||||
|
||||
cache-size
|
||||
cache-size::
|
||||
The maximum number of entries in the cgit cache. Default value: "0"
|
||||
(i.e. caching is disabled).
|
||||
|
||||
cache-static-ttl
|
||||
cache-static-ttl::
|
||||
Number which specifies the time-to-live, in minutes, for the cached
|
||||
version of repository pages accessed with a fixed SHA1. Default value:
|
||||
"5".
|
||||
|
||||
clone-prefix
|
||||
clone-prefix::
|
||||
Space-separated list of common prefixes which, when combined with a
|
||||
repository url, generates valid clone urls for the repository. This
|
||||
setting is only used if `repo.clone-url` is unspecified. Default value:
|
||||
none.
|
||||
|
||||
css
|
||||
css::
|
||||
Url which specifies the css document to include in all cgit pages.
|
||||
Default value: "/cgit.css".
|
||||
|
||||
enable-index-links
|
||||
enable-index-links::
|
||||
Flag which, when set to "1", will make cgit generate extra links for
|
||||
each repo in the repository index (specifically, to the "summary",
|
||||
"commit" and "tree" pages). Default value: "0".
|
||||
|
||||
enable-log-filecount
|
||||
enable-log-filecount::
|
||||
Flag which, when set to "1", will make cgit print the number of
|
||||
modified files for each commit on the repository log page. Default
|
||||
value: "0".
|
||||
|
||||
enable-log-linecount
|
||||
enable-log-linecount::
|
||||
Flag which, when set to "1", will make cgit print the number of added
|
||||
and removed lines for each commit on the repository log page. Default
|
||||
value: "0".
|
||||
|
||||
favicon
|
||||
favicon::
|
||||
Url used as link to a shortcut icon for cgit. If specified, it is
|
||||
suggested to use the value "/favicon.ico" since certain browsers will
|
||||
ignore other values. Default value: none.
|
||||
|
||||
footer
|
||||
footer::
|
||||
The content of the file specified with this option will be included
|
||||
verbatim at the bottom of all pages (i.e. it replaces the standard
|
||||
"generated by..." message. Default value: none.
|
||||
|
||||
header
|
||||
header::
|
||||
The content of the file specified with this option will be included
|
||||
verbatim at the top of all pages. Default value: none.
|
||||
|
||||
include
|
||||
include::
|
||||
Name of a configfile to include before the rest of the current config-
|
||||
file is parsed. Default value: none.
|
||||
|
||||
index-header
|
||||
index-header::
|
||||
The content of the file specified with this option will be included
|
||||
verbatim above the repository index. This setting is deprecated, and
|
||||
will not be supported by cgit-1.0 (use root-readme instead). Default
|
||||
value: none.
|
||||
|
||||
index-info
|
||||
index-info::
|
||||
The content of the file specified with this option will be included
|
||||
verbatim below the heading on the repository index page. This setting
|
||||
is deprecated, and will not be supported by cgit-1.0 (use root-desc
|
||||
instead). Default value: none.
|
||||
|
||||
local-time
|
||||
local-time::
|
||||
Flag which, if set to "1", makes cgit print commit and tag times in the
|
||||
servers timezone. Default value: "0".
|
||||
|
||||
logo
|
||||
logo::
|
||||
Url which specifies the source of an image which will be used as a logo
|
||||
on all cgit pages.
|
||||
|
||||
logo-link
|
||||
logo-link::
|
||||
Url loaded when clicking on the cgit logo image. If unspecified the
|
||||
calculated url of the repository index page will be used. Default
|
||||
value: none.
|
||||
|
||||
max-commit-count
|
||||
max-commit-count::
|
||||
Specifies the number of entries to list per page in "log" view. Default
|
||||
value: "50".
|
||||
|
||||
max-message-length
|
||||
max-message-length::
|
||||
Specifies the maximum number of commit message characters to display in
|
||||
"log" view. Default value: "80".
|
||||
|
||||
max-repo-count
|
||||
max-repo-count::
|
||||
Specifies the number of entries to list per page on the repository
|
||||
index page. Default value: "50".
|
||||
|
||||
max-repodesc-length
|
||||
max-repodesc-length::
|
||||
Specifies the maximum number of repo description characters to display
|
||||
on the repository index page. Default value: "80".
|
||||
|
||||
max-stats
|
||||
max-stats::
|
||||
Set the default maximum statistics period. Valid values are "week",
|
||||
"month", "quarter" and "year". If unspecified, statistics are
|
||||
disabled. Default value: none. See also: "repo.max-stats".
|
||||
|
||||
module-link
|
||||
module-link::
|
||||
Text which will be used as the formatstring for a hyperlink when a
|
||||
submodule is printed in a directory listing. The arguments for the
|
||||
formatstring are the path and SHA1 of the submodule commit. Default
|
||||
value: "./?repo=%s&page=commit&id=%s"
|
||||
|
||||
nocache
|
||||
nocache::
|
||||
If set to the value "1" caching will be disabled. This settings is
|
||||
deprecated, and will not be honored starting with cgit-1.0. Default
|
||||
value: "0".
|
||||
|
||||
renamelimit
|
||||
renamelimit::
|
||||
Maximum number of files to consider when detecting renames. The value
|
||||
"-1" uses the compiletime value in git (for further info, look at
|
||||
`man git-diff`). Default value: "-1".
|
||||
|
||||
repo.group
|
||||
repo.group::
|
||||
A value for the current repository group, which all repositories
|
||||
specified after this setting will inherit. Default value: none.
|
||||
|
||||
robots
|
||||
robots::
|
||||
Text used as content for the "robots" meta-tag. Default value:
|
||||
"index, nofollow".
|
||||
|
||||
root-desc
|
||||
root-desc::
|
||||
Text printed below the heading on the repository index page. Default
|
||||
value: "a fast webinterface for the git dscm".
|
||||
|
||||
root-readme:
|
||||
root-readme::
|
||||
The content of the file specified with this option will be included
|
||||
verbatim below the "about" link on the repository index page. Default
|
||||
value: none.
|
||||
|
||||
root-title
|
||||
root-title::
|
||||
Text printed as heading on the repository index page. Default value:
|
||||
"Git Repository Browser".
|
||||
|
||||
snapshots
|
||||
snapshots::
|
||||
Text which specifies the default (and allowed) set of snapshot formats
|
||||
supported by cgit. The value is a space-separated list of zero or more
|
||||
of the following values:
|
||||
@ -185,19 +185,19 @@ snapshots
|
||||
"zip" zip-file
|
||||
Default value: none.
|
||||
|
||||
summary-branches
|
||||
summary-branches::
|
||||
Specifies the number of branches to display in the repository "summary"
|
||||
view. Default value: "10".
|
||||
|
||||
summary-log
|
||||
summary-log::
|
||||
Specifies the number of log entries to display in the repository
|
||||
"summary" view. Default value: "10".
|
||||
|
||||
summary-tags
|
||||
summary-tags::
|
||||
Specifies the number of tags to display in the repository "summary"
|
||||
view. Default value: "10".
|
||||
|
||||
virtual-root
|
||||
virtual-root::
|
||||
Url which, if specified, will be used as root for all cgit links. It
|
||||
will also cause cgit to generate 'virtual urls', i.e. urls like
|
||||
'/cgit/tree/README' as opposed to '?r=cgit&p=tree&path=README'. Default
|
||||
@ -207,51 +207,51 @@ virtual-root
|
||||
|
||||
REPOSITORY SETTINGS
|
||||
-------------------
|
||||
repo.clone-url
|
||||
repo.clone-url::
|
||||
A list of space-separated urls which can be used to clone this repo.
|
||||
Default value: none.
|
||||
|
||||
repo.defbranch
|
||||
repo.defbranch::
|
||||
The name of the default branch for this repository. If no such branch
|
||||
exists in the repository, the first branch name (when sorted) is used
|
||||
as default instead. Default value: "master".
|
||||
|
||||
repo.desc
|
||||
repo.desc::
|
||||
The value to show as repository description. Default value: none.
|
||||
|
||||
repo.enable-log-filecount
|
||||
repo.enable-log-filecount::
|
||||
A flag which can be used to disable the global setting
|
||||
`enable-log-filecount'. Default value: none.
|
||||
|
||||
repo.enable-log-linecount
|
||||
repo.enable-log-linecount::
|
||||
A flag which can be used to disable the global setting
|
||||
`enable-log-linecount'. Default value: none.
|
||||
|
||||
repo.max-stats
|
||||
repo.max-stats::
|
||||
Override the default maximum statistics period. Valid values are equal
|
||||
to the values specified for the global "max-stats" setting. Default
|
||||
value: none.
|
||||
|
||||
repo.name
|
||||
repo.name::
|
||||
The value to show as repository name. Default value: <repo.url>.
|
||||
|
||||
repo.owner
|
||||
repo.owner::
|
||||
A value used to identify the owner of the repository. Default value:
|
||||
none.
|
||||
|
||||
repo.path
|
||||
repo.path::
|
||||
An absolute path to the repository directory. For non-bare repositories
|
||||
this is the .git-directory. Default value: none.
|
||||
|
||||
repo.readme
|
||||
repo.readme::
|
||||
A path (relative to <repo.path>) which specifies a file to include
|
||||
verbatim as the "About" page for this repo. Default value: none.
|
||||
|
||||
repo.snapshots
|
||||
repo.snapshots::
|
||||
A mask of allowed snapshot-formats for this repo, restricted by the
|
||||
"snapshots" global setting. Default value: <snapshots>.
|
||||
|
||||
repo.url
|
||||
repo.url::
|
||||
The relative url used to access the repository. This must be the first
|
||||
setting specified for each repo. Default value: none.
|
||||
|
||||
@ -259,6 +259,7 @@ repo.url
|
||||
EXAMPLE CGITRC FILE
|
||||
-------------------
|
||||
|
||||
....
|
||||
# Enable caching of up to 1000 output entriess
|
||||
cache-size=1000
|
||||
|
||||
@ -368,6 +369,7 @@ repo.enable-log-linecount=0
|
||||
|
||||
# Restrict the max statistics period for this repo
|
||||
repo.max-stats=month
|
||||
....
|
||||
|
||||
|
||||
BUGS
|
||||
|
||||
Loading…
Reference in New Issue
Block a user