From 2b31d38084416a9ef473f28e21e266ced04e6610 Mon Sep 17 00:00:00 2001 From: Egor Savkin Date: Mon, 20 May 2024 10:21:26 +0800 Subject: [PATCH] docs: update MSYS2 to include offline installer and openocd included by default docs: update MSYS2 mingw -> clang Signed-off-by: Egor Savkin --- doc/manual/installing.rst | 13 +++++++------ doc/manual/list_of_ndsps.rst | 2 +- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/doc/manual/installing.rst b/doc/manual/installing.rst index c1615eda3..86e42ccd4 100644 --- a/doc/manual/installing.rst +++ b/doc/manual/installing.rst @@ -154,16 +154,19 @@ This will set your user as a trusted user, allowing the use of any untrusted sub Installing via MSYS2 (Windows) ------------------------------ -Install `MSYS2 `_, then edit ``C:\MINGW64\etc\pacman.conf`` and add at the end: :: +We recommend using our `offline installer `_, which contains all the necessary packages and no additional configuration is needed. +After installation, launch ``MSYS2 with ARTIQ`` from the Windows Start menu. + +Alternatively, you may install `MSYS2 `_, then edit ``C:\MINGW64\etc\pacman.conf`` and add at the end: :: [artiq] SigLevel = Optional TrustAll Server = https://msys2.m-labs.hk/artiq-beta -Launch ``MSYS2 MINGW64`` from the Windows Start menu to open the MSYS2 shell, and enter the following commands: :: +Launch ``MSYS2 CLANG64`` from the Windows Start menu to open the MSYS2 shell, and enter the following commands: :: pacman -Syy - pacman -S mingw-w64-x86_64-artiq + pacman -S mingw-w64-clang-x86_64-artiq If your favorite package is not available with MSYS2, contact us using the helpdesk@ email. @@ -259,9 +262,7 @@ OpenOCD can be used to write the binary images into the core device FPGA board's With Nix, add ``aqmain.openocd-bscanspi`` to the shell packages. Be careful not to add ``pkgs.openocd`` instead - this would install OpenOCD from the NixOS package collection, which does not support ARTIQ boards. -With MSYS2, install ``openocd`` and ``bscan-spi-bitstreams`` as follows:: - - pacman -S mingw-w64-x86_64-openocd mingw-w64-x86_64-bscan-spi-bitstreams +With MSYS2, ``openocd`` and ``bscan-spi-bitstreams`` are included with ``artiq`` by default. With Conda, install ``openocd`` as follows:: diff --git a/doc/manual/list_of_ndsps.rst b/doc/manual/list_of_ndsps.rst index 65953485c..03d3a1b3d 100644 --- a/doc/manual/list_of_ndsps.rst +++ b/doc/manual/list_of_ndsps.rst @@ -29,4 +29,4 @@ The following network device support packages are available for ARTIQ. If you wo | InfluxDB database | Not available | Not available | `HTML `_ | https://gitlab.com/charlesbaynham/artiq_influx_generic | +---------------------------------+-----------------------------------+----------------------------------+-----------------------------------------------------------------------------------------------------+--------------------------------------------------------+ -MSYS2 packages all start with the ``mingw-w64-x86_64-`` prefix. +MSYS2 packages all start with the ``mingw-w64-clang-x86_64-`` prefix.