Files
@ 9376ca7157f3
Branch filter:
Location: kallithea/docs/usage/vcs_support.rst - annotation
9376ca7157f3
2.2 KiB
text/prs.fallenstein.rst
compare: correct display of special branch names in initial placeholder
When a branch name contains special characters like '<' or '>', and a
'compare' operation is performed with such branch as one of the two compare
sides, then the special branch name will be part of the URL, e.g.
http://localhost:5000/myrepo/compare/branch@master...branch@%3Cscript%3Eblabla%3C/script%3E?other_repo=myrepo
The encoded branch name is then used at page load as placeholders for the
branch selection dropdowns. But, the special characters, were escaped too
much, causing '<' to become < in the display of the dropdown.
The placeholder was escaped via the default mako escape filter, before being
passed to make_revision_dropdown, thus too early. We want the raw value.
h.js() (copied from the default branch) gives us that, while still
formatting and escaping the string so it is safe inside the script tag.
When a branch name contains special characters like '<' or '>', and a
'compare' operation is performed with such branch as one of the two compare
sides, then the special branch name will be part of the URL, e.g.
http://localhost:5000/myrepo/compare/branch@master...branch@%3Cscript%3Eblabla%3C/script%3E?other_repo=myrepo
The encoded branch name is then used at page load as placeholders for the
branch selection dropdowns. But, the special characters, were escaped too
much, causing '<' to become < in the display of the dropdown.
The placeholder was escaped via the default mako escape filter, before being
passed to make_revision_dropdown, thus too early. We want the raw value.
h.js() (copied from the default branch) gives us that, while still
formatting and escaping the string so it is safe inside the script tag.
601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 fbbe80e3322b 601282d36c06 601282d36c06 601282d36c06 fbbe80e3322b 601282d36c06 601282d36c06 fbbe80e3322b 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 36a35394b3cb 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 601282d36c06 9cef5a168b88 9cef5a168b88 9cef5a168b88 fbbe80e3322b 9cef5a168b88 9cef5a168b88 fbbe80e3322b b52a1ccee927 b52a1ccee927 b52a1ccee927 9cef5a168b88 9cef5a168b88 b52a1ccee927 b52a1ccee927 b52a1ccee927 b52a1ccee927 b52a1ccee927 9cef5a168b88 b52a1ccee927 9cef5a168b88 9cef5a168b88 b52a1ccee927 9cef5a168b88 9cef5a168b88 9cef5a168b88 9cef5a168b88 b52a1ccee927 b52a1ccee927 b52a1ccee927 9cef5a168b88 b52a1ccee927 9cef5a168b88 b52a1ccee927 b52a1ccee927 601282d36c06 fbbe80e3322b 601282d36c06 601282d36c06 b52a1ccee927 | .. _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/
|