Skip to content

Commit 38e606b

Browse files
committed
Ensure links are appropriate to Jython (index to section 3).
Check and fix hyperlinks so the reader is not carried into material specific to CPython while navigating. Also fix up content at the destination sections, where reasonably easy to do.
1 parent 48880d8 commit 38e606b

File tree

10 files changed

+102
-105
lines changed

10 files changed

+102
-105
lines changed

buildbots_jy.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,13 @@ and how various kinds of failures can be explained and diagnosed.
3434
Checking results of automatic builds
3535
------------------------------------
3636

37-
The way to view recent build results is ...
37+
The way to view recent build results is to go to the list of commits on GitHub
38+
and click on the little red cross (or whatever the symbol is when a build
39+
passes). In a PR-based process, the PR page itself contains a panel which shows
40+
what tests would pass or fail if the PR were merged.
3841

39-
40-
When several changesets are pushed in a quick succession in the same
41-
branch, it often happens that a single build is scheduled for all these
42-
changesets.
42+
When several changes are committed in a quick succession in the same
43+
branch, it often happens that only the latest is tested.
4344

4445

4546
Stability

communication.rst

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,32 @@
66
Following Python's Development
77
==============================
88

9-
.. warning:: At present, this is not much modified from the CPython base.
10-
119
Python's development is communicated through a myriad of ways, mostly through
1210
mailing lists, but also other forms.
11+
These are all relevant to Jython (even sometimes the content specific to C),
12+
and Jython has some dedicated channels too.
1313

1414
.. _mailinglists:
1515

16-
Mailing Lists
17-
-------------
16+
Jython Mailing Lists
17+
--------------------
18+
19+
The mailing list for discussion of Jython's development is jython-dev_.
20+
The list is open to the public and the Jython core developers subscribe,
21+
along with others interested in Jython's development.
1822

19-
The primary mailing list for discussion of Jython's development is jython-dev_.
20-
The list is open to the public and all core developers subscribe,
21-
and others interested in Jython's development.
22-
Technical support questions should not be asked here but on jython-users_.
23+
Questions about using Jython should not be asked here but on jython-users_.
2324

2425
Jython-checkins_ sends out an email for every commit to Jython's various
25-
repositories from http://hg.python.org. All core developers
26-
subscribe to this list and are known to reply to these emails to make comments
27-
about various issues they catch in the commit.
26+
repositories from http://hg.python.org.
27+
All core developers subscribe to this list.
2828
There is a mailing list related to issues on the `Jython issue tracker`_.
2929
Subscribe to jython-bugs_ if you want an email for all changes made to any
3030
issue.
3131

32-
Developers working on Jython will be interested in the developement of Python
32+
Python and CPython Mailing Lists
33+
--------------------------------
34+
Developers working on Jython will be interested in the development of Python
3335
(the language) and its reference implementation.
3436

3537
python-dev_ is the primary mailing list for discussions about Python's

fixingissues.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,6 @@ discussion to help bring it to a close). Regardless of why the issue is open,
2727
you can also always provide useful comments if you do attempt a fix, successful
2828
or not.
2929

30-
.. _"easy" issues: https://bugs.python.org/issue?status=1&@sort=-activity&@dispname=Easy%20issues&@startwith=0&@filter=&@group=priority&@columns=id,activity,title,creator,status&keywords=6&@action=search&@pagesize=50
30+
.. _"easy" issues: https://bugs.jython.org/issue?status=1&@sort=-activity&@dispname=Easy%20issues&@startwith=0&@filter=&@group=priority&@columns=id,activity,title,creator,status&keywords=6&@action=search&@pagesize=50
3131

3232
.. TODO: add something about no active core developer for the area?

gitbootcamp.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,7 @@ Enabling ``autocrlf`` on Windows
8383

8484
The *autocrlf* option will fix automatically any Windows-specific line endings.
8585
This should be enabled on Windows, since the public repository has a hook which
86-
will reject all changesets having the wrong line endings.
87-
:::::::::::::::::::::::::::::::::::::::::::::::::::::::::
86+
will reject all changesets having the wrong line endings::
8887

8988
$ git config --global core.autocrlf input
9089

help.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@
66
Where to Get Help
77
=================
88

9-
.. warning:: At present, this is not much modified from the CPython base.
10-
119
If you are working on Jython it is very possible you will come across an issue
1210
where you need some assistance to solve it (this happens to core developers
1311
all the time).
@@ -37,15 +35,17 @@ If you are interested in improving Jython and contributing to its development,
3735
but don’t yet feel entirely comfortable with the public channels mentioned
3836
above, `Python Mentors`_ are here to help you. The Python Mentors list was
3937
originally created to help with CPython development, but since Jython shares
40-
most of the same infrastructure (Jython is hosted on python.org a Mercurial
41-
repository and a Roundup issue tracker) it is a good place to find help for
38+
most of the same infrastructure (Jython's repository is at hg.python.org
39+
and uses a related Roundup issue tracker) it is a good place to find help for
4240
Jython as well. Python is fortunate to have a community of volunteer core
4341
developers willing to mentor anyone wishing to contribute code, work on bug
4442
fixes or improve documentation. Everyone is welcomed and encouraged to
4543
contribute.
4644

