Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation]: Add information that building on Windows is not supported #3416

Closed
wants to merge 2 commits into from
Closed

[Documentation]: Add information that building on Windows is not supported #3416

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6bf2487
build.md: Fix spelling
ColorfulRhino Feb 16, 2024
ccb06e9
build.md: Add info on building on Windows
ColorfulRhino Feb 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions docs/developer_guide/build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@

## Prerequisites

HIP code can be developed either on AMD ROCm platform using HIP-Clang compiler, or a CUDA platform with nvcc installed.
Before build and run HIP, make sure drivers and pre-build packages are installed properly on the platform.
HIP code can be developed on Linux, either on AMD ROCm platform using HIP-Clang compiler, or a CUDA platform with nvcc installed.
Before building and running HIP, make sure drivers and pre-built packages are installed properly on the platform.

Building on Windows is not supported, since not all source code required to build for Windows from source is available under a permissive open source license. AMD only provides Windows build instructions for projects that can be built from source on Windows using a toolchain that has closed source build prerequisites. The ROCm manifest file is not valid for Windows. AMD does not release a manifest or tag our components in Windows. Corresponding Linux tags can be used to build on Windows. See https://rocm.docs.amd.com/projects/install-on-windows/en/develop/conceptual/release-versioning.html#windows-builds-from-source

### AMD platform
Install ROCm packages or pre-built binary packages using the package manager. Refer to the ROCm Installation Guide at https://rocm.docs.amd.com for more information on installing ROCm.
Expand All @@ -18,11 +20,11 @@ sudo apt-get install -y libelf-dev

### NVIDIA platform

Install Nvidia driver and pre-build packages (see HIP Installation Guide at https://docs.amd.com/ for the release)
Install Nvidia driver and pre-built packages (see HIP Installation Guide at https://docs.amd.com/ for the release)

### Branch of repository

Before get HIP source code, set the expected branch of repository at the variable `ROCM_BRANCH`.
Before getting HIP source code, set the expected branch of repository at the variable `ROCM_BRANCH`.
For example, for ROCm 6.1 release branch, set
```shell
export ROCM_BRANCH=rocm-6.1.x
Expand Down Expand Up @@ -129,7 +131,7 @@ hip_prof_gen.py -v -p -t --priv <hip>/include/hip/hip_runtime_api.h \

#### Build HIP tests

HIP catch tests, with the newly architectured Catch2, are officially separated from the HIP project. The HIP catch tests are moved to the HIP tests repository and can be built using the instructions in the following sections.
HIP catch tests, with the newly architectured Catch2, are officially separated from the HIP project. The HIP catch tests are moved to the HIP tests repository and can be built using the instructions in the following sections.

##### Get HIP tests source code

Expand All @@ -151,7 +153,7 @@ Note that when using ctest, you can use different ctest options, for example, to
```
ctest -R hipMemset
```
Use the below option will print test failures for failed tests,
Using the below option will print test failures for failed tests,
```
ctest --output-on-failure
```
Expand Down