Merge branch 'asciidoc'

3 files changed, 78 insertions, 58 deletions

diff --git a/Makefile b/Makefile
index 0f0089a..056d516 100644
--- a/Makefile
+++ b/Makefile
@@ -102,3 +102,4 @@ 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
 
@@ -151,5 +152,19 @@ uninstall:
 
-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:
diff --git a/cgit-doc.css b/cgit-doc.css
new file mode 100644
index 0000000..5a399b6
--- a/dev/null
+++ b/cgit-doc.css
@@ -0,0 +1,3 @@
+div.variablelist dt {
+        margin-top: 1em;
+}
diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index fd299ae..7879f75 100644
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -1,3 +1,3 @@
-CGITRC
-======
+CGITRC(5)
+========
 
@@ -6,7 +6,7 @@ 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
@@ -18,3 +18,3 @@ GLOBAL SETTINGS
 ---------------
-agefile
+agefile::
         Specifies a path, relative to each repository path, which can be used
@@ -25,3 +25,3 @@ agefile
 
-cache-root
+cache-root::
         Path used to store the cgit cache entries. Default value:
@@ -29,3 +29,3 @@ cache-root
 
-cache-dynamic-ttl
+cache-dynamic-ttl::
         Number which specifies the time-to-live, in minutes, for the cached
@@ -34,3 +34,3 @@ cache-dynamic-ttl
 
-cache-repo-ttl
+cache-repo-ttl::
         Number which specifies the time-to-live, in minutes, for the cached
@@ -38,3 +38,3 @@ cache-repo-ttl
 
-cache-root-ttl
+cache-root-ttl::
         Number which specifies the time-to-live, in minutes, for the cached
@@ -42,3 +42,3 @@ cache-root-ttl
 
-cache-size
+cache-size::
         The maximum number of entries in the cgit cache. Default value: "0"
@@ -46,3 +46,3 @@ cache-size
 
-cache-static-ttl
+cache-static-ttl::
         Number which specifies the time-to-live, in minutes, for the cached
@@ -51,3 +51,3 @@ cache-static-ttl
 
-clone-prefix
+clone-prefix::
         Space-separated list of common prefixes which, when combined with a
@@ -57,3 +57,3 @@ clone-prefix
 
-css
+css::
         Url which specifies the css document to include in all cgit pages.
@@ -61,3 +61,3 @@ css
 
-enable-index-links
+enable-index-links::
         Flag which, when set to "1", will make cgit generate extra links for
@@ -66,3 +66,3 @@ enable-index-links
 
-enable-log-filecount
+enable-log-filecount::
         Flag which, when set to "1", will make cgit print the number of
@@ -71,3 +71,3 @@ enable-log-filecount
 
-enable-log-linecount
+enable-log-linecount::
         Flag which, when set to "1", will make cgit print the number of added
@@ -76,3 +76,3 @@ enable-log-linecount
 
-favicon
+favicon::
         Url used as link to a shortcut icon for cgit. If specified, it is
@@ -81,3 +81,3 @@ favicon
 
-footer
+footer::
         The content of the file specified with this option will be included
@@ -86,3 +86,3 @@ footer
 
-header
+header::
         The content of the file specified with this option will be included
@@ -90,3 +90,3 @@ header
 
-include
+include::
         Name of a configfile to include before the rest of the current config-
@@ -94,3 +94,3 @@ include
 
-index-header
+index-header::
         The content of the file specified with this option will be included
@@ -100,3 +100,3 @@ index-header
 
-index-info
+index-info::
         The content of the file specified with this option will be included
@@ -106,3 +106,3 @@ index-info
 
-local-time
+local-time::
         Flag which, if set to "1", makes cgit print commit and tag times in the
@@ -110,3 +110,3 @@ local-time
 
-logo
+logo::
         Url which specifies the source of an image which will be used as a logo
@@ -114,3 +114,3 @@ logo
 
-logo-link
+logo-link::
         Url loaded when clicking on the cgit logo image. If unspecified the
@@ -119,3 +119,3 @@ logo-link
 
-max-commit-count
+max-commit-count::
         Specifies the number of entries to list per page in "log" view. Default
