From bfc4c466c2cb816156a524718b6f6cd7f7c30eec Mon Sep 17 00:00:00 2001 From: Nicolas Miller Date: Fri, 21 Mar 2025 10:50:08 +0000 Subject: [PATCH] [SYCL][Doc] Update GetStartedGuide pre-requisiste This patch reformats the pre-requisites in a table (doesn't look great in the markdown, but looks good when generated). It also updates the required versions for CMake and Python to link to the versions required by LLVM. For CMake we were already documenting the same version as LLVM. For Python we didn't document any minimum version, but we extensively use LLVM scripts like `lit`, so we really should be aligned with it. There's a few requirements for which we don't have minimum versions, but we can update that if we ever run into issues with them. --- sycl/doc/GetStartedGuide.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/sycl/doc/GetStartedGuide.md b/sycl/doc/GetStartedGuide.md index 6b22243c62d42..83cd39a114445 100644 --- a/sycl/doc/GetStartedGuide.md +++ b/sycl/doc/GetStartedGuide.md @@ -39,15 +39,14 @@ and a wide range of compute accelerators such as GPU and FPGA. ## Prerequisites -* `git` - [Download](https://git-scm.com/downloads) -* `cmake` version 3.20 or later - [Download](http://www.cmake.org/download/) -* `python` - [Download](https://www.python.org/downloads/) -* `ninja` - -[Download](https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages) -* `hwloc` version 2.3 or later (Linux only) - * libhwloc-dev or hwloc-devel package on linux -* C++ compiler - * See LLVM's [host compiler toolchain requirements](https://github.com/intel/llvm/blob/sycl/llvm/docs/GettingStarted.rst#host-c-toolchain-both-compiler-and-standard-library) +| Software | Version | +| --- | --- | +| [Git](https://git-scm.com/downloads) | | +| [CMake](http://www.cmake.org/download/) | [See LLVM](https://github.com/intel/llvm/blob/sycl/llvm/docs/GettingStarted.rst#software) | +| [Python](https://www.python.org/downloads/) | [See LLVM](https://github.com/intel/llvm/blob/sycl/llvm/docs/GettingStarted.rst#software) | +| [Ninja](https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages) | | +| `hwloc` | >= 2.3 (Linux only, `libhwloc-dev` or `hwloc-devel`) | +| C++ compiler | [See LLVM](https://github.com/intel/llvm/blob/sycl/llvm/docs/GettingStarted.rst#host-c-toolchain-both-compiler-and-standard-library) | Alternatively, you can create a Docker image that has everything you need for building pre-installed using the [Ubuntu 24.04 build Dockerfile](https://github.com/intel/llvm/blob/sycl/devops/containers/ubuntu2404_build.Dockerfile).