Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[SYCL][NFC][Doc] Minor docs update #6119

Merged
merged 1 commit into from
May 9, 2022
Merged

[SYCL][NFC][Doc] Minor docs update #6119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we not need this anymore?

Copy link
Contributor Author

@pvchupin pvchupin May 9, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Short name is preferable today

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I should have been clearer; I meant the OpenMP late-outline link. That seems to have been removed. Is that not needed anymore?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, nevermind. I was confused by the '-' used in the bullets. I thought it was a diff line.


## 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.

Expand Down
2 changes: 1 addition & 1 deletion clang/docs/LanguageExtensions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
13 changes: 5 additions & 8 deletions sycl/doc/GetStartedGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<sub>\*Other names and brands may be claimed as the property of others.</sub>
2 changes: 1 addition & 1 deletion sycl/doc/design/ITTAnnotations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion sycl/doc/doxygen.cfg.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion sycl/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Data Parallel C++ Documentation
DPC++ Documentation
===============================

Using oneAPI DPC++ for Application Development
Expand Down