@@ -123,3 +123,3 @@ max-commit-count
 
-max-message-length
+max-message-length::
         Specifies the maximum number of commit message characters to display in
@@ -127,3 +127,3 @@ max-message-length
 
-max-repo-count
+max-repo-count::
                 Specifies the number of entries to list per page on therepository
@@ -131,3 +131,3 @@ max-repo-count
 
-max-repodesc-length
+max-repodesc-length::
         Specifies the maximum number of repo description characters to display
@@ -135,3 +135,3 @@ max-repodesc-length
 
-max-stats
+max-stats::
         Set the default maximum statistics period. Valid values are "week",
@@ -140,3 +140,3 @@ max-stats
 
-module-link
+module-link::
         Text which will be used as the formatstring for a hyperlink when a
@@ -146,3 +146,3 @@ module-link
 
-nocache
+nocache::
         If set to the value "1" caching will be disabled. This settings is
@@ -151,3 +151,3 @@ nocache
 
-renamelimit
+renamelimit::
         Maximum number of files to consider when detecting renames. The value
@@ -156,3 +156,3 @@ renamelimit
 
-repo.group
+repo.group::
         A value for the current repository group, which all repositories
@@ -160,3 +160,3 @@ repo.group
 
-robots
+robots::
         Text used as content for the "robots" meta-tag. Default value:
@@ -164,3 +164,3 @@ robots
 
-root-desc
+root-desc::
         Text printed below the heading on the repository index page. Default
@@ -168,3 +168,3 @@ root-desc
 
-root-readme:
+root-readme::
         The content of the file specified with this option will be included
@@ -173,3 +173,3 @@ root-readme:
 
-root-title
+root-title::
         Text printed as heading on the repository index page. Default value:
@@ -177,3 +177,3 @@ root-title
 
-snapshots
+snapshots::
         Text which specifies the default (and allowed) set of snapshot formats
@@ -187,3 +187,3 @@ snapshots
 
-summary-branches
+summary-branches::
         Specifies the number of branches to display in the repository "summary"
@@ -191,3 +191,3 @@ summary-branches
 
-summary-log
+summary-log::
         Specifies the number of log entries to display in the repository
@@ -195,3 +195,3 @@ summary-log
 
-summary-tags
+summary-tags::
         Specifies the number of tags to display in the repository "summary"
@@ -199,3 +199,3 @@ summary-tags
 
-virtual-root
+virtual-root::
         Url which, if specified, will be used as root for all cgit links. It
@@ -209,3 +209,3 @@ REPOSITORY SETTINGS
 -------------------
-repo.clone-url
+repo.clone-url::
         A list of space-separated urls which can be used to clone this repo.
@@ -213,3 +213,3 @@ repo.clone-url
 
-repo.defbranch
+repo.defbranch::
         The name of the default branch for this repository. If no such branch
@@ -218,6 +218,6 @@ repo.defbranch
 
-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
@@ -225,3 +225,3 @@ repo.enable-log-filecount
 
-repo.enable-log-linecount
+repo.enable-log-linecount::
         A flag which can be used to disable the global setting
@@ -229,3 +229,3 @@ repo.enable-log-linecount
 
-repo.max-stats
+repo.max-stats::
         Override the default maximum statistics period. Valid values are equal
@@ -234,6 +234,6 @@ repo.max-stats
 
-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:
@@ -241,3 +241,3 @@ repo.owner
 
-repo.path
+repo.path::
         An absolute path to the repository directory. For non-bare repositories
@@ -245,3 +245,3 @@ repo.path
 
-repo.readme
+repo.readme::
         A path (relative to <repo.path>) which specifies a file to include
@@ -249,3 +249,3 @@ repo.readme
 
-repo.snapshots
+repo.snapshots::
         A mask of allowed snapshot-formats for this repo, restricted by the
@@ -253,3 +253,3 @@ repo.snapshots
 
-repo.url
+repo.url::
         The relative url used to access the repository. This must be the first
@@ -261,2 +261,3 @@ EXAMPLE CGITRC FILE
 
+....
 # Enable caching of up to 1000 output entriess
@@ -370,2 +371,3 @@ repo.enable-log-linecount=0
 repo.max-stats=month
+....