[PATCH 09 of 14] docs/usage: generalize 'git support' into 'version control systems support'

Thomas De Schampheleire patrickdepinguin at gmail.com
Mon Apr 6 15:12:03 EDT 2015


# HG changeset patch
# User Thomas De Schampheleire <thomas.de.schampheleire at gmail.com>
# Date 1428259581 -7200
#      Sun Apr 05 20:46:21 2015 +0200
# Node ID 1541ad7e1155e512fd76d8e9d7e2446631516656
# Parent  d6b23368931dae41b70d16fe577a3e75b90b8fd0
docs/usage: generalize 'git support' into 'version control systems support'

Rename and rework the 'git support' page such that it can hold information
about Mercurial as well.

diff --git a/docs/index.rst b/docs/index.rst
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -27,7 +27,7 @@
    :maxdepth: 1
 
    usage/general
-   usage/git_support
+   usage/vcs_support
    usage/performance
    usage/locking
    usage/statistics
diff --git a/docs/usage/git_support.rst b/docs/usage/vcs_support.rst
rename from docs/usage/git_support.rst
rename to docs/usage/vcs_support.rst
--- a/docs/usage/git_support.rst
+++ b/docs/usage/vcs_support.rst
@@ -1,19 +1,30 @@
-.. _git_support:
+.. _vcs_support:
 
-===========
+===============================
+Version control systems support
+===============================
+
+Kallithea supports Git and Mercurial repositories out-of-the-box.
+For Git, you do need the ``git`` command line client installed on the server.
+
+You can always disable Git or Mercurial support by editing the
+file ``kallithea/__init__.py`` and commenting out the backend.
+
+.. code-block:: python
+
+   BACKENDS = {
+       'hg': 'Mercurial repository',
+       #'git': 'Git repository',
+   }
+
 Git support
-===========
-
-
-Kallithea Git support is enabled by default. You just need a Git
-command line client installed on the server to make Git work fully.
+-----------
 
 Web server with chunked encoding
---------------------------------
-
-Large Git pushes requires a http server with support for
+````````````````````````````````
+Large Git pushes require an HTTP server with support for
 chunked encoding for POST. The Python web servers waitress_ and
-gunicorn_ (linux only) can be used. By default, Kallithea uses
+gunicorn_ (Linux only) can be used. By default, Kallithea uses
 waitress_ for `paster serve` instead of the built-in `paste` WSGI
 server.
 
@@ -33,18 +44,6 @@
     use_threadpool =
 
 
-Disabling Git
--------------
-
-You can always disable Git or Mercurial support by editing the
-file ``kallithea/__init__.py`` and commenting out the backend.
-
-.. code-block:: python
-
-   BACKENDS = {
-       'hg': 'Mercurial repository',
-       #'git': 'Git repository',
-   }
 
 .. _waitress: http://pypi.python.org/pypi/waitress
 .. _gunicorn: http://pypi.python.org/pypi/gunicorn


More information about the kallithea-general mailing list