[5240e5]: content / develop.html Maximize Restore History

Download this file

develop.html    369 lines (330 with data), 9.2 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
<h1 class='title'>PDL Development</h1>
<table class="icons">
<tbody>
<tr>
<td>
<a href="#bug"><img src="images/icons/bug.png"/></a>
</td>
<td>
<a href="#bug"><img src="images/icons/bulb.png"/></a>
</td>
<td>
<a href="#devel">
<img width="100px" src="images/icons/git.png"/><br/>
<img width="45px" src="images/icons/mercurial.png"/>
<img width="45px" src="images/icons/bazaar.png"/>
</a>
</td>
</tr>
<tr>
<td>
<a href="#bug">Report a bug</a>
</td>
<td>
<a href="#feature">Request a feature</a>
</td>
<td>
<a href="#devel">Help with development</a>
</td>
</tr>
</tbody>
</table>
</center>
<h2 id="bug">Report a bug</h2>
<p>To report a bug, first <a href="https://sourceforge.net/account/login.php">
login to SourceForge</a> (or register an account) and then go to the
<a href="http://sourceforge.net/bugs/?group_id=612">bugs database</a>.</p>
<h2 id="feature">Request a feature</h2>
<p>To request a feature, first <a href="https://sourceforge.net/account/login.php">
login to SourceForge</a> (or register an account) and then go to the
<a href="http://sourceforge.net/tracker/?atid=350612&group_id=612">feaure request
tracker</a> and click on "Add new".</p>
<h2 id="devel">Help with development</h2>
<p>PDL's source code is stored in a <a href="http://git-scm.com/">Git</a>
repository, but you can also use <a href="http://mercurial.selenic.com/">
Mercurial</a> or <a href="http://bazaar.canonical.com">Bazaar</a> (via plugins)
to contribute to PDL.</p>
<ul>
<li>
<a href="http://pdl.git.sourceforge.net/">Browse Git repository online</a>.
</li>
<li>
<a href="http://mailman.jach.hawaii.edu/mailman/listinfo//pdl-porters">
Join the developers mailing list</a>.
</li>
</ul>
<script type="text/javascript">
$(function() {
$("#tabs").tabs();
});
</script>
<div id="tabs" class="tabs">
<ul>
<li><a href="#tabs-git">Git</a></li>
<li><a href="#tabs-hg">Mercurial</a></li>
<li><a href="#tabs-bzr">Bazaar</a></li>
</ul>
<!-- ============== GIT =============== -->
<div id="tabs-git">
<div class="note">
<b>Note:</b> Windows users may want to use
<a href="http://code.google.com/p/msysgit/">msysGit</a>.
</div>
<dl>
<dt>Non-developers</dt>
<dd>
<pre>git clone git://pdl.git.sourceforge.net/gitroot/pdl/pdl PDL</pre>
<p>(Use the <a href="http://sourceforge.net/patch/?group_id=612">patch
manager</a> to submit patches).</p>
</dd>
<dt>Developers</dt>
<dd>
<pre>git clone ssh://USERNAME@pdl.git.sourceforge.net/gitroot/pdl/pdl PDL</pre>
</dd>
<dt>See also</dt>
<dd>
<ul>
<li><a class="link" href="#help">Basic commands</a></li>
<li><a class="link" href="#hints">Hints for developers</a></li>
<li><a href="http://git-scm.com/documentation">Git documentation</a></li>
</ul>
</dd>
</dl>
</div>
<!-- ============== MERCURIAL =============== -->
<div id="tabs-hg">
<div class="note">
<b>Note:</b> You must install the <a href="http://hg-git.github.com/">Hg-Git
</a> extension.
</div>
<dl>
<dt>Non-developers</dt>
<dd>
<pre>hg clone git://pdl.git.sourceforge.net/gitroot/pdl/pdl PDL</pre>
<p>(Use the <a href="http://sourceforge.net/patch/?group_id=612">patch
manager</a> to submit patches).</p>
</dd>
<dt>Developers</dt>
<dd>
<pre>hg clone git+ssh://USERNAME@pdl.git.sourceforge.net/gitroot/pdl/pdl PDL</pre>
</dd>
<dt>See also</dt>
<dd>
<ul>
<li><a class="link" href="#help">Basic commands</a></li>
<li><a class="link" href="#hints">Hints for developers</a></li>
<li><a href="http://hgbook.red-bean.com/">Mercurial documentation</a></li>
</ul>
</dd>
</dl>
</div>
<!-- ============== BAZAAR =============== -->
<div id="tabs-bzr">
<div class="note">
<b>Note:</b> You must install the
<a href="http://wiki.bazaar.canonical.com/ForeignBranches/Git">Bzr-Git</a>
plugin.
</div>
<dl>
<dt>Non-developers</dt>
<dd>
<pre>bzr branch git://pdl.git.sourceforge.net/gitroot/pdl/pdl PDL</pre>
<p>(Use the <a href="http://sourceforge.net/patch/?group_id=612">patch
manager</a> to submit patches).</p>
</dd>
<dt>Developers</dt>
<dd>
<pre>bzr branch git+ssh://USERNAME@pdl.git.sourceforge.net/gitroot/pdl/pdl PDL</pre>
</dd>
<dt>See also</dt>
<dd>
<ul>
<li><a class="link" href="#help">Basic commands</a></li>
<li><a class="link" href="#hints">Hints for developers</a></li>
<li><a href="http://doc.bazaar.canonical.com">Bazaar documentation</a></li>
</ul>
</dd>
</dl>
</div>
</div> <!-- == END TABS == -->
<h2 id="help">Basic commands</h2>
<style type="text/css">
.basic {
border: 1px solid #555;
}
.basic th {
text-align: center;
}
.basic td {
width: 30%;
padding: 1em;
}
.basic td.item {
text-align: center;
border-top: 2px solid #ccc;
}
.basic td.hg { border-left: 2px solid #ccc; }
</style>
<table class="basic" cellspacing="0px">
<tbody>
<tr>
<th>Git</th>
<th>Mercurial</th>
<th>Bazaar</th>
</tr>
<tr>
<td class="item" colspan="3">Commit changes to your repository</td>
</tr>
<tr>
<td>
<pre>
git add file1 file2 ...
git commit -a</pre>
(You must "<tt>add</tt>" before every commit or use "<tt>-a</tt>").
</td>
<td class="hg">
<pre>
hg add file1 file2 ...
hg commit</pre>
</td>
<td class="hg">
<pre>
bzr add file1 file2 ...
bzr commit</pre>
</td>
</tr>
<tr>
<td class="item" colspan="3">Pull and merge any changes others have made</td>
</tr>
<tr>
<td>
<pre>
git fetch
git merge</pre>
</td>
<td class="hg">
<pre>
hg pull
hg merge</pre>
</td>
<td class="hg">
<pre>
bzr pull
bzr merge</pre>
</td>
</tr>
<tr>
<td class="item" colspan="3">Push your changes back to the shared server.</td>
</tr>
<tr>
<td><pre>git push</pre></td>
<td class="hg"><pre>hg push</pre></td>
<td class="hg"><pre>bzr dpush</pre></td>
</tr>
<tr>
<td class="item" colspan="3">Undo changes since the previous commit.</td>
</tr>
<tr>
<td><pre>git reset --hard ORIG_HEAD</pre></td>
<td class="hg"><pre>hg revert .</pre></td>
<td class="hg"><pre>bzr revert</pre></td>
</tr>
<tr>
<td class="item" colspan="3">
<b>TIP:</b> Interactively select changes to commit.
</td>
</tr>
<tr>
<td><pre>git add --patch</pre></td>
<td class="hg">
<pre>
hg record</pre>
<p>(See:
<a href="http://mercurial.selenic.com/wiki/RecordExtension">record
extension</a>).</p>
</td>
<td class="hg">N/A but the <tt>shelve</tt> can help.</td>
</tr>
<tr>
<td class="item" colspan="3">Create a branch</td>
</tr>
<tr>
<td>
<pre>
git branch Kiwi
git checkout Kiwi
</pre></td>
<td class="hg">
<pre>
hg branch Kiwi
</pre></td>
<td class="hg"><pre>bzr branch Kiwi</pre></td>
</tr>
<tr>
<td class="item" colspan="3">Push a branch to the server</td>
</tr>
<tr>
<td>
<pre>
git config branch.Kiwi.remote origin
git config branch.Kiwi.merge refs/heads/Kiwi
</pre></td>
<td class="hg">
<pre>
hg push
</pre>
(Pushes all branches).
</td>
<td class="hg">
<pre>
bzr push
</pre>
(Pushes current branch).
</td>
</tr>
</tbody>
</table>
<h2 id="hints">Hints for developers</h2>
<ol>
<li>
<p>Before committing a change to the repository you should update</p>
<ul>
<li> <tt>MANIFEST</tt> (using <tt>make manifest</tt>),
<tt>MANIFEST.SKIP</tt>, <tt>TODO</tt> files
if applicable.</li>
</ul>
</li>
<li>
<p>Remember to include POD documentation for any functions you
add to the distribution.</p>
<ul>
<li>See Basic/Core/Core.pm for an example of including POD
documentation in .pm files.</li>
<li>See Basic/Core/Primitive/Primitive.pd for an example of including
POD documentation in PDL .pd files.</li>
<li>Read the documentation in PDL::Doc for a detailed description of
the PDL documentation conventions.</li>
</ul>
</li>
<li>
<p>Make sure you add a test case in the 't' directory for any
significant additional capability you add to the PDL
package.</p>
</li>
<li>
<p>Don't commit before you successfully built and passed <tt>make test</tt>.
But then again, don't keep your changes private for too long to avoid
conflicts with other developers.</p>
</li>
<li>
<p>Use branches for long-running projects. Git and Mercurial both have
excellent support for branching and merging. Use it!</p>
</li>
<li>
<p>Bugs reported on the list should be entered into the
<a href="http://sourceforge.net/bugs/?group_id=612">bug
database</a> and bugs closed when a patch has been committed as
a fix. (Primary responsibility for this task is the pumpking,
but other devels should be able to help.)</p>
</li>
</ol>