From 21d62dd399ba8665da50ce8b9aaf4dd4a810269e Mon Sep 17 00:00:00 2001 From: Pavel Chupin Date: Mon, 9 May 2022 11:46:42 -0700 Subject: [PATCH] [SYCL][NFC][Doc] Minor docs update (#6119) * Fix level zero specification link * Use short DPC++ name everywhere * Formatting changes --- README.md | 16 ++++++++-------- clang/docs/LanguageExtensions.rst | 2 +- sycl/doc/GetStartedGuide.md | 13 +++++-------- sycl/doc/design/ITTAnnotations.md | 2 +- sycl/doc/doxygen.cfg.in | 2 +- sycl/doc/index.rst | 2 +- 6 files changed, 17 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index da4fd2b6aed29..68110c280523c 100644 --- a/README.md +++ b/README.md @@ -3,22 +3,22 @@ This is the Intel staging area for llvm.org contributions and the home for Intel LLVM-based projects: -- [oneAPI Data Parallel C++ compiler](#oneapi-data-parallel-c-compiler) +- [oneAPI DPC++ compiler](#oneapi-dpc-compiler) - [Late-outline OpenMP and OpenMP Offload](#late-outline-openmp-and-openmp-offload) -## oneAPI Data Parallel C++ compiler +## oneAPI DPC++ compiler [![](https://spec.oneapi.io/oneapi-logo-white-scaled.jpg)](https://www.oneapi.io/) [![SYCL Post Commit](https://github.com/intel/llvm/actions/workflows/sycl_post_commit.yml/badge.svg?branch=sycl)](https://github.com/intel/llvm/actions/workflows/sycl_post_commit.yml) [![Generate Doxygen documentation](https://github.com/intel/llvm/actions/workflows/gh_pages.yml/badge.svg?branch=sycl)](https://github.com/intel/llvm/actions/workflows/gh_pages.yml) -The Data Parallel C++ or DPC++ is a LLVM-based compiler project that implements -compiler and runtime support for the SYCL\* language. The project is hosted in -the [sycl](/../../tree/sycl) branch and is synced with the tip of the LLVM -upstream main branch on a regular basis (revisions delay is usually not more -than 1-2 weeks). DPC++ compiler takes everything from LLVM upstream as is, -however some modules of LLVM might be not included in the default project build +The DPC++ is a LLVM-based compiler project that implements compiler and runtime +support for the SYCL\* language. The project is hosted in the +[sycl](/../../tree/sycl) branch and is synced with the tip of the LLVM upstream +main branch on a regular basis (revisions delay is usually not more than 1-2 +weeks). DPC++ compiler takes everything from LLVM upstream as is, however some +modules of LLVM might be not included in the default project build configuration. Additional modules can be enabled by modifying build framework settings. diff --git a/clang/docs/LanguageExtensions.rst b/clang/docs/LanguageExtensions.rst index a1e01dcbe2ab2..34a52ccefdbab 100644 --- a/clang/docs/LanguageExtensions.rst +++ b/clang/docs/LanguageExtensions.rst @@ -2944,7 +2944,7 @@ Query for this feature with ``__has_builtin(__builtin_trap)``. ``__builtin_sycl_unique_stable_name()`` is a builtin that takes a type and produces a string literal containing a unique name for the type that is stable -across split compilations, mainly to support SYCL/Data Parallel C++ language. +across split compilations, mainly to support SYCL language. In cases where the split compilation needs to share a unique token for a type across the boundary (such as in an offloading situation), this name can be used diff --git a/sycl/doc/GetStartedGuide.md b/sycl/doc/GetStartedGuide.md index 26b6a0952a581..2b04d2ce68d6a 100644 --- a/sycl/doc/GetStartedGuide.md +++ b/sycl/doc/GetStartedGuide.md @@ -859,11 +859,8 @@ which contains all the symbols required. ## Find More -* DPC++ specification: -[https://spec.oneapi.com/versions/latest/elements/dpcpp/source/index.html](https://spec.oneapi.com/versions/latest/elements/dpcpp/source/index.html) -* SYCL\* 2020 specification: -[https://www.khronos.org/registry/SYCL/](https://www.khronos.org/registry/SYCL/) -* oneAPI Level Zero specification: -[https://spec.oneapi.com/versions/latest/oneL0/index.html](https://spec.oneapi.com/versions/latest/oneL0/index.html) - -\*Other names and brands may be claimed as the property of others. +* [DPC++ specification](https://spec.oneapi.io/versions/latest/elements/dpcpp/source/index.html) +* [SYCL\* specification](https://www.khronos.org/registry/SYCL) +* [Level Zero specification](https://spec.oneapi.io/level-zero/latest/index.html) + +\*Other names and brands may be claimed as the property of others. diff --git a/sycl/doc/design/ITTAnnotations.md b/sycl/doc/design/ITTAnnotations.md index aa8b72b5b15a6..cbaed14f8ddb1 100644 --- a/sycl/doc/design/ITTAnnotations.md +++ b/sycl/doc/design/ITTAnnotations.md @@ -61,7 +61,7 @@ a wrapper. ## Conditional compilation -Data Parallel C++ compiler automatically instruments user code through +DPC++ compiler automatically instruments user code through SPIRITTAnnotations LLVM pass, which is enabled for targets, that natively support specialization constants (i.e., SPIR-V targets). Annotations are generated for barriers, atomics, work item start and finish. diff --git a/sycl/doc/doxygen.cfg.in b/sycl/doc/doxygen.cfg.in index 3973c00436056..df2df98ef21be 100644 --- a/sycl/doc/doxygen.cfg.in +++ b/sycl/doc/doxygen.cfg.in @@ -44,7 +44,7 @@ PROJECT_NUMBER = @PACKAGE_VERSION@ # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. -PROJECT_BRIEF = "Runtime libraries for oneAPI Data Parallel C++" +PROJECT_BRIEF = "Runtime libraries for oneAPI DPC++" # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 diff --git a/sycl/doc/index.rst b/sycl/doc/index.rst index ce9f1ea17b69a..d3a7f808b7f0e 100644 --- a/sycl/doc/index.rst +++ b/sycl/doc/index.rst @@ -1,4 +1,4 @@ -Data Parallel C++ Documentation +DPC++ Documentation =============================== Using oneAPI DPC++ for Application Development