Skip to content

Commit 01f2eae

Browse files
authored
[Doc] Readme update. (#1701)
Fix markdown linter issues. Fix a link to Get Started Guide in opencl-aot readme file. Signed-off-by: Alexey Bader <[email protected]>
1 parent 9afcfad commit 01f2eae

File tree

2 files changed

+34
-23
lines changed

2 files changed

+34
-23
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,25 @@
44

55
Intel staging area for llvm.org contribution.
66
Home for Intel LLVM-based projects:
7-
- oneAPI Data Parallel C++ compiler - see **sycl** branch. More information on
7+
8+
* oneAPI Data Parallel C++ compiler - see **sycl** branch. More information on
89
oneAPI and DPC++ is available at
910
[https://www.oneapi.com/](https://www.oneapi.com/)
10-
- [![Linux Post Commit Checks](https://github.com/intel/llvm/workflows/Linux%20Post%20Commit%20Checks/badge.svg)](https://github.com/intel/llvm/actions?query=workflow%3A%22Linux+Post+Commit+Checks%22)
11-
[![Generate Doxygen documentation](https://github.com/intel/llvm/workflows/Generate%20Doxygen%20documentation/badge.svg)](https://github.com/intel/llvm/actions?query=workflow%3A%22Generate+Doxygen+documentation%22)
12-
13-
11+
* [![Linux Post Commit Checks](https://github.com/intel/llvm/workflows/Linux%20Post%20Commit%20Checks/badge.svg)](https://github.com/intel/llvm/actions?query=workflow%3A%22Linux+Post+Commit+Checks%22)
12+
[![Generate Doxygen documentation](https://github.com/intel/llvm/workflows/Generate%20Doxygen%20documentation/badge.svg)](https://github.com/intel/llvm/actions?query=workflow%3A%22Generate+Doxygen+documentation%22)
1413

1514
## License
15+
1616
See [LICENSE.txt](sycl/LICENSE.TXT) for details.
1717

1818
## Contributing
19+
1920
See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
2021

2122
## Sub-projects Documentation
22-
- oneAPI Data Parallel C++ compiler - See
23-
[GetStartedGuide.md](sycl/doc/GetStartedGuide.md)
23+
24+
* oneAPI Data Parallel C++ compiler - See
25+
[GetStartedGuide.md](sycl/doc/GetStartedGuide.md)
2426

2527
## DPC++ extensions
2628

@@ -29,4 +31,3 @@ SYCL\* standards. DPC++ extends these standards with a number of extensions,
2931
which can be found in [sycl/doc/extensions](sycl/doc/extensions) directory.
3032

3133
\*Other names and brands may be claimed as the property of others.
32-

opencl-aot/README.md

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,36 @@
11
# OpenCL ahead-of-time compilation tool (opencl-aot)
22

3-
OpenCL ahead-of-time compilation tool (opencl-aot) is a tool which generates device-dependent OpenCL program
4-
binary from SPIR-V binary primarily for Intel(R) processor devices.
3+
OpenCL ahead-of-time compilation tool (`opencl-aot`) is a tool which generates
4+
device-dependent OpenCL program binary from SPIR-V binary primarily for Intel(R)
5+
processor devices.
56

67
## Prerequisites
78

8-
To use opencl-aot tool, you must have:
9-
* OpenCL runtime installed for the target device (see [Install low level runtime](../sycl/doc/GetStartedWithSYCLCompiler.md))
9+
To use `opencl-aot` tool, you must have:
10+
11+
* OpenCL runtime installed for the target device (see
12+
[Install low level runtime](../sycl/doc/GetStartedGuide.md#install-low-level-runtime))
1013
* OpenCL ICD Loader installed with support of OpenCL 2.1 or higher
1114

1215
## How to use
1316

14-
opencl-aot tool is integrated with Clang. To use ahead-of-time compilation for SYCL application for
15-
Intel(R) processor device, run Clang with `-fsycl-targets=spir64_x86_64-unknown-unknown-sycldevice` option.
16-
To enable optimizations for target CPU architecture, add `-Xsycl-target-backend "-march=<arch>"` option, where `<arch>`
17-
could be `avx512`, `avx2`, `avx` or `sse4.2`.
17+
`opencl-aot` tool is integrated with Clang. To use ahead-of-time compilation for
18+
SYCL application for Intel(R) processor device, run Clang with
19+
`-fsycl-targets=spir64_x86_64-unknown-unknown-sycldevice` option.
20+
21+
To enable optimizations for target CPU architecture, add
22+
`-Xsycl-target-backend "-march=<arch>"` option, where `<arch>` could be
23+
`avx512`, `avx2`, `avx` or `sse4.2`.
24+
25+
To execute `opencl-aot` directly for Intel(R) processor device, run it with
26+
`<spv> -o=<output> --device=cpu`, where `<spv>` is path to SPIR-V binary file,
27+
`<output>` is path to created OpenCL program binary file.
1828

19-
To execute opencl-aot directly for Intel(R) processor device, run it with `<spv> -o=<output> --device=cpu`, where `<spv>` is
20-
path to SPIR-V binary file, `<output>` is path to created OpenCL program binary file.
21-
To generate SPIR-V binary file from OpenCL device kernel code, use Clang to generate LLVM IR and pass it to
22-
[llvm-spirv](https://github.com/KhronosGroup/SPIRV-LLVM-Translator) tool. For more
23-
information about generation LLVM IR from OpenCL device kernel code, see
24-
[OpenCL Features](https://clang.llvm.org/docs/UsersManual.html#opencl-features) of Clang Compiler User's Manual.
29+
To generate SPIR-V binary file from OpenCL device kernel code, use Clang to
30+
generate LLVM IR and pass it to
31+
[llvm-spirv](https://github.com/KhronosGroup/SPIRV-LLVM-Translator) tool. For
32+
more information about generation LLVM IR from OpenCL device kernel code, see
33+
[OpenCL Features](https://clang.llvm.org/docs/UsersManual.html#opencl-features)
34+
of Clang Compiler User's Manual.
2535

26-
For more information about opencl-aot tool, execute it with `--help` option.
36+
For more information about `opencl-aot` tool, execute it with `--help` option.

0 commit comments

Comments
 (0)