kallithea Files · docs/usage/vcs

Files @ d06c0566cb23

Branch filter:

Location: kallithea/docs/usage/vcs_support.rst

d06c0566cb23 2.2 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

Thomas De Schampheleire

make-release: import version and copyright updates from default branch (dba4e770d4b6)

make-release has been improved on the default branch in commit dba4e770d4b6,
and that version of the script also almost works on stable.

There are some parts we don't have in stable branch: dev_requirements.txt,
run-all-cleanup, and a working dist file content check:

The MANIFEST.in file on the stable branch is not complete.
Most of the missing entries could simply be added
(.travis.yml, requirements.txt, tox.ini, and scripts/*) but there is one
problematic entry: kallithea/i18n/en/LC_MESSAGES/kallithea.mo.
In the check command, all .mo entries are filtered out, causing a remaining
diff for the English .mo.

As that file has been removed on the default branch already, and the missing
entries are not important for the release anyway, simply drop the check
for now.

.. _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
-----------


Web server with chunked encoding
````````````````````````````````

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
waitress_ for `paster serve` instead of the built-in `paste` WSGI
server.

The paster server is controlled in the .ini file::

    use = egg:waitress#main

or::

    use = egg:gunicorn#main

Also make sure to comment out the following options::

    threadpool_workers =
    threadpool_max_requests =
    use_threadpool =


Mercurial support
-----------------


Working with Mercurial subrepositories
``````````````````````````````````````

This section explains how to use Mercurial subrepositories_ in Kallithea.

Example usage::

    ## init a simple repo
    hg init mainrepo
    cd mainrepo
    echo "file" > file
    hg add file
    hg ci --message "initial file"

    # clone subrepo we want to add from Kallithea
    hg clone http://kallithea.local/subrepo

    ## specify URL to existing repo in Kallithea as subrepository path
    echo "subrepo = http://kallithea.local/subrepo" > .hgsub
    hg add .hgsub
    hg ci --message "added remote subrepo"

In the file list of a clone of ``mainrepo`` you will see a connected
subrepository at the revision it was cloned with. Clicking on the
subrepository link sends you to the proper repository in Kallithea.

Cloning ``mainrepo`` will also clone the attached subrepository.

Next we can edit the subrepository data, and push back to Kallithea. This will
update both repositories.


.. _waitress: http://pypi.python.org/pypi/waitress
.. _gunicorn: http://pypi.python.org/pypi/gunicorn
.. _subrepositories: http://mercurial.aragost.com/kick-start/en/subrepositories/