Mercurial > kallithea

comparison docs/usage/general.rst @ 5425:5ae8e644aa88

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: spelling, grammar, content and typography
author Søren Løvborg <sorenl@unity3d.com>
date Tue, 18 Aug 2015 11:47:19 +0200
parents 22a3fa3c4254
children fbbe80e3322b
comparison
equal deleted inserted replaced
5424:b361974171ea 5425:5ae8e644aa88
3 ======================= 3 =======================
4 General Kallithea usage 4 General Kallithea usage
5 ======================= 5 =======================
6 6
7 7
8 Repository deleting 8 Repository deletion
9 ------------------- 9 -------------------
10 10
11 Currently when an admin or owner deletes a repository, Kallithea does 11 Currently when an admin or owner deletes a repository, Kallithea does
12 not physically delete said repository from the filesystem, but instead 12 not physically delete said repository from the filesystem, but instead
13 renames it in a special way so that it is not possible to push, clone 13 renames it in a special way so that it is not possible to push, clone
14 or access the repository. 14 or access the repository.
15 15
16 There is a special command for cleaning up such archived repos:: 16 There is a special command for cleaning up such archived repositories::
17 17
18 paster cleanup-repos --older-than=30d my.ini 18 paster cleanup-repos --older-than=30d my.ini
19 19
20 This command scans for archived repositories that are older than 20 This command scans for archived repositories that are older than
21 30 days, displays them, and asks if you want to delete them (unless given 21 30 days, displays them, and asks if you want to delete them (unless given
68 Creating a pull request 68 Creating a pull request
69 You can create a new pull request for the changes of a particular changeset 69 You can create a new pull request for the changes of a particular changeset
70 (and its ancestors) by selecting it and clicking the ``Open new pull request 70 (and its ancestors) by selecting it and clicking the ``Open new pull request
71 for selected changesets`` button. 71 for selected changesets`` button.
72 72
73
73 Permanent repository URLs 74 Permanent repository URLs
74 ------------------------- 75 -------------------------
75 76
76 Due to the complicated nature of repository grouping, URLs of repositories 77 Due to the complicated nature of repository grouping, URLs of repositories
77 can often change. For example, a repository originally accessible from:: 78 can often change. For example, a repository originally accessible from::
78 79
79 http://server.com/repo_name 80 http://example.com/repo_name
80 81
81 would get a new URL after moving it to test_group:: 82 would get a new URL after moving it to test_group::
82 83
83 http://server.com/test_group/repo_name 84 http://example.com/test_group/repo_name
84 85
85 Such moving of a repository to a group can be an issue for build systems and 86 Such moving of a repository to a group can be an issue for build systems and
86 other scripts where the repository paths are hardcoded. To mitigate this, 87 other scripts where the repository paths are hardcoded. To mitigate this,
87 Kallithea provides permanent URLs using the repository ID prefixed with an 88 Kallithea provides permanent URLs using the repository ID prefixed with an
88 underscore. In all Kallithea URLs, for example those for the changelog and the 89 underscore. In all Kallithea URLs, for example those for the changelog and the
90 are always the same, moving the repository to a different group will not affect 91 are always the same, moving the repository to a different group will not affect
91 such URLs. 92 such URLs.
92 93
93 In the example, the repository could also be accessible as:: 94 In the example, the repository could also be accessible as::
94 95
95 http://server.com/_<ID> 96 http://example.com/_<ID>
96 97
97 The ID of a given repository can be shown from the repository ``Summary`` page, 98 The ID of a given repository can be shown from the repository ``Summary`` page,
98 by selecting the ``Show by ID`` button next to ``Clone URL``. 99 by selecting the ``Show by ID`` button next to ``Clone URL``.
99 100
101
100 Email notifications 102 Email notifications
101 ------------------- 103 -------------------
102 104
103 When the administrator correctly specified the email settings in the Kallithea 105 With email settings properly configured in the Kallithea
104 configuration file, Kallithea will send emails on user registration and when 106 configuration file, Kallithea will send emails on user registration and when
105 errors occur. 107 errors occur.
106 108
107 Emails are also sent for comments on changesets. In this case, an email is sent 109 Emails are also sent for comments on changesets. In this case, an email is sent
108 to the committer of the changeset (if known to Kallithea), to all reviewers of 110 to the committer of the changeset (if known to Kallithea), to all reviewers of
149 features that merit further explanation. 151 features that merit further explanation.
150 152
151 Repository extra fields 153 Repository extra fields
152 ~~~~~~~~~~~~~~~~~~~~~~~ 154 ~~~~~~~~~~~~~~~~~~~~~~~
153 155
154 In the `Visual` tab, there is an option `Use repository extra 156 In the *Visual* tab, there is an option "Use repository extra
155 fields`, which allows to set custom fields for each repository in the system. 157 fields", which allows to set custom fields for each repository in the system.
156 Each new field consists of 3 attributes: ``field key``, ``field label``, 158
157 ``field description``. 159 Once enabled site-wide, the custom fields can be edited per-repository under
160 *Options* | *Settings* | *Extra Fields*.
158 161
159 Example usage of such fields would be to define company-specific information 162 Example usage of such fields would be to define company-specific information
160 into repositories, e.g., defining a ``repo_manager`` key that would give info 163 into repositories, e.g., defining a ``repo_manager`` key that would give info
161 about a manager of each repository. There's no limit for adding custom fields. 164 about a manager of each repository. There's no limit for adding custom fields.
162 Newly created fields are accessible via the API. 165 Newly created fields are accessible via the API.
163 166
164 Meta tagging 167 Meta tagging
165 ~~~~~~~~~~~~ 168 ~~~~~~~~~~~~
166 169
167 In the `Visual` tab, option `Stylify recognised meta tags` will cause Kallithea 170 In the *Visual* tab, option "Stylify recognised meta tags" will cause Kallithea
168 to turn certain meta-tags, detected in repository and repository group 171 to turn certain text fragments in repository and repository group
169 descriptions, into colored tags. Currently recognised tags are:: 172 descriptions into colored tags. Currently recognised tags are::
170 173
171 [featured] 174 [featured]
172 [stale] 175 [stale]
173 [dead] 176 [dead]
174 [lang => lang] 177 [lang => lang]