Ensure links are appropriate to Jython (:ref: and :doc:).

jeff5 · jeff5 · commit fb6988e292d6 · 2017-10-12T08:21:10.000+01:00
Check and fix hyperlinks (all the :ref: and :doc: formulae) so the
reader is not carried into material specific to CPython while
navigating.
diff --git a/committing.rst b/committing.rst
@@ -53,7 +53,7 @@ passes before merging any code changes.
    or library modules.
 
    Running the entire test suite doesn't guarantee that the changes
-   will pass the :ref:`continuous integration <buildbots>` tests, as those
+   will pass the :ref:`continuous integration <buildbots-jy>` tests, as those
    will exercise more possibilities still (such as different platforms or
    build options).  But it will at least catch non-build specific,
    non-platform specific errors, therefore minimizing the chance for
diff --git a/committing_hg_jy.rst b/committing_hg_jy.rst
@@ -1,3 +1,6 @@
+.. Jython and Mercurial-specific companion to committing.rst,
+   needed while we use Mercurial.
+
 .. _committing-hg-jy:
 
 Committing and Pushing Changes (Mercurial)
@@ -31,7 +34,7 @@ passes before pushing any code changes.
    or library modules.
 
    Running the entire test suite doesn't guarantee that your changes
-   will pass the :ref:`continuous integration <buildbots>` tests, as those
+   will pass the :ref:`continuous integration <buildbots-jy>` tests, as those
    will exercise more possibilities still (such as different platforms or
    build options).  But it will at least catch non-build specific,
    non-platform specific errors, therefore minimizing the chance for
@@ -321,7 +324,7 @@ clone/directory, but, on the other hand, it requires you to recompile Python
 every time you need to switch branch.  For this reason, this approach is not
 suggested to core developers, but it's usually suitable for contributors.
 
-See :ref:`checkout` to find information about cloning and switching branches.
+See :ref:`checkout-jy` to find information about cloning and switching branches.
 
 .. _multiple-clones:
 
@@ -340,7 +343,7 @@ enabled by adding the following lines to your ``~/.hgrc``::
    [extensions]
    share =
 
-Once you have :ref:`cloned the hg.python.org/jython repository <checkout>`
+Once you have :ref:`cloned the hg.python.org/jython repository <checkout-jy>`
 you can create the other shared clones using::
 
    $ hg share jython 2.7  # create a new shared clone
diff --git a/coverage.rst b/coverage.rst
@@ -19,6 +19,10 @@ but the strategy requires they be contributes upstream to CPython.
    validated in a Jython context. The section on C is not relevant to Java,
    and we need to write one that is.
 
+.. In the 2017 revision, scoring for C-specific content suggested we create a
+   coverage_jy companion file.
+
+
 Python development follows a practice that all semantic changes and additions
 to the language and :abbr:`stdlib (standard library)` are accompanied by
 appropriate unit tests. Unfortunately Python was in existence for a long time
@@ -258,9 +262,9 @@ times.
 Filing the Issue
 """"""""""""""""
 Once you have increased coverage, you need to create an issue on the
-`Jython issue tracker`_ and submit a :doc:`pull request <pullrequest>`. On the
-issue set the "Components" to "Test" and "Versions" to the version of Jython you
-worked on (i.e., the in-development version).
+`Jython issue tracker`_ and submit a :doc:`pull request or patch <pullrequest>`.
+On the issue set the "Components" to "Test" and "Versions" to the version of
+Jython you worked on (i.e., the in-development version).
 
 .. _Jython issue tracker: http://bugs.jython.org
 
diff --git a/devcycle.rst b/devcycle.rst
@@ -54,7 +54,7 @@ under active development for all kinds of changes: new features, semantic
 changes, performance improvements, bug fixes.
 
 In a process based on Mercurial, the branch is identifies as ``default``.
-It is the branch :ref:`checked out <checkout>` by default by Mercurial.
+It is the branch :ref:`checked out <checkout-jy>` by default by Mercurial.
 
 At some point during the life-cycle of a release, a
 new :ref:`maintenance branch <maintbranch>` is created to host all bug fixing
diff --git a/docquality.rst b/docquality.rst
@@ -109,6 +109,6 @@ Changes to the devguide are normally published within a day, on a schedule
 that may be different from the main documentation.
 
 .. _separate repository:
-.. _devguide repo: https://github.com/python/devguide
-.. _the GitHub tracker: https://github.com/python/devguide/issues
+.. _devguide repo: https://github.com/jython/devguide
+.. _the GitHub tracker: https://github.com/jython/devguide/issues
 .. _Sphinx: http://www.sphinx-doc.org/
diff --git a/documenting.rst b/documenting.rst
@@ -8,6 +8,8 @@ Documenting Python
 ==================
 
 .. warning:: At present, this is not much modified from the CPython base.
+   But that's probably ok, as Jython documentation is largely from CPython,
+   and the section is predominantly a guide to ReStructuredText.
 
 The Python language has a substantial body of documentation, much of it
 contributed by various authors. The markup used for the Python documentation is
diff --git a/exploring_jy.rst b/exploring_jy.rst
@@ -12,7 +12,7 @@ This is a quick guide for people who are interested in learning more about
 Jython's internals.
 It provides a summary of the source code structure
 and contains references to resources providing a more in-depth view.
-Much may al;so be learned by :doc:`exploring CPython's internals <exploring>`.
+Much may also be learned by :doc:`exploring CPython's internals <exploring>`.
 
 
 Jython Source Code Layout
diff --git a/index.rst b/index.rst
@@ -49,15 +49,15 @@ GitHub
 ^^^^^^
 .. highlight:: bash
 
-Here are the basic steps needed to get :ref:`set up <setup>` and contribute a
+Here are the basic steps needed to get :ref:`set up <setup-jy>` and contribute a
 patch. This is meant as a checklist, once you know the basics. For complete
-instructions please see the :ref:`setup guide <setup>`.
+instructions please see the :ref:`setup guide <setup-jy>`.
 
-1. Install and set up :ref:`Git <vcsetup>` and other dependencies
-   (see the :ref:`Get Setup <setup>` page for detailed information).
+1. Install and set up :ref:`Git <vcsetup-jy>` and other dependencies
+   (see the :ref:`Get Setup <setup-jy>` page for detailed information).
 
 2. Fork `the Jython repository <https://github.com/jython/jython>`_
-   to your GitHub account and :ref:`get the source code <checkout>` using::
+   to your GitHub account and :ref:`get the source code <checkout-jy>` using::
 
       git clone https://github.com/<your_username>/jython
 
@@ -67,23 +67,21 @@ instructions please see the :ref:`setup guide <setup>`.
 
    issued in the base check-out directory.
    The built application will be in subdirectory ``dist``.
-   See also :ref:`more detailed instructions <compiling>`,
-   :ref:`how to build dependencies <build-dependencies>`, and the
-   plaform-specific pages for :ref:`UNIX <unix-compiling>`,
-   and :ref:`Windows <windows-compiling>`.
+   See also :ref:`more detailed instructions <compiling-jy>`,
+   and :ref:`how to build dependencies <build-dependencies-jy>`.
 
 4. :doc:`Run the tests <runtests>`::
 
       dist/bin/jython -m test -e
 
-   With Jython 2.7, replace ``test`` with ``test.regrtest``.
+   (for Jython 3). With Jython 2.7, replace ``test`` with ``test.regrtest``.
 
 5. Create a new branch where your work for the issue will go, e.g.::
 
       git checkout -b fix-issue-12345 master
 
    If an issue does not already exist, please `create it
-   <https://bugs.python.org/>`_.  Trivial issues (e.g. typo fixes) do not
+   <https://bugs.jpython.org/>`_.  Trivial issues (e.g. typo fixes) do not
    require any issue to be created.
 
 6. Once you fixed the issue, run the tests, and if
@@ -205,12 +203,12 @@ Guide for contributing to Jython:
     * Fixing issues found by the :doc:`buildbots <buildbots_jy>`
     * :doc:`fixingissues`
 * :ref:`tracker` and :ref:`helptriage`
-    * :doc:`triaging`
+    * :doc:`triaging_jy`
     * :doc:`experts`
 * :doc:`communication`
 * :doc:`coredev`
-    * :doc:`committing`
     * :doc:`committing_hg_jy`
+    * :doc:`committing`
     * :doc:`devcycle`
     * :doc:`buildbots_jy`
 * :doc:`gitbootcamp`
diff --git a/pullrequest.rst b/pullrequest.rst
@@ -7,6 +7,10 @@ Lifecycle of a Pull Request
 ===========================
 
 .. warning:: At present, this is not much modified from the CPython base.
+   This describes the PR-based process used by CPython on GitHub, which works
+   for Jython in a limited form. (You can asubmit a PR, but we export a patch.)
+   The traditional Jython process is based on
+   :doc:`patches submitted to the tracker <patch_hg_jy>`.
 
 Creating
 --------
@@ -109,14 +113,14 @@ Here is a quick overview of how you can contribute to CPython on GitHub:
 #. If an issue doesn't exist, `create an Issue`_ that describes your change.
    Trivial issues (e.g. typo fixes) do not require any issue to be created.
 
-#. :ref:`Get started <setup>` and set up your system
+#. :ref:`Get started <setup-jy>` and set up your system
 
-#. :ref:`Fork CPython <fork-cpython>` (using the Fork button in the
+#. :ref:`Fork Jython <fork-jython>` (using the Fork button in the
    upper-right on GitHub)
 
 #. :ref:`Clone your GitHub fork and add an "upstream" remote <clone-your-fork>`
 
-#. :ref:`Build Python <compiling>` on your system
+#. :ref:`Build Jython <compiling-jy>` on your system
 
 #. :ref:`Run tests <runtests>` after you have built Python
 
diff --git a/runtests.rst b/runtests.rst
@@ -102,7 +102,7 @@ be executed on that platform.
 Often, the cause is that an optional module hasn't been built due to missing
 build dependencies. In these cases, the missing module reported when the test
 is skipped should match one of the modules reported as failing to build when
-:ref:`compiling`.
+:ref:`compiling-jy`.
 
 In other cases, the skip message should provide enough detail to help figure
 out and resolve the cause of the problem (for example, the default security
diff --git a/tracker.rst b/tracker.rst
@@ -50,7 +50,7 @@ Being now logged in, you can submit a bug by clicking on the "Create New" link
 in the sidebar.
 
 The submission form has a number of fields, and they are described in detail
-in the :ref:`triaging` page.  This is a short summary:
+in the :ref:`triaging-jy` page.  This is a short summary:
 
 * in the **Title** field, enter a *very* short description of the problem;
   less than ten words is good;
diff --git a/triaging_jy.rst b/triaging_jy.rst
@@ -2,11 +2,10 @@
 
 .. _triaging-jy:
 
-Triaging an Issue
-=================
+Triaging a Jython Issue
+=======================
 
-.. warning:: At present, this is not much more than a copy of the CPython original
-   with the obviously inapplicable crudely hacked out.
+.. warning:: At present, this is not much more than a copy of the CPython original.
 
 When you have the Developer role on the `issue tracker`_ you are able to triage
 issues directly without any assistance.
