Mercurial > kallithea
comparison docs/usage/general.rst @ 4967:4185f87f0ee0
docs/usage: rework section on non-changeable repository URLs and call them 'permanent'
author | Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> |
---|---|
date | Sat, 04 Apr 2015 21:29:00 +0200 |
parents | 543bf62d06c7 |
children | 584693b3deb0 |
comparison
equal
deleted
inserted
replaced
4966:543bf62d06c7 | 4967:4185f87f0ee0 |
---|---|
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 Non changeable repository urls | 73 Permanent repository URLs |
74 ------------------------------ | 74 ------------------------- |
75 | 75 |
76 Due to the complicated nature of repository grouping, URLs of repositories | 76 Due to the complicated nature of repository grouping, URLs of repositories |
77 can often change. | 77 can often change. For example, a repository originally accessible from:: |
78 | 78 |
79 example:: | 79 http://server.com/repo_name |
80 | 80 |
81 #before | 81 would get a new URL after moving it to test_group:: |
82 http://server.com/repo_name | 82 |
83 # after insertion to test_group group the url will be | |
84 http://server.com/test_group/repo_name | 83 http://server.com/test_group/repo_name |
85 | 84 |
86 This can be an issue for build systems and any other hardcoded scripts, moving | 85 Such moving of a repository to a group can be an issue for build systems and |
87 a repository to a group leads to a need for changing external systems. To | 86 other scripts where the repository paths are hardcoded. To mitigate this, |
88 overcome this Kallithea introduces a non-changable replacement URL. It's | 87 Kallithea provides permanent URLs using the repository ID prefixed with an |
89 simply a repository ID prefixed with ``_``. The above URLs are also accessible as:: | 88 underscore. In all Kallithea URLs, for example those for the changelog and the |
89 file view, a repository name can be replaced by this ``_ID`` string. Since IDs | |
90 are always the same, moving the repository to a different group will not affect | |
91 such URLs. | |
92 | |
93 In the example, the repository could also be accessible as:: | |
90 | 94 |
91 http://server.com/_<ID> | 95 http://server.com/_<ID> |
92 | 96 |
93 Since IDs are always the same, moving the repository will not affect | 97 The ID of a given repository can be shown from the repository ``Summary`` page, |
94 such a URL. the ``_<ID>`` syntax can be used anywhere in the system so | 98 by selecting the ``Show by ID`` button next to ``Clone URL``. |
95 URLs with ``repo_name`` for changelogs and files can be exchanged | |
96 with the ``_<ID>`` syntax. | |
97 | |
98 | 99 |
99 E-mail notifications | 100 E-mail notifications |
100 -------------------- | 101 -------------------- |
101 | 102 |
102 When the administrator correctly specified the e-mail settings in the Kallithea | 103 When the administrator correctly specified the e-mail settings in the Kallithea |