4745
.. _Python Mentors: http://pythonmentors.com
4846

47+
.. FIXME: would Python Mentors count themselves a good place to go fro Jython?
48+
4949
Mailing Lists
5050
-------------
5151

index.rst

Lines changed: 23 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
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.
76
87
========================
98
Jython Developer's Guide
@@ -16,14 +15,13 @@ bear in mind that:
1615

1716
* The CPython process is PR-based on GitHub and this guide anticipates our
1817
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.
2220
* The adaptation is imperfect: parts of the guide will say (or mean) CPython.
2321

2422
This guide is :ref:`maintained <helping-with-the-developers-guide>` by the same
2523
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!
2725

2826

2927
Quick Reference
@@ -32,11 +30,11 @@ Quick Reference
3230
Mercurial
3331
^^^^^^^^^
3432

35-
1. :ref:`Get the source code <checkout>`::
33+
1. :ref:`Get the source code <checkout-jy>`::
3634

3735
hg clone http://hg.python.org/jython
3836

39-
2. :ref:`Build Jython <compiling>`::
37+
2. :ref:`Build Jython <compiling-jy>`::
4038

4139
ant
4240

@@ -178,11 +176,12 @@ Contributing
178176
------------
179177

180178
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
182179
developer's guide. If you still have questions after reviewing the material in
183180
this guide, then the `Python Mentors`_ group is available to help guide new
184181
contributors through the process.
185182

183+
.. FIXME: do Python Mentors help Jython contributors with process?
184+
186185
A number of individuals from the Python community have contributed to a series
187186
of excellent guides at `Open Source Guides <https://opensource.guide/>`_.
188187

@@ -193,17 +192,17 @@ Core developers and contributors alike will find the following guides useful:
193192

194193
Guide for contributing to Jython:
195194

196-
* :doc:`setup`
195+
* :doc:`setup_jy`
197196
* :doc:`help`
198-
* :doc:`pullrequest`
199-
* :doc:`patch_hg_jy`
197+
* :doc:`patch_hg_jy` (existing process)
198+
* :doc:`pullrequest` (partly usable future process)
200199
* :doc:`runtests`
201200
* Beginner tasks to become familiar with the development process
202201
* :doc:`docquality`
203202
* :doc:`coverage`
204203
* Advanced tasks for once you are comfortable
205204
* :doc:`silencewarnings`
206-
* Fixing issues found by the :doc:`buildbots <buildbots>`
205+
* Fixing issues found by the :doc:`buildbots <buildbots_jy>`
207206
* :doc:`fixingissues`
208207
* :ref:`tracker` and :ref:`helptriage`
209208
* :doc:`triaging`
@@ -213,8 +212,7 @@ Guide for contributing to Jython:
213212
* :doc:`committing`
214213
* :doc:`committing_hg_jy`
215214
* :doc:`devcycle`
216-
* :doc:`buildbots`
217-
* :doc:`coverity`
215+
* :doc:`buildbots_jy`
218216
* :doc:`gitbootcamp`
219217

220218
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:
245243
Other Interpreter Implementations
246244
---------------------------------
247245

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,
250248
the interpreter core is written in Java and integrates most easily with the Java
251249
SE and EE ecosystems).
252250

@@ -276,8 +274,8 @@ Key Resources
276274
tracker for the issue tracker)
277275
* :doc:`experts`
278276
* 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/>`_
281279

282280
* PEPs_ (Python Enhancement Proposals)
283281
* :doc:`help`
@@ -294,7 +292,6 @@ Additional Resources
294292
* :doc:`grammar_jy`
295293
* :doc:`compiler_jy`
296294
* Tool support
297-
* Various tools with configuration files as found in the `Misc directory`_
298295
* Information about editors and their configurations can be found in the
299296
`wiki <https://wiki.python.org/moin/PythonEditors>`_
300297

@@ -350,8 +347,8 @@ Specific to CPython_
350347
--------------------
351348

352349
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.
355352

356353
.. We're also keeping these files for the technical reason that changes from
357354
CPython upstream can only be merged if these CPython files continue to exist.

patch_hg_jy.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,9 @@ When creating a patch for submission, there are several things that you should
5454
do to help ensure that your patch is accepted.
5555

5656
First, make sure to follow Python's style guidelines. For Python code you
57-
should follow :PEP:`8`, and for Java code you should follow the
58-
`Style Guide for Java code`_. If you have one or two discrepancies those can be
57+
should follow :PEP:`8`, and for Java code you should follow Jython's
58+
`Java coding standard <https://wiki.python.org/jython/CodingStandards>`_.
59+
If you have one or two discrepancies those can be
5960
fixed by the core developer who commits your patch. But if you have systematic
6061
deviations from the style guides your patch will be put on hold until you fix
6162
the formatting issues.

runtests.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ Running & Writing Tests
1212
.. note::
1313

1414
This document assumes you are working from an
15-
:ref:`in-development <indevbranch>` checkout of Python. If you
1615
:ref:`in-development <indevbranch>` checkout of Jython. If you
1716
are not then some things presented here may not work as they may depend
1817
on new features not available in earlier versions of Jython.

0 commit comments

Comments
 (0)