Mercurial > hg > orthanc-book

annotate Sphinx/source/developers/repositories.rst @ 343:fff45618262d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
creating the documentation of the Python plugin
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 26 Mar 2020 18:42:31 +0100
parents ab1ec4009541
children 9f82ecc5a422
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
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
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
31 maybe not. But the Orthanc ecosystem is not at all about versioning
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
32 systems. We want to be entirely dedicated to lowering barriers to
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
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
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
59 .. _hg-clone:
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
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
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 <https://hg.orthanc-server.com/>`__.
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 .. highlight:: bash
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 Locally cloning one of those Mercurial repositories (say, the main
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 ``orthanc`` repository) is as simple as typing::
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 $ hg clone https://hg.orthanc-server.com/orthanc
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74
340
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
75 You can then use separate tools such as `TortoiseHg
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
76 <https://en.wikipedia.org/wiki/TortoiseHg>`__ to browse the code with
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
77 richer features than the Web interface.
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
78
339
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 Write access
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 ^^^^^^^^^^^^
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 Only the core developers of Orthanc have direct write access to the
342
ab1ec4009541 cloning for dev
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 340
diff changeset
84 Orthanc repositories (through SSH). Core developers can clone a
ab1ec4009541 cloning for dev
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 340
diff changeset
85 repository with write access as follows::
ab1ec4009541 cloning for dev
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 340
diff changeset
86
ab1ec4009541 cloning for dev
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 340
diff changeset
87 $ hg clone ssh://hg@hg.orthanc-server.com/public/orthanc
339
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89
340
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
90 .. _hg-contributing:
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
91
339
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 Submitting code
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 ^^^^^^^^^^^^^^^
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 We will of course be extremely grateful for receiving external code
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96 contributions to the Orthanc repositories!
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98 However, one of the weaknesses of our self-hosted infrastructure is
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 that is does not support automation for `pull requests
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100 <https://en.wikipedia.org/wiki/Distributed_version_control#Pull_requests>`__.
340
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
101 This section explains the `two accepted ways for communicating
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
102 contributions
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
103 <https://www.mercurial-scm.org/wiki/CommunicatingChanges>`__: by
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
104 submitting a patch, or by exchanging a bundle.
339
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106 Importantly, before any contribution can be accepted into the Orthanc
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107 repositories, its author must sign a :ref:`CLA <cla>`. This allows
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108 both the University Hospital of Liège and the Osimis company to act as
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
109 the official guardians of the whole Orthanc ecosystem.
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
110
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
111
340
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
112 .. _hg-patch:
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
113
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
114 Simple patch (import/export)
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
115 ............................
339
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
116
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117 .. highlight:: bash
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
118
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
119 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
120 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
121
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
122 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
123 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
124 mainline code)::
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
125
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
126 $ hg pull
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
127 $ hg up -c default
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
128 [...make your modifications...]
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
129
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
130 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
131
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
132 $ hg export -r default > /tmp/contribution.patch
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 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
135 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
136 `discussion group
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
137 <https://groups.google.com/forum/#!forum/orthanc-users>`__. The core
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
138 developers would reintegrate such a patch by typing the following
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
139 command on their side::
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 $ hg pull
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
142 $ hg up -c default
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
143 $ hg import /tmp/contribution.patch
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
144
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
145
340
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
146 .. _hg-bundle:
339
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
147
340
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
148 Exchanging a bundle
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
149 ...................
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
150
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
151 .. highlight:: bash
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
152
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
153 If your contribution is made of several changesets (commits), you
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
154 should work in a dedicated branch, then submit a Mercurial bundle for
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
155 this branch.
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
156
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
157 First make sure to pull the latest version of the code repository,
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
158 then create a branch, say ``my-user/my-fix``, that derives from the
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
159 ``default`` branch (which corresponds to the mainline code)::
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
160
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
161 $ hg pull
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
162 $ hg up -c default
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
163 $ hg branch my-user/my-fix
339
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
164
340
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
165 WARNING: Please chose an unique, explicit name for your branch, and
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
166 make sure that your username is included within for traceability! The
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
167 name ``my-user/my-fix`` is only here for the purpose of the example.
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
168
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
169 You can then do all the modifications as required (including ``hg
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
170 add``, ``hg rm``, and ``hg commit``) in the branch
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
171 ``my-user/my-fix``. When you're done, create a Mercurial bundle that
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
172 gathers all your changes against the source repository as follows::
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
173
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
174 $ hg commit -m 'submitting my fix'
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
175 $ 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
176
340
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
177 Obviously, make sure to replace
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
178 ``https://hg.orthanc-server.com/orthanc`` by the location of the
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
179 source repository.
339
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
180
340
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
181 Finally, you can submit the file ``/tmp/contribution.bundle`` to the
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
182 community, just like for simple patches. Note that this procedure
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
183 inherently corresponds to the manual creation of a pull request.
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
184
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
185 The core developers would reintegrate such a bundle into the mainline
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
186 by typing the following commands on their side::
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
187
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
188 $ cd /tmp
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
189 $ hg clone https://hg.orthanc-server.com/orthanc
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
190 $ cd /tmp/orthanc
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
191 $ hg unbundle /tmp/contribution.bundle
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
192 $ hg up -c default
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
193 $ hg merge my-user/my-fix
b5741b354afa bundles
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 339
diff changeset
194
339
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
195
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
196 Issue tracker
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
197 -------------
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
198
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
199 This is work-in-progress. Orthanc will most probably move to the
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
200 `Roundup issue tracker
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
201 <https://en.wikipedia.org/wiki/Roundup_(issue_tracker)>`__ that is
c0a3cd1cabff Accessing code repositories
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
202 notably used by the Python community.