Skip to content

Commit 290a96a

Browse files
AlexeySachkovAlexeySotkin
authored andcommitted
[NFC] Cleanup README
- Wrapped long lines - Replaced 'common clang' -> 'opencl-clang' - Added `bash` to code blocks to enable code highlighting Signed-off-by: Alexey Sachkov <[email protected]>
1 parent 5a3aa8b commit 290a96a

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[![Build Status](https://travis-ci.com/intel/opencl-clang.svg?branch=master)](https://travis-ci.com/intel/opencl-clang)
22

3-
Common clang is a thin wrapper library around clang. Common clang has
3+
opencl-clang is a thin wrapper library around clang. The library has
44
OpenCL-oriented API and is capable to compile OpenCL C kernels to SPIR-V
55
modules.
66

@@ -48,15 +48,15 @@ For sanity check of the build please run `make check-clang` and
4848

4949
### Out-of-tree build
5050

51-
To build Common clang as a standalone project, you need to obtain pre-built LLVM
51+
To build opencl-clang as a standalone project, you need to obtain pre-built LLVM
5252
and SPIR-V Translator libraries. **Note:** currently this kind of build is
5353
supported on Linux only.
5454

5555
Integration with pre-built LLVM is done using standard `find_package` way as
5656
documented in [Embedding LLVM in your project](https://llvm.org/docs/CMake.html#embedding-llvm-in-your-project).
5757

5858
Commands to checkout sources and build:
59-
```
59+
```bash
6060
cd <workspace>
6161
git clone https://github.com/intel/opencl-clang.git
6262
mkdir build && cd build
@@ -68,36 +68,37 @@ make all -j`nproc`
6868

6969
##### Preferred LLVM version
7070

71-
By default, Common clang's cmake script is searching for LLVM 11.0.0. You can
72-
override target version of LLVM by using the `PREFERRED_LLVM_VERSION` cmake option:
71+
By default, openclc-clang's cmake script is searching for LLVM 11.0.0. You can
72+
override target version of LLVM by using the `PREFERRED_LLVM_VERSION` cmake
73+
option:
7374

7475
Example:
75-
```
76+
```bash
7677
cmake -DPREFERRED_LLVM_VERSION="10.0.0" ../opencl-clang
7778
```
7879

7980
##### Custom LLVM installation
8081

8182
If LLVM is installed somewhere in custom (non-system directories) location, you
82-
could point to it using the `LLVM_DIR` cmake option. **Note**: You need to specify
83-
the path to a directory containing the `LLVMConfig.cmake` file.
83+
could point to it using the `LLVM_DIR` cmake option. **Note**: You need to
84+
specify the path to a directory containing the `LLVMConfig.cmake` file.
8485

8586
This file is available in two different locations.
8687
* `<INSTALL_PREFIX>/lib/cmake/llvm/LLVMConfig.cmake` where `<INSTALL_PREFIX>`
87-
is the install prefix of an installed version of LLVM. On Linux this is typically
88-
`/usr/lib/cmake/llvm/LLVMConfig.cmake`.
88+
is the install prefix of an installed version of LLVM. On Linux this is
89+
typically `/usr/lib/cmake/llvm/LLVMConfig.cmake`.
8990
* `<LLVM_BUILD_ROOT>/lib/cmake/llvm/LLVMConfig.cmake` where `<LLVM_BUILD_ROOT>`
9091
is the root of the LLVM build tree.
9192
**Note: this is only available when building LLVM with CMake.**
9293

9394
Example:
94-
```
95+
```bash
9596
cmake -DLLVM_DIR=/path/to/installed/llvm/lib/cmake/llvm ../opencl-clang
9697
```
9798

9899
##### Location of SPIR-V Translator library
99100

100-
By default, Common clang's cmake script assumes that SPIR-V Translator library
101+
By default, opencl-clang's cmake script assumes that SPIR-V Translator library
101102
is built as part of LLVM, installed in the same place and libLLVMSPIRVLib is
102103
linked into libLLVM.
103104

@@ -107,11 +108,12 @@ directory where SPIR-V Translator is installed by using `SPIRV_TRANSLATOR_DIR`
107108
cmake option.
108109

109110
Example:
110-
```
111+
```bash
111112
cmake -DLLVMSPIRV_INCLUDED_IN_LLVM=OFF -DSPIRV_TRANSLATOR_DIR=/path/to/installed/spirv/translator ../opencl-clang
112113
```
113114

114-
There is a known issue (linker crash) for this kind of build on Ubuntu 16.04 Xenial.
115+
There is a known issue (linker crash) for this kind of build on Ubuntu 16.04
116+
Xenial.
115117
In this case the following cmake option should fix it:
116118
```
117119
-DLLVM_NO_DEAD_STRIP=ON

0 commit comments

Comments
 (0)