Skip to content

Order of installs for Windows is not specified #286

@KimTheLearner

Description

@KimTheLearner

Issue Description

The Traditional Installation instructions for Windows on Getting Started do not specify the order of installs.

In my install, for various reasons, I chose to do the Traditional Install, even though I was installing 5.6.1. In that section there is no explicit step to install Swift after the dependencies, but under "Traditional", in the paragraph starting "Swift has been tested with VS 2019", the Download section was referenced before the big box describing the VS components. Because of that, with no other explicit ordering in the instructions, I installed Swift first, then proceeded to install the dependencies. This led to many problems.

Later I noticed that Swift should be installed as the last step. For example, in section "On Windows > Install using Scoop", installing Swift clearly follows installing the dependencies. And similarly, on page pwsacademy swift-setup, it says to install Swift after the dependencies.

Requested Change

This is for page Getting Started. Assuming that you will be keeping the Traditional Instructions for some time to come...

1. In section: Installing Swift > On Windows > Installation Instructions > Traditional Installation:

change this:
Swift has been tested with Visual Studio 2019. You will need to install Visual Studio with the following components. <<The installer for Swift is available in the Download section. The toolchain on Windows is installed to %SystemDrive%\Library\Developer\Toolchains.>>

to this:

Swift has been tested with Visual Studio 2019. You will need to install Visual Studio with the following components.

.
2. Then just below, insert the following, just above 'Support Files', in order to place it right at the spot you need it (these details are akin to the macOS notes above):

Next install Swift. The installer for Swift is available in the Download section.

The toolchain on Windows is installed to %SystemDrive%\Library\Developer\Toolchains.

This install creates the env var:
SDKROOT=C:\Library\Developer\Platforms\Windows.platform\Developer\SDKs\Windows.sdk

and it adds three directories to the end of the PATH env var:
C:\Library\Developer\Toolchains\unknown-Asserts-development.xctoolchain\usr\bin
C:\Library\Swift-development\bin
C:\Library\icu-69.1\usr\bin

.
3. In Support Files, change this sentence:

You must use the x64 Native Tools for VS2019 Command Prompt to run the following steps.

to this:

You must use the x64 Native Tools for VS2019 Command Prompt, run as Administrator, to run the following steps.

Related Issue

This was originally submitted as 58451.

Environment details

Desktop

  • OS: Windows 10 desktop computer
  • Version: Swift 5.6.1

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions