You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[DOC] Clean up Markdown and fix broken links (#8919)
There are two initial commits in this PR:
1. Make the document more consistent and readable by fixing MarkdownLint
violations.
2. Fix broken links (didn't work in the [HTML
page](https://intel.github.io/llvm-docs/GetStartedGuide.html#getting-started-with-oneapi-dpc)
derived from this).
⚠️ I am assuming that the problematic published HTML page is indeed
derived from this Markdown document.
@@ -51,7 +52,7 @@ and a wide range of compute accelerators such as GPU and FPGA.
51
52
Alternatively, you can use a Docker image that has everything you need for building
52
53
pre-installed:
53
54
54
-
```
55
+
```sh
55
56
docker run --name sycl_build -it -v /local/workspace/dir/:/src ghcr.io/intel/llvm/ubuntu2004_base /bin/bash
56
57
```
57
58
@@ -122,7 +123,7 @@ flags can be found by launching the script with `--help`):
122
123
*`--cuda` -> use the cuda backend (see [Nvidia CUDA](#build-dpc-toolchain-with-support-for-nvidia-cuda))
123
124
*`--hip` -> use the HIP backend (see [HIP](#build-dpc-toolchain-with-support-for-hip-amd))
124
125
*`--hip-platform` -> select the platform used by the hip backend, `AMD` or `NVIDIA` (see [HIP AMD](#build-dpc-toolchain-with-support-for-hip-amd) or see [HIP NVIDIA](#build-dpc-toolchain-with-support-for-hip-nvidia))
125
-
*`--enable-esimd-emulator` -> enable ESIMD CPU emulation (see [ESIMD CPU emulation](#build-dpc-toolchain-with-support-for-esimd-cpu))
126
+
*`--enable-esimd-emulator` -> enable ESIMD CPU emulation (see [ESIMD CPU emulation](#build-dpc-toolchain-with-support-for-esimd-cpu-emulation))
126
127
*`--enable-all-llvm-targets` -> build compiler (but not a runtime) with all
127
128
supported targets
128
129
*`--shared-libs` -> Build shared libraries
@@ -152,23 +153,25 @@ should be used.
152
153
153
154
**Linux**:
154
155
155
-
```
156
+
```sh
156
157
-DSYCL_USE_LIBCXX=ON \
157
158
-DSYCL_LIBCXX_INCLUDE_PATH=<path to libc++ headers> \
158
159
-DSYCL_LIBCXX_LIBRARY_PATH=<path to libc++ and libc++abi libraries>
@@ -200,15 +203,15 @@ The CUDA backend should work on Windows or Linux operating systems with any
200
203
GPU compatible with SM 50 or above. The default SM for the NVIDIA CUDA backend
201
204
is 5.0. Users can specify lower values, but some features may not be supported.
202
205
203
-
**Non-standard CUDA location**
206
+
**Non-standard CUDA location**:
204
207
205
208
If the CUDA toolkit is installed in a non-default location on your system, two considerations must be made.
206
209
207
210
Firstly, **do not** add the toolkit to your standard environment variables (`PATH`, `LD_LIBRARY_PATH`), as to do so will create conflicts with OpenCL headers.
208
211
209
212
Secondly, set the `CUDA_LIB_PATH` environment variable and pass the CMake variable `CUDA_TOOLKIT_ROOT_DIR` as follows:
0 commit comments