Skip to content

Latest commit

 

History

History
110 lines (76 loc) · 5.08 KB

windows-instructions.md

File metadata and controls

110 lines (76 loc) · 5.08 KB
Raw

Windows Prerequisites

These instructions will lead you through preparing to build the diagnostics repo on Windows.

Environment

You must install several components to build. These instructions were tested on Windows 7+.

Visual Studio

Visual Studio 2019 installation process:

  • It's recommended to use 'Workloads' installation approach. The following are the minimum requirements:
    • .NET Desktop Development with all default components.
    • Desktop Development with C++ with all default components.
  • To build for Arm32 or Arm64, Make sure that you have the Windows 10 SDK installed (or selected to be installed as part of VS installation). To explicitly install Windows SDK, download it from here: Windows SDK for Windows 10.
    • In addition, ensure you install the ARM tools. In the "Individual components" window, in the "Compilers, build tools, and runtimes" section, check the box for "MSVC v142 - VS 2019 C++ ARM build tools (v14.23)".
    • Also, ensure you install the ARM64 tools. In the "Individual components" window, in the "Compilers, build tools, and runtimes" section, check the box for "MSVC v142 - VS 2019 C++ ARM64 build tools (v14.23)".
  • To build the tests, you will need some additional components:
    • Windows 10 SDK component version 10.0.18362 or newer. This component is installed by default as a part of 'Desktop Development with C++' workload.
    • C++/CLI support for v142 build tools (14.23)

The dotnet/diagnostics repository requires at least Visual Studio 2019 16.3.

Visual Studio Express is not supported.

CMake

This repo build has been validated using CMake 3.15.5

  • Install CMake for Windows.
  • Add its location (e.g. C:\Program Files (x86)\CMake\bin) to the PATH environment variable.
    The installation script has a check box to do this, but you can do it yourself after the fact following the instructions at Adding to the Default PATH variable

Python

Python is used in the build system. We are currently using python 2.7.9, although any recent (2.4+) version of Python should work, including Python 3.

  • Install Python for Windows.
  • Add its location (e.g. C:\Python*) to the PATH environment variable.
    The installation script has a check box to do this, but you can do it yourself after the fact following the instructions at Adding to the Default PATH variable

Git

For actual user operations, it is often more convenient to use the GIT features built into Visual Studio 2015. However the diagnostics repo use the GIT command line utilities directly so you need to install them for these to work properly. You can get it from

  • Install Git For Windows
  • Add its location (e.g. C:\Program Files\Git\cmd) to the PATH environment variable.
    The installation script has a check box to do this, but you can do it yourself after the fact following the instructions at Adding to the Default PATH variable

PowerShell

PowerShell is used in the build system. Ensure that it is accessible via the PATH environment variable. Typically this is %SYSTEMROOT%\System32\WindowsPowerShell\v1.0.

Powershell version must be 3.0 or higher. This should be the case for Windows 8 and later builds.

  • Windows 7 SP1 can install Powershell version 4 here.

Adding to the default PATH variable

The commands above need to be on your command lookup path. Some installers will automatically add them to the path as part of installation, but if not here is how you can do it.

You can of course add a directory to the PATH environment variable with the syntax

    set PATH=%PATH%;DIRECTORY_TO_ADD_TO_PATH

However the change above will only last until the command windows closes. You can make your change to the PATH variable persistent by going to Control Panel -> System And Security -> System -> Advanced system settings -> Environment Variables, and select the 'Path' variable in the 'System variables' (if you want to change it for all users) or 'User variables' (if you only want to change it for the current user). Simply edit the PATH variable's value and add the directory (with a semicolon separator).

Cross Compilation for ARM on Windows

Building ARM for Windows can be done using cross compilation. Make sure the above requirements for building for arm32 are installed.

C:\diagnostics> build.cmd -architecture arm

Building

To build under Windows, run build.cmd from the root of the repository:

build.cmd

[Lots of build spew]

BUILD: Repo sucessfully built.
BUILD: Product binaries are available at c:\git\diagnostics\artifacts\Debug\bin\Windows_NT.x64

To build for x86:

build.cmd -architecture x86

To test the resulting SOS:

test.cmd