From e8b9fcf0bbc50e2c211c93d191e9ee007e1f3cad Mon Sep 17 00:00:00 2001 From: David Nadlinger Date: Mon, 23 Dec 2019 00:50:03 +0000 Subject: [PATCH] doc/manual/developing: Clarify Nix PYTHONPATH usage PYTHONPATH should still contain all the other directories (obvious once you've made that mistake once, of course). --- doc/manual/developing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/manual/developing.rst b/doc/manual/developing.rst index a147a25eb..7dcde3822 100644 --- a/doc/manual/developing.rst +++ b/doc/manual/developing.rst @@ -22,4 +22,4 @@ ARTIQ itself does not depend on Nix, and it is also possible to compile everythi * If you are modifying a dependency of ARTIQ, in addition to updating the relevant part of ``nix-scripts``, rebuild and upload the corresponding Conda packages manually, and update their version numbers in ``conda-artiq.nix``. For Conda, only the main ARTIQ package and the board packages are handled automatically on Hydra. .. warning:: - Nix will make a read-only copy of the ARTIQ source to use in the shell environment. Therefore, any modifications that you make to the source after the shell is started will not be taken into account. A solution applicable to ARTIQ (and several other Python packages such as Migen and MiSoC) is to set the ``PYTHONPATH`` environment variable in the shell to the root of the ARTIQ source. If you want this to be done by default, edit ``profile`` in ``artiq-dev.nix``. + Nix will make a read-only copy of the ARTIQ source to use in the shell environment. Therefore, any modifications that you make to the source after the shell is started will not be taken into account. A solution applicable to ARTIQ (and several other Python packages such as Migen and MiSoC) is to prepend the ARTIQ source directory to the ``PYTHONPATH`` environment variable after entering the shell. If you want this to be done by default, edit ``profile`` in ``artiq-dev.nix``.