1
- .. This file has been modified from the CPython version.
2
- Modifications are extensive, and normally this would mean we should write a
3
- new file index_jy.rst, but the expectation is that index.rst is the starting
4
- point for the documentation.
5
- We therefore keep it as modified, although merging from the CPython devguide
6
- is more difficult this way.
1
+ .. This file has been extensively modified from the CPython version.
2
+ Normally this would mean a new file index_jy.rst, but index.rst is the
3
+ starting point for the documentation.
4
+ We therefore keep it as modified, although merging changes from the CPython
5
+ devguide difficult for this file.
7
6
8
7
========================
9
8
Jython Developer's Guide
@@ -16,14 +15,13 @@ bear in mind that:
16
15
17
16
* The CPython process is PR-based on GitHub and this guide anticipates our
18
17
adoption of that for Jython.
19
- * The existing Jython process uses Mercurial hosted at ``python.org ``, and
20
- patches via the bug-tracker: you will find that in this guide too.
21
- * When the guide says "Python", that section is true for Jython too.
18
+ * The existing Jython process uses Mercurial so the guide describes that too.
19
+ * Statements about "Python" should apply to both CPython and Jython.
22
20
* The adaptation is imperfect: parts of the guide will say (or mean) CPython.
23
21
24
22
This guide is :ref: `maintained <helping-with-the-developers-guide >` by the same
25
23
community that maintains CPython and Jython.
26
- We welcome your contributions to both these implementations of Python!
24
+ We welcome your contributions to either implementation of Python!
27
25
28
26
29
27
Quick Reference
@@ -32,11 +30,11 @@ Quick Reference
32
30
Mercurial
33
31
^^^^^^^^^
34
32
35
- 1. :ref: `Get the source code <checkout >`::
33
+ 1. :ref: `Get the source code <checkout-jy >`::
36
34
37
35
hg clone http://hg.python.org/jython
38
36
39
- 2. :ref: `Build Jython <compiling >`::
37
+ 2. :ref: `Build Jython <compiling-jy >`::
40
38
41
39
ant
42
40
@@ -178,11 +176,12 @@ Contributing
178
176
------------
179
177
180
178
We encourage everyone to contribute to Python and that's why we have put up this
181
- We encourage everyone to contribute to Jython and that's why we have put up this
182
179
developer's guide. If you still have questions after reviewing the material in
183
180
this guide, then the `Python Mentors `_ group is available to help guide new
184
181
contributors through the process.
185
182
183
+ .. FIXME: do Python Mentors help Jython contributors with process?
184
+
186
185
A number of individuals from the Python community have contributed to a series
187
186
of excellent guides at `Open Source Guides <https://opensource.guide/ >`_.
188
187
@@ -193,17 +192,17 @@ Core developers and contributors alike will find the following guides useful:
193
192
194
193
Guide for contributing to Jython:
195
194
196
- * :doc: `setup `
195
+ * :doc: `setup_jy `
197
196
* :doc: `help `
198
- * :doc: `pullrequest `
199
- * :doc: `patch_hg_jy `
197
+ * :doc: `patch_hg_jy ` (existing process)
198
+ * :doc: `pullrequest ` (partly usable future process)
200
199
* :doc: `runtests `
201
200
* Beginner tasks to become familiar with the development process
202
201
* :doc: `docquality `
203
202
* :doc: `coverage `
204
203
* Advanced tasks for once you are comfortable
205
204
* :doc: `silencewarnings `
206
- * Fixing issues found by the :doc: `buildbots <buildbots >`
205
+ * Fixing issues found by the :doc: `buildbots <buildbots_jy >`
207
206
* :doc: `fixingissues `
208
207
* :ref: `tracker ` and :ref: `helptriage `
209
208
* :doc: `triaging `
@@ -213,8 +212,7 @@ Guide for contributing to Jython:
213
212
* :doc: `committing `
214
213
* :doc: `committing_hg_jy `
215
214
* :doc: `devcycle `
216
- * :doc: `buildbots `
217
- * :doc: `coverity `
215
+ * :doc: `buildbots_jy `
218
216
* :doc: `gitbootcamp `
219
217
220
218
It is **recommended ** that the above documents be read in the order listed. You
@@ -245,8 +243,8 @@ happen and that process is also described as part of this guide:
245
243
Other Interpreter Implementations
246
244
---------------------------------
247
245
248
- This guide is specifically for contributing to Python on the JVM ,
249
- also known as Jython . (While most of the standard library is written in Python,
246
+ This guide is specifically for contributing to Jython, that is ,
247
+ Python on the JVM . (While most of the standard library is written in Python,
250
248
the interpreter core is written in Java and integrates most easily with the Java
251
249
SE and EE ecosystems).
252
250
@@ -276,8 +274,8 @@ Key Resources
276
274
tracker for the issue tracker)
277
275
* :doc: `experts `
278
276
* Source code
279
- * `Browse online <http://hg.python.org/jython/file/default/ >`_
280
- <https://github.com/jython/jython/>`_
277
+ * `Browse in Mercurial online <http://hg.python.org/jython/file/default/ >`_
278
+ * ` Browse in GitHub <https://github.com/jython/jython/ >`_
281
279
282
280
* PEPs _ (Python Enhancement Proposals)
283
281
* :doc: `help `
@@ -294,7 +292,6 @@ Additional Resources
294
292
* :doc: `grammar_jy `
295
293
* :doc: `compiler_jy `
296
294
* Tool support
297
- * Various tools with configuration files as found in the `Misc directory `_
298
295
* Information about editors and their configurations can be found in the
299
296
`wiki <https://wiki.python.org/moin/PythonEditors >`_
300
297
@@ -350,8 +347,8 @@ Specific to CPython_
350
347
--------------------
351
348
352
349
These are sections from the CPython guide, retained for reference.
353
- A comparison with the CPython implementation of a feature can help you
354
- understand the Jython one.
350
+ A comparison with the CPython implementation of a feature will sometimes help
351
+ you understand the Jython one.
355
352
356
353
.. We're also keeping these files for the technical reason that changes from
357
354
CPython upstream can only be merged if these CPython files continue to exist.
0 commit comments