Mercurial > kallithea

annotate docs/usage/vcs_support.rst @ 5413:22a3fa3c4254

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: cleanup of casing, markup and spacing of headings Mostly stuff found and fixed by Søren, extracted here to separate things. Other uses of title casing might be debatable, but here it was just a few documentation headings that clearly were inconsistent with the majority.
author Mads Kiilerich <madski@unity3d.com>
date Thu, 20 Aug 2015 03:26:18 +0200
parents b52a1ccee927
children 36a35394b3cb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4970
601282d36c06 docs/usage: generalize 'git support' into 'version control systems support'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
1 .. _vcs_support:
601282d36c06 docs/usage: generalize 'git support' into 'version control systems support'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
2
601282d36c06 docs/usage: generalize 'git support' into 'version control systems support'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
3 ===============================
601282d36c06 docs/usage: generalize 'git support' into 'version control systems support'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
4 Version control systems support
601282d36c06 docs/usage: generalize 'git support' into 'version control systems support'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
5 ===============================
601282d36c06 docs/usage: generalize 'git support' into 'version control systems support'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
6
601282d36c06 docs/usage: generalize 'git support' into 'version control systems support'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
7 Kallithea supports Git and Mercurial repositories out-of-the-box.
601282d36c06 docs/usage: generalize 'git support' into 'version control systems support'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
8 For Git, you do need the ``git`` command line client installed on the server.
811
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
9
4970
601282d36c06 docs/usage: generalize 'git support' into 'version control systems support'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
10 You can always disable Git or Mercurial support by editing the
601282d36c06 docs/usage: generalize 'git support' into 'version control systems support'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
11 file ``kallithea/__init__.py`` and commenting out the backend.
601282d36c06 docs/usage: generalize 'git support' into 'version control systems support'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
12
601282d36c06 docs/usage: generalize 'git support' into 'version control systems support'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
13 .. code-block:: python
601282d36c06 docs/usage: generalize 'git support' into 'version control systems support'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
14
601282d36c06 docs/usage: generalize 'git support' into 'version control systems support'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
15 BACKENDS = {
601282d36c06 docs/usage: generalize 'git support' into 'version control systems support'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
16 'hg': 'Mercurial repository',
601282d36c06 docs/usage: generalize 'git support' into 'version control systems support'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
17 #'git': 'Git repository',
601282d36c06 docs/usage: generalize 'git support' into 'version control systems support'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
18 }
601282d36c06 docs/usage: generalize 'git support' into 'version control systems support'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
19
4937
326a9336fbe5 spelling: use correct Git capitalisation where appropriate
Andrew Shadura <andrew@shadura.me>
parents: 4902
diff changeset
20 Git support
4970
601282d36c06 docs/usage: generalize 'git support' into 'version control systems support'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
21 -----------
2325
18d34a56a736 fix for issue #417, git execution was broken on windows for certain commands.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
22
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4192
diff changeset
23 Web server with chunked encoding
4970
601282d36c06 docs/usage: generalize 'git support' into 'version control systems support'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
24 ````````````````````````````````
601282d36c06 docs/usage: generalize 'git support' into 'version control systems support'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
25 Large Git pushes require an HTTP server with support for
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4937
diff changeset
26 chunked encoding for POST. The Python web servers waitress_ and
4970
601282d36c06 docs/usage: generalize 'git support' into 'version control systems support'
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4955
diff changeset
27 gunicorn_ (Linux only) can be used. By default, Kallithea uses
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4937
diff changeset
28 waitress_ for `paster serve` instead of the built-in `paste` WSGI
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4937
diff changeset
29 server.
2023
c45fb78969a3 docs updates on git support
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
30
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4192
diff changeset
31 The default paste server is controlled in the .ini file::
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2992
diff changeset
32
2023
c45fb78969a3 docs updates on git support
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
33 use = egg:waitress#main
c45fb78969a3 docs updates on git support
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
34
2325
18d34a56a736 fix for issue #417, git execution was broken on windows for certain commands.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
35 or::
18d34a56a736 fix for issue #417, git execution was broken on windows for certain commands.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
36
18d34a56a736 fix for issue #417, git execution was broken on windows for certain commands.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
37 use = egg:gunicorn#main
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2992
diff changeset
38
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2992
diff changeset
39
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4192
diff changeset
40 Also make sure to comment out the following options::
2023
c45fb78969a3 docs updates on git support
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
41
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2992
diff changeset
42 threadpool_workers =
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2992
diff changeset
43 threadpool_max_requests =
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2992
diff changeset
44 use_threadpool =
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2992
diff changeset
45
2024
370e995e46c2 fixes in doc about waitress wsgi
Marcin Kuzminski <marcin@python-works.com>
parents: 2023
diff changeset
46
4971
9cef5a168b88 docs/usage: move Mercurial subrepository info to VCS support page
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4970
diff changeset
47 Mercurial support
9cef5a168b88 docs/usage: move Mercurial subrepository info to VCS support page
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4970
diff changeset
48 -----------------
9cef5a168b88 docs/usage: move Mercurial subrepository info to VCS support page
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4970
diff changeset
49
9cef5a168b88 docs/usage: move Mercurial subrepository info to VCS support page
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4970
diff changeset
50 Working with Mercurial subrepositories
9cef5a168b88 docs/usage: move Mercurial subrepository info to VCS support page
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4970
diff changeset
51 ``````````````````````````````````````
4972
b52a1ccee927 docs/usage: reword information on Mercurial subrepository support
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4971
diff changeset
52 This section explains how to use Mercurial subrepositories_ in Kallithea.
b52a1ccee927 docs/usage: reword information on Mercurial subrepository support
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4971
diff changeset
53
b52a1ccee927 docs/usage: reword information on Mercurial subrepository support
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4971
diff changeset
54 Example usage::
4971
9cef5a168b88 docs/usage: move Mercurial subrepository info to VCS support page
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4970
diff changeset
55
9cef5a168b88 docs/usage: move Mercurial subrepository info to VCS support page
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4970
diff changeset
56 ## init a simple repo
4972
b52a1ccee927 docs/usage: reword information on Mercurial subrepository support
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4971
diff changeset
57 hg init mainrepo
b52a1ccee927 docs/usage: reword information on Mercurial subrepository support
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4971
diff changeset
58 cd mainrepo
b52a1ccee927 docs/usage: reword information on Mercurial subrepository support
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4971
diff changeset
59 echo "file" > file
b52a1ccee927 docs/usage: reword information on Mercurial subrepository support
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4971
diff changeset
60 hg add file
b52a1ccee927 docs/usage: reword information on Mercurial subrepository support
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4971
diff changeset
61 hg ci --message "initial file"
4971
9cef5a168b88 docs/usage: move Mercurial subrepository info to VCS support page
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4970
diff changeset
62
4972
b52a1ccee927 docs/usage: reword information on Mercurial subrepository support
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4971
diff changeset
63 # clone subrepo we want to add from Kallithea
4971
9cef5a168b88 docs/usage: move Mercurial subrepository info to VCS support page
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4970
diff changeset
64 hg clone http://kallithea.local/subrepo
9cef5a168b88 docs/usage: move Mercurial subrepository info to VCS support page
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4970
diff changeset
65
4972
b52a1ccee927 docs/usage: reword information on Mercurial subrepository support
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4971
diff changeset
66 ## specify URL to existing repo in Kallithea as subrepository path
4971
9cef5a168b88 docs/usage: move Mercurial subrepository info to VCS support page
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4970
diff changeset
67 echo "subrepo = http://kallithea.local/subrepo" > .hgsub
9cef5a168b88 docs/usage: move Mercurial subrepository info to VCS support page
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4970
diff changeset
68 hg add .hgsub
9cef5a168b88 docs/usage: move Mercurial subrepository info to VCS support page
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4970
diff changeset
69 hg ci --message "added remote subrepo"
9cef5a168b88 docs/usage: move Mercurial subrepository info to VCS support page
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4970
diff changeset
70
4972
b52a1ccee927 docs/usage: reword information on Mercurial subrepository support
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4971
diff changeset
71 In the file list of a clone of ``mainrepo`` you will see a connected
b52a1ccee927 docs/usage: reword information on Mercurial subrepository support
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4971
diff changeset
72 subrepository at the revision it was cloned with. Clicking on the
b52a1ccee927 docs/usage: reword information on Mercurial subrepository support
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4971
diff changeset
73 subrepository link sends you to the proper repository in Kallithea.
4971
9cef5a168b88 docs/usage: move Mercurial subrepository info to VCS support page
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4970
diff changeset
74
4972
b52a1ccee927 docs/usage: reword information on Mercurial subrepository support
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4971
diff changeset
75 Cloning ``mainrepo`` will also clone the attached subrepository.
4971
9cef5a168b88 docs/usage: move Mercurial subrepository info to VCS support page
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4970
diff changeset
76
4972
b52a1ccee927 docs/usage: reword information on Mercurial subrepository support
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4971
diff changeset
77 Next we can edit the subrepository data, and push back to Kallithea. This will
b52a1ccee927 docs/usage: reword information on Mercurial subrepository support
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4971
diff changeset
78 update both repositories.
811
bb35ad076e2f docs updates
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
79
2023
c45fb78969a3 docs updates on git support
Marcin Kuzminski <marcin@python-works.com>
parents: 1123
diff changeset
80 .. _waitress: http://pypi.python.org/pypi/waitress
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2992
diff changeset
81 .. _gunicorn: http://pypi.python.org/pypi/gunicorn
4972
b52a1ccee927 docs/usage: reword information on Mercurial subrepository support
Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
parents: 4971
diff changeset
82 .. _subrepositories: http://mercurial.aragost.com/kick-start/en/subrepositories/