@@ -126,12 +126,10 @@ Finally, a PR to the package-template repostory,
126126affiliated package template to use the machinery availabe in ``astropy_helpers ``
127127rather than depending on ``astropy `` itself.
128128
129- **TODO **: Currently the astropy_helpers submodule in #1563 references `my fork
130- of astropy_helpers <https://github.com/embray/astropy_helpers> `_ rather than
131- the main astropy_helpers repository. Once the initial version of
132- astropy_helpers is in place the ``.gitmodules `` file in #1563 should be updated
133- to use the URL of the main astropy_helpers repository. This should happen only
134- once this APE is given final approval.
129+ These PRs have already been merged into the master branches of their respective
130+ repositories. It was determined that prior to final acceptance of this APE we
131+ should see how the proposed implementation works in pracice so that any tweaks
132+ can be made if necessary.
135133
136134
137135Implementation
@@ -261,7 +259,9 @@ See `astropy_helpers bootstrap script`_ below.
261259
262260By automating the process of updating submodules, most Astropy developers need
263261not even be aware of the use of submodules unless they are actively involved
264- in updating astropy_helpers.
262+ in updating astropy_helpers. When testing changes to astropy_helpers against
263+ Astropy itself it may be useful to disable the automatic git submodule updates.
264+ Options for this are discussed later in this APE.
265265
266266
267267astropy_helpers via setup_requires
@@ -365,7 +365,10 @@ does not include ``astropy_helpers``, it uses the ``setup_requires`` mechanism
365365to install astropy-helpers from PyPI as explained in the previous section.
366366
367367The sample implementation of ``use_astropy_helpers() `` supports several
368- optional arguments that allow package developers to control its behavior:
368+ optional arguments that allow package developers to control its behavior. It
369+ should be clarified that defaults for all of these arguments can be provided as
370+ options in the ``setup.cfg `` file under the ``[ah_bootstrap] `` section, using
371+ the same names:
369372
370373* ``path ``: By default ``'astropy_helpers' ``, this is the path (relative to the
371374 to ``setup.py ``) of the astropy_helpers Git submodule if it exists.
@@ -382,17 +385,24 @@ optional arguments that allow package developers to control its behavior:
382385
383386* ``use_git ``: Set to ``False `` to disable all use of git commands by
384387 ``ah_bootstrap ``. This effectively disables support for submodule
385- initialization/updates, and is mostly useful for testing.
388+ initialization/updates, and is mostly useful for testing. For example, when
389+ testing a new astropy_helpers version in the context of the Astropy
390+ repository, add this to setup.cfg
386391
387392* ``auto_upgrade ``: If set to ``False `` disables checking on PyPI for newer
388393 versions of astropy-helpers before using any already available versions. By
389394 default the auto-upgrade feature is enabled.
390395
391- Finally, although not an option to ``use_astropy_helpers() ``, the
392- ``ah_bootstrap `` module also recognizes a ``--offline `` command-line argument
393- when running ``setup.py ``. This disables all features that try to access the
394- internet. This may be useful for offline installations, so that the process
395- does not hang while trying to connect to the internet.
396+ Although not an option to ``use_astropy_helpers() ``, the ``ah_bootstrap ``
397+ module also recognizes a ``--offline `` command-line argument when running
398+ ``setup.py ``. This disables all features that try to access the internet.
399+ This may be useful for offline installations, so that the process does not hang
400+ while trying to connect to the internet.
401+
402+ Similarly, one may provide a ``--no-git `` command-line argument that disables
403+ all calls to git by the bootstrap script. As this will prevent running ``git
404+ submodule update ``, it is very useful for testing changes to astropy_helpers
405+ against Astropy or another affiliated package that uses it.
396406
397407It should be noted that if all methods of bootstrapping astropy_helpers fail
398408it is generally not possible to continue the ``setup.py `` script. In this
0 commit comments