From 63f65b6e5322b2bbc9e59767b24dae9e6f507684 Mon Sep 17 00:00:00 2001 From: Robert Jordens Date: Thu, 7 Dec 2017 12:24:32 +0100 Subject: [PATCH] doc: clean up artiq-dev installation instructions Add a heading to the openocd setup instruction so that it is clearly distinguishable from the openocd installation. Otherwise people "re-install" openocd the wrong way. --- doc/manual/developing.rst | 9 ++++----- doc/manual/installing.rst | 3 +++ 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/doc/manual/developing.rst b/doc/manual/developing.rst index 1372d40c9..d6600d841 100644 --- a/doc/manual/developing.rst +++ b/doc/manual/developing.rst @@ -27,7 +27,7 @@ ARTIQ Anaconda development environment $ git clone --recursive https://github.com/m-labs/artiq ~/artiq-dev/artiq $ cd ~/artiq-dev/artiq - Add ``-b release-X`` to the ``git clone`` command if you are building a stable branch of ARTIQ (the default will fetch the development ``master`` branch). + Add ``-b release-X`` to the ``git clone`` command if you are building a stable branch of ARTIQ. Replace ``X`` with the major release. The default will fetch the development ``master`` branch. 3. :ref:`Install Anaconda or Miniconda ` 4. Create and activate a conda environment named ``artiq-dev`` and install the ``artiq-dev`` package which pulls in all the packages required to develop ARTIQ:: @@ -37,10 +37,9 @@ ARTIQ Anaconda development environment $ pip install -e . 6. :ref:`Install Vivado ` - 7. :ref:`Obtain and install the JTAG SPI flash proxy bitstream ` - 8. :ref:`Configure OpenOCD ` - 9. :ref:`Build target binaries ` - 10. :ref:`Flash target binaries ` + 7. :ref:`Configure OpenOCD ` + 8. :ref:`Build target binaries ` + 9. :ref:`Flash target binaries ` .. _install-from-source: diff --git a/doc/manual/installing.rst b/doc/manual/installing.rst index 651c675ca..e9a82226c 100644 --- a/doc/manual/installing.rst +++ b/doc/manual/installing.rst @@ -112,6 +112,9 @@ The ``artiq`` or ``artiq-dev`` conda packages install ``openocd`` automatically .. _setup-openocd: +Configuring OpenOCD +^^^^^^^^^^^^^^^^^^^ + Some additional steps are necessary to ensure that OpenOCD can communicate with the FPGA board. On Linux, first ensure that the current user belongs to the ``plugdev`` group. If it does not, run ``sudo adduser $USER plugdev`` and relogin. Afterwards::