Mercurial > hg > orthanc-book
comparison Sphinx/source/developers/repositories.rst @ 991:1316bc62b5d5
migration to UCLouvain servers
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Tue, 21 Nov 2023 21:09:02 +0100 |
parents | 46e2941b57dd |
children | 05b106383b2a |
comparison
equal
deleted
inserted
replaced
990:27b75c653a8b | 991:1316bc62b5d5 |
---|---|
9 Context | 9 Context |
10 ------- | 10 ------- |
11 | 11 |
12 The Orthanc server and most of its plugins are versioned using | 12 The Orthanc server and most of its plugins are versioned using |
13 `Mercurial <https://en.wikipedia.org/wiki/Mercurial>`__ on a | 13 `Mercurial <https://en.wikipedia.org/wiki/Mercurial>`__ on a |
14 `self-hosted server <https://hg.orthanc-server.com/>`__. | 14 `self-hosted server <https://orthanc.uclouvain.be/hg/>`__. |
15 | 15 |
16 The Orthanc project started back in 2011, back in a time where | 16 The Orthanc project started back in 2011, back in a time where |
17 Mercurial and `Git <https://en.wikipedia.org/wiki/Git>`__ were equally | 17 Mercurial and `Git <https://en.wikipedia.org/wiki/Git>`__ were equally |
18 popular. Sébastien Jodogne, the original author of Orthanc, decided to | 18 popular. Sébastien Jodogne, the original author of Orthanc, decided to |
19 use Mercurial given the higher simplicity of its set of commands, and | 19 use Mercurial given the higher simplicity of its set of commands, and |
61 Read-only access | 61 Read-only access |
62 ^^^^^^^^^^^^^^^^ | 62 ^^^^^^^^^^^^^^^^ |
63 | 63 |
64 Anybody has full read-only access to all of the Orthanc official | 64 Anybody has full read-only access to all of the Orthanc official |
65 repositories, on our `self-hosted server | 65 repositories, on our `self-hosted server |
66 <https://hg.orthanc-server.com/>`__. As the ``hg serve`` tool that is | 66 <https://orthanc.uclouvain.be/hg/>`__. As the ``hg serve`` tool that is |
67 used by our Web server tends to be slow, we recommend people to | 67 used by our Web server tends to be slow, we recommend people to |
68 locally clone our Mercurial repositories. | 68 locally clone our Mercurial repositories. |
69 | 69 |
70 .. highlight:: bash | 70 .. highlight:: bash |
71 | 71 |
72 Locally cloning one of those Mercurial repositories (say, the main | 72 Locally cloning one of those Mercurial repositories (say, the main |
73 ``orthanc`` repository) is as simple as typing:: | 73 ``orthanc`` repository) is as simple as typing:: |
74 | 74 |
75 $ hg clone https://hg.orthanc-server.com/orthanc/ | 75 $ hg clone https://orthanc.uclouvain.be/hg/orthanc/ |
76 | 76 |
77 You can then use separate tools such as `TortoiseHg | 77 You can then use separate tools such as `TortoiseHg |
78 <https://en.wikipedia.org/wiki/TortoiseHg>`__ to browse the code with | 78 <https://en.wikipedia.org/wiki/TortoiseHg>`__ to browse the code with |
79 richer features than the Web interface. | 79 richer features than the Web interface. |
80 | 80 |
170 on FreeBSD, on Microsoft Visual Studio 2008 (32 bit), on Microsoft | 170 on FreeBSD, on Microsoft Visual Studio 2008 (32 bit), on Microsoft |
171 Visual Studio 2015 (64 bit), and on Apple OS X 10.9 | 171 Visual Studio 2015 (64 bit), and on Apple OS X 10.9 |
172 "Mavericks". Submitted code might have to be adapted to compile on | 172 "Mavericks". Submitted code might have to be adapted to compile on |
173 these platforms. Architecture-dependant code should be located in | 173 these platforms. Architecture-dependant code should be located in |
174 the `Orthanc::Toolbox | 174 the `Orthanc::Toolbox |
175 <https://hg.orthanc-server.com/orthanc/file/default/OrthancFramework/Sources/Toolbox.h>`__ | 175 <https://orthanc.uclouvain.be/hg/orthanc/file/default/OrthancFramework/Sources/Toolbox.h>`__ |
176 and `Orthanc::SystemToolbox | 176 and `Orthanc::SystemToolbox |
177 <https://hg.orthanc-server.com/orthanc/file/default/OrthancFramework/Sources/SystemToolbox.h>`__ | 177 <https://orthanc.uclouvain.be/hg/orthanc/file/default/OrthancFramework/Sources/SystemToolbox.h>`__ |
178 static classes. | 178 static classes. |
179 | 179 |
180 * Please stick to the :ref:`coding style <coding-style>` of Orthanc. | 180 * Please stick to the :ref:`coding style <coding-style>` of Orthanc. |
181 | 181 |
182 * Your individual contributions should be kept **as small as | 182 * Your individual contributions should be kept **as small as |
183 possible**, and should be focused on one very specific issue or | 183 possible**, and should be focused on one very specific issue or |
184 feature. Large architectural changes are reserved for the core | 184 feature. Large architectural changes are reserved for the core |
185 development team of Orthanc, as we must follow our `long-term | 185 development team of Orthanc, as we must follow our `long-term |
186 roadmap | 186 roadmap |
187 <https://hg.orthanc-server.com/orthanc/file/default/TODO>`__. | 187 <https://orthanc.uclouvain.be/hg/orthanc/file/default/TODO>`__. |
188 | 188 |
189 * Unit testing is mandatory. Integration tests should be submitted to | 189 * Unit testing is mandatory. Integration tests should be submitted to |
190 the `dedicated repository | 190 the `dedicated repository |
191 <https://hg.orthanc-server.com/orthanc-tests/file/default>`__. | 191 <https://orthanc.uclouvain.be/hg/orthanc-tests/file/default>`__. |
192 | 192 |
193 * All the contributions will be carefully reviewed. Some contributions | 193 * All the contributions will be carefully reviewed. Some contributions |
194 may be modified, yet even rejected. A rejection might for instance | 194 may be modified, yet even rejected. A rejection might for instance |
195 occur if your contribution does not match the Orthanc roadmap, does | 195 occur if your contribution does not match the Orthanc roadmap, does |
196 not meet our high-quality code standards, or breaks backward | 196 not meet our high-quality code standards, or breaks backward |
279 add``, ``hg rm``, and ``hg commit``) in the branch | 279 add``, ``hg rm``, and ``hg commit``) in the branch |
280 ``my-user/my-fix``. When you're done, create a Mercurial bundle that | 280 ``my-user/my-fix``. When you're done, create a Mercurial bundle that |
281 gathers all your changes against the source repository as follows:: | 281 gathers all your changes against the source repository as follows:: |
282 | 282 |
283 $ hg commit -m 'submitting my fix' | 283 $ hg commit -m 'submitting my fix' |
284 $ hg bundle /tmp/contribution.bundle https://hg.orthanc-server.com/orthanc | 284 $ hg bundle /tmp/contribution.bundle https://orthanc.uclouvain.be/hg/orthanc |
285 | 285 |
286 Obviously, make sure to replace | 286 Obviously, make sure to replace |
287 ``https://hg.orthanc-server.com/orthanc`` by the location of the | 287 ``https://orthanc.uclouvain.be/hg/orthanc`` by the location of the |
288 source repository. | 288 source repository. |
289 | 289 |
290 Finally, you can submit the file ``/tmp/contribution.bundle`` to the | 290 Finally, you can submit the file ``/tmp/contribution.bundle`` to the |
291 community, just like for simple patches. Note that this procedure | 291 community, just like for simple patches. Note that this procedure |
292 inherently corresponds to the manual creation of a pull request. | 292 inherently corresponds to the manual creation of a pull request. |
293 | 293 |
294 The core developers would reintegrate such a bundle into the mainline | 294 The core developers would reintegrate such a bundle into the mainline |
295 by typing the following commands on their side:: | 295 by typing the following commands on their side:: |
296 | 296 |
297 $ cd /tmp | 297 $ cd /tmp |
298 $ hg clone https://hg.orthanc-server.com/orthanc/ | 298 $ hg clone https://orthanc.uclouvain.be/hg/orthanc/ |
299 $ cd /tmp/orthanc | 299 $ cd /tmp/orthanc |
300 $ hg unbundle /tmp/contribution.bundle | 300 $ hg unbundle /tmp/contribution.bundle |
301 $ hg up -c default | 301 $ hg up -c default |
302 $ hg merge my-user/my-fix | 302 $ hg merge my-user/my-fix |
303 | 303 |
314 | 314 |
315 | 315 |
316 Issue tracker | 316 Issue tracker |
317 ------------- | 317 ------------- |
318 | 318 |
319 The `official bug tracker <https://bugs.orthanc-server.com/>`__ of the | 319 The `official bug tracker <https://orthanc.uclouvain.be/bugs/>`__ of the |
320 Orthanc project runs thanks to `Bugzilla | 320 Orthanc project runs thanks to `Bugzilla |
321 <https://en.wikipedia.org/wiki/Bugzilla>`__. | 321 <https://en.wikipedia.org/wiki/Bugzilla>`__. |
322 | 322 |
323 We have done our best to automatically import most of the history | 323 We have done our best to automatically import most of the history |
324 from the old BitBucket bug tracker. | 324 from the old BitBucket bug tracker. |