Mercurial > hg > orthanc-book
annotate Sphinx/source/developers/repositories.rst @ 660:a6e371768a70
dicom-as-json
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Thu, 29 Apr 2021 12:41:31 +0200 |
| parents | 53992cb7fa7f |
| children | 63f246134e5b |
| rev | line source |
|---|---|
|
339
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
1 .. _repositories: |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
2 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
3 Accessing code repositories |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
4 =========================== |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
5 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
6 .. contents:: |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
7 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
8 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
9 Context |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
10 ------- |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
11 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
12 The Orthanc server and most of its plugins are versioned using |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
13 `Mercurial <https://en.wikipedia.org/wiki/Mercurial>`__ on a |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
14 `self-hosted server <https://hg.orthanc-server.com/>`__. |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
15 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
16 The Orthanc project started back in 2011, back in a time where |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
17 Mercurial and `Git <https://en.wikipedia.org/wiki/Git>`__ were equally |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
18 popular. Sébastien Jodogne, the original author of Orthanc, decided to |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
19 use Mercurial given the higher simplicity of its set of commands, and |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
20 given the fact it is safer to use for less experienced users. |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
21 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
22 As pointed out on `Wikipedia |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
23 <https://en.wikipedia.org/wiki/Mercurial>`__, the *"Git vs. Mercurial |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
24 [debate] has become one of the holy wars of hacker culture."* We |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
25 certainly don't want to endure this debate in the context of the |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
26 Orthanc ecosystem. The fact is that a distributed revision-control |
| 340 | 27 was needed for Orthanc, and that both Git and Mercurial have a similar |
|
339
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
28 set of features. |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
29 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
30 If Orthanc were started in 2020, maybe we would have used Git, or |
| 340 | 31 maybe not. But the Orthanc ecosystem is not at all about versioning |
| 32 systems. We want to be entirely dedicated to lowering barriers to | |
| 33 entry in the field of medical imaging. As a consequence, the choice of | |
|
339
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
34 Mercurial should be considered as a part of the history, and we simply |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
35 ask people to accept it as a fact. |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
36 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
37 Regarding the reason behind self-hosting, Orthanc was hosted on |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
38 `Google Code |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
39 <https://en.wikipedia.org/wiki/Google_Developers#Google_Code>`__ |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
40 between 2012 and 2015, until it was shutdown. In July 2015, Orthanc |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
41 was moved to `Bitbucket by Atlassian |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
42 <https://en.wikipedia.org/wiki/Bitbucket>`__. Unfortunately, in July |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
43 2019, Bitbucket announced that `Mercurial support would be dropped on |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
44 June 2020 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
45 <https://bitbucket.org/blog/sunsetting-mercurial-support-in-bitbucket>`__, |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
46 forcing us to deal with another migration. |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
47 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
48 We are of course grateful to Google and Atlassian for having hosted |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
49 Orthanc during 8 years. However, we cannot afford the cost of |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
50 periodically coping with hosting migrations. We prefer to have a |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
51 simpler environment, yet under our full control. As a consequence, |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
52 starting Q2 2020, Orthanc is hosted using the official ``hg serve`` |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
53 tool. |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
54 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
55 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
56 Accessing Mercurial |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
57 ------------------- |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
58 |
| 340 | 59 .. _hg-clone: |
| 60 | |
|
339
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
61 Read-only access |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
62 ^^^^^^^^^^^^^^^^ |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
63 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
64 Anybody has full read-only access to all of the Orthanc official |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
65 repositories, on our `self-hosted server |
|
390
32d0a95bee7e
note about slowness
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
366
diff
changeset
|
66 <https://hg.orthanc-server.com/>`__. As the ``hg serve`` tool that is |
|
32d0a95bee7e
note about slowness
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
366
diff
changeset
|
67 used by our Web server tends to be slow, we recommend people to |
|
32d0a95bee7e
note about slowness
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
366
diff
changeset
|
68 locally clone our Mercurial repositories. |
|
339
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
69 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
70 .. highlight:: bash |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
71 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
72 Locally cloning one of those Mercurial repositories (say, the main |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
73 ``orthanc`` repository) is as simple as typing:: |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
74 |
| 362 | 75 $ hg clone https://hg.orthanc-server.com/orthanc/ |
|
339
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
76 |
| 340 | 77 You can then use separate tools such as `TortoiseHg |
| 78 <https://en.wikipedia.org/wiki/TortoiseHg>`__ to browse the code with | |
| 79 richer features than the Web interface. | |
| 80 | |
| 366 | 81 .. highlight:: text |
| 82 | |
| 83 You might have to set up a host fingerprint in the Mercurial | |
| 84 configuration. Add the following lines to your ``~/.hgrc`` file:: | |
| 85 | |
| 86 [hostfingerprints] | |
|
599
1248dadca1cd
updated mercurial fingerprints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
559
diff
changeset
|
87 hg.orthanc-server.com = 72:F4:32:09:0F:F1:67:03:83:44:BF:0B:44:34:9D:B6:C6:0C:6A:32 |
|
514
55bd72f6df8a
update mercurial fingerprints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
498
diff
changeset
|
88 |
|
55bd72f6df8a
update mercurial fingerprints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
498
diff
changeset
|
89 .. highlight:: bash |
|
55bd72f6df8a
update mercurial fingerprints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
498
diff
changeset
|
90 |
|
55bd72f6df8a
update mercurial fingerprints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
498
diff
changeset
|
91 For reference, here is the command that was used to generate this SHA1 |
|
55bd72f6df8a
update mercurial fingerprints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
498
diff
changeset
|
92 fingerprint (`click here for more information |
|
55bd72f6df8a
update mercurial fingerprints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
498
diff
changeset
|
93 <https://wiki.fluidproject.org/display/fluid/Setting+Host+Fingerprints+for+Mercurial>`__):: |
|
55bd72f6df8a
update mercurial fingerprints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
498
diff
changeset
|
94 |
| 522 | 95 $ openssl s_client -servername hg.orthanc-server.com -connect hg.orthanc-server.com:443 \ |
| 96 < /dev/null 2>/dev/null | openssl x509 -fingerprint -sha1 -noout -in /dev/stdin | |
|
514
55bd72f6df8a
update mercurial fingerprints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
498
diff
changeset
|
97 |
|
55bd72f6df8a
update mercurial fingerprints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
498
diff
changeset
|
98 **Important:** As our certificates are changed periodically, you'll |
|
55bd72f6df8a
update mercurial fingerprints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
498
diff
changeset
|
99 have to regularly update your configuration file once Mercurial |
|
55bd72f6df8a
update mercurial fingerprints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
498
diff
changeset
|
100 complains about an unexpected fingerprint. |
| 366 | 101 |
|
339
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
102 |
|
391
4bc6bcd83ae5
hostfingerprints is not specific to Windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
390
diff
changeset
|
103 Recent versions of Mercurial |
|
4bc6bcd83ae5
hostfingerprints is not specific to Windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
390
diff
changeset
|
104 ............................ |
| 344 | 105 |
| 106 .. highlight:: text | |
| 107 | |
|
391
4bc6bcd83ae5
hostfingerprints is not specific to Windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
390
diff
changeset
|
108 While cloning the repository, you might face an error similar to:: |
| 344 | 109 |
| 110 abort: error: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed (_ssl.c:661) | |
| 111 | |
| 112 In such a case, you must explicitly add the cryptographic fingerprint | |
|
391
4bc6bcd83ae5
hostfingerprints is not specific to Windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
390
diff
changeset
|
113 of our code server using a more recent option than the |
|
4bc6bcd83ae5
hostfingerprints is not specific to Windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
390
diff
changeset
|
114 ``hostfingerprints`` option. To this end, edit the `configuration file |
| 344 | 115 <https://www.mercurial-scm.org/doc/hgrc.5.html#files>`__ of Mercurial |
|
391
4bc6bcd83ae5
hostfingerprints is not specific to Windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
390
diff
changeset
|
116 (by default on Microsoft Windows, ``%USERPROFILE%\Mercurial.ini``), |
|
4bc6bcd83ae5
hostfingerprints is not specific to Windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
390
diff
changeset
|
117 and add the following lines:: |
| 344 | 118 |
| 119 [hostsecurity] | |
|
599
1248dadca1cd
updated mercurial fingerprints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
559
diff
changeset
|
120 hg.orthanc-server.com:fingerprints=sha256:74:24:16:D3:C8:22:45:7E:6B:00:6C:63:86:37:9F:A1:B1:04:A7:F4:3C:7E:5A:1A:68:0A:7A:AF:3B:1A:14:52 |
| 344 | 121 |
| 122 .. highlight:: bash | |
| 123 | |
| 124 For reference, here is the command that was used to generate this | |
|
514
55bd72f6df8a
update mercurial fingerprints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
498
diff
changeset
|
125 SHA256 fingerprint (`click here for more information |
| 344 | 126 <https://stackoverflow.com/a/56579497/881731>`__):: |
| 127 | |
| 522 | 128 $ openssl s_client -servername hg.orthanc-server.com -connect hg.orthanc-server.com:443 \ |
| 129 < /dev/null 2>/dev/null | openssl x509 -fingerprint -sha256 -noout -in /dev/stdin | |
| 344 | 130 |
| 131 | |
|
339
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
132 Write access |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
133 ^^^^^^^^^^^^ |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
134 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
135 Only the core developers of Orthanc have direct write access to the |
| 342 | 136 Orthanc repositories (through SSH). Core developers can clone a |
| 137 repository with write access as follows:: | |
| 138 | |
| 362 | 139 $ hg clone ssh://hg@hg.orthanc-server.com/public/orthanc/ |
|
339
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
140 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
141 |
| 340 | 142 .. _hg-contributing: |
| 143 | |
|
339
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
144 Submitting code |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
145 ^^^^^^^^^^^^^^^ |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
146 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
147 We will of course be extremely grateful for receiving external code |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
148 contributions to the Orthanc repositories! |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
149 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
150 However, one of the weaknesses of our self-hosted infrastructure is |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
151 that is does not support automation for `pull requests |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
152 <https://en.wikipedia.org/wiki/Distributed_version_control#Pull_requests>`__. |
| 340 | 153 This section explains the `two accepted ways for communicating |
| 154 contributions | |
| 155 <https://www.mercurial-scm.org/wiki/CommunicatingChanges>`__: by | |
| 156 submitting a patch, or by exchanging a bundle. | |
|
339
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
157 |
| 627 | 158 |
| 159 Code quality | |
| 160 ............ | |
| 161 | |
| 162 * Your code **must follow the C++03 standard** (C++11 is not accepted | |
| 163 for maximum cross-platform compatibility on older platforms). | |
| 164 | |
| 165 * The continuous integration servers of Osimis check that Orthanc | |
| 166 properly compiles on Ubuntu 16.04, on `Linux Standard Base systems | |
| 167 <https://refspecs.linuxfoundation.org/lsb.shtml>`__ using the `LSB | |
| 168 SDB 5.0.0 | |
| 169 <http://ftp.linuxfoundation.org/pub/lsb/bundles/released-5.0.0/sdk/>`__, | |
| 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 | |
| 172 "Mavericks". Submitted code might have to be adapted to compile on | |
| 173 these platforms. Architecture-dependant code should be located in | |
| 174 the `Orthanc::Toolbox | |
| 175 <https://hg.orthanc-server.com/orthanc/file/default/OrthancFramework/Sources/Toolbox.h>`__ | |
| 176 and `Orthanc::SystemToolbox | |
| 177 <https://hg.orthanc-server.com/orthanc/file/default/OrthancFramework/Sources/SystemToolbox.h>`__ | |
| 178 static classes. | |
| 179 | |
| 180 * Please stick to the :ref:`coding style <coding-style>` of Orthanc. | |
|
339
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
181 |
| 627 | 182 * Your individual contributions should be kept **as small as |
| 183 possible**, and should be focused on one very specific issue or | |
| 184 feature. Large architectural changes are reserved for the core | |
| 185 development team of Orthanc, as we must follow our `long-term | |
| 186 roadmap | |
| 187 <https://hg.orthanc-server.com/orthanc/file/default/TODO>`__. | |
| 188 | |
| 189 * Unit testing is mandatory. Integration tests should be submitted to | |
| 190 the `dedicated repository | |
| 191 <https://hg.orthanc-server.com/orthanc-tests/file/default>`__. | |
| 192 | |
| 193 * All the contributions will be carefully reviewed. Some contributions | |
| 194 may be modified, yet even rejected. A rejection might for instance | |
| 195 occur if your contribution does not match the Orthanc roadmap, does | |
| 196 not meet our high-quality code standards, or breaks backward | |
| 197 compatibility. Please be sure that we warmly welcome and appreciate | |
| 198 your contributions, but be aware of the fact that we are quite | |
| 199 strict, and that the review process might take time. This is why the | |
| 200 recommended way of contributing to Orthanc is always by | |
| 201 :ref:`creating contributed plugins <creating-plugins>`. | |
| 202 | |
| 203 * Importantly, before any contribution can be accepted into the | |
| 204 Orthanc repositories, its author must sign a :ref:`CLA <cla>`. This | |
| 205 allows both the University Hospital of Liège and the Osimis company | |
| 206 to act as the official guardians of the whole Orthanc | |
| 207 ecosystem. Another advantage of creating plugins is that signing a | |
| 208 CLA is not needed. Make sure to carefully read our :ref:`FAQ about | |
| 209 the licensing of submitted code <submitting_code>`. | |
| 361 | 210 |
|
339
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
211 |
| 340 | 212 .. _hg-patch: |
| 213 | |
| 214 Simple patch (import/export) | |
| 215 ............................ | |
|
339
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
216 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
217 .. highlight:: bash |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
218 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
219 If you want to propose a simple contribution, the most direct way of |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
220 passing it on the Orthanc community is by creating a **simple patch**. |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
221 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
222 First make sure to pull the latest version of the code repository, |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
223 then work on your modification in the ``default`` branch (i.e. in the |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
224 mainline code):: |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
225 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
226 $ hg pull |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
227 $ hg up -c default |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
228 [...make your modifications...] |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
229 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
230 Once your contribution is done, here is how to export a patch:: |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
231 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
232 $ hg export -r default > /tmp/contribution.patch |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
233 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
234 Once the patch is ready, you can send the ``/tmp/contribution.patch`` |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
235 file to the Orthanc community, e.g. by submitting it onto our official |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
236 `discussion group |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
237 <https://groups.google.com/forum/#!forum/orthanc-users>`__. The core |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
238 developers would reintegrate such a patch by typing the following |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
239 command on their side:: |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
240 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
241 $ hg pull |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
242 $ hg up -c default |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
243 $ hg import /tmp/contribution.patch |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
244 |
|
558
8d6e94423004
dos2unix in hg import
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
548
diff
changeset
|
245 NB: If the ``hg export`` command was run on Microsoft Windows, one |
|
8d6e94423004
dos2unix in hg import
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
548
diff
changeset
|
246 might have to convert the end-of-lines from DOS (CR/LF) to UNIX (LF |
| 559 | 247 only) using the ``dos2unix`` command on the patch file, before running |
| 248 ``hg import``. Otherwise, errors like ``Hunk #1 FAILED`` might show | |
| 249 up. | |
|
339
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
250 |
|
558
8d6e94423004
dos2unix in hg import
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
548
diff
changeset
|
251 |
| 340 | 252 .. _hg-bundle: |
|
339
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
253 |
| 340 | 254 Exchanging a bundle |
| 255 ................... | |
| 256 | |
| 257 .. highlight:: bash | |
| 258 | |
| 259 If your contribution is made of several changesets (commits), you | |
| 260 should work in a dedicated branch, then submit a Mercurial bundle for | |
| 261 this branch. | |
| 262 | |
| 263 First make sure to pull the latest version of the code repository, | |
| 264 then create a branch, say ``my-user/my-fix``, that derives from the | |
| 265 ``default`` branch (which corresponds to the mainline code):: | |
| 266 | |
| 267 $ hg pull | |
| 268 $ hg up -c default | |
| 269 $ hg branch my-user/my-fix | |
|
339
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
270 |
| 340 | 271 WARNING: Please chose an unique, explicit name for your branch, and |
| 272 make sure that your username is included within for traceability! The | |
| 273 name ``my-user/my-fix`` is only here for the purpose of the example. | |
| 274 | |
| 275 You can then do all the modifications as required (including ``hg | |
| 276 add``, ``hg rm``, and ``hg commit``) in the branch | |
| 277 ``my-user/my-fix``. When you're done, create a Mercurial bundle that | |
| 278 gathers all your changes against the source repository as follows:: | |
| 279 | |
| 280 $ hg commit -m 'submitting my fix' | |
| 281 $ hg bundle /tmp/contribution.bundle https://hg.orthanc-server.com/orthanc | |
|
339
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
282 |
| 340 | 283 Obviously, make sure to replace |
| 284 ``https://hg.orthanc-server.com/orthanc`` by the location of the | |
| 285 source repository. | |
|
339
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
286 |
| 340 | 287 Finally, you can submit the file ``/tmp/contribution.bundle`` to the |
| 288 community, just like for simple patches. Note that this procedure | |
| 289 inherently corresponds to the manual creation of a pull request. | |
| 290 | |
| 291 The core developers would reintegrate such a bundle into the mainline | |
| 292 by typing the following commands on their side:: | |
| 293 | |
| 294 $ cd /tmp | |
| 362 | 295 $ hg clone https://hg.orthanc-server.com/orthanc/ |
| 340 | 296 $ cd /tmp/orthanc |
| 297 $ hg unbundle /tmp/contribution.bundle | |
| 298 $ hg up -c default | |
| 299 $ hg merge my-user/my-fix | |
| 300 | |
|
339
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
301 |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
302 Issue tracker |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
303 ------------- |
|
c0a3cd1cabff
Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff
changeset
|
304 |
|
445
987fbbc2b59e
leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
436
diff
changeset
|
305 The `official bug tracker <https://bugs.orthanc-server.com/>`__ of the |
|
987fbbc2b59e
leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
436
diff
changeset
|
306 Orthanc project runs thanks to `Bugzilla |
|
987fbbc2b59e
leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
436
diff
changeset
|
307 <https://en.wikipedia.org/wiki/Bugzilla>`__. |
|
987fbbc2b59e
leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
436
diff
changeset
|
308 |
|
987fbbc2b59e
leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
436
diff
changeset
|
309 We have done our best to automatically import most of the history |
|
987fbbc2b59e
leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
436
diff
changeset
|
310 from the old BitBucket bug tracker. |
|
987fbbc2b59e
leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
436
diff
changeset
|
311 |
|
987fbbc2b59e
leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
436
diff
changeset
|
312 Before posting any issue, make sure to carefully, completely read the |
|
987fbbc2b59e
leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
436
diff
changeset
|
313 :ref:`page about how to ask support <support>`. In particular, most |
|
987fbbc2b59e
leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
436
diff
changeset
|
314 issues should first be discussed on the dedicated `discussion group |
|
987fbbc2b59e
leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
436
diff
changeset
|
315 <https://groups.google.com/forum/#!forum/orthanc-users>`__ before |
|
987fbbc2b59e
leaving bitbucket wrt. bug tracker
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
436
diff
changeset
|
316 introducing a bug report. |