Skip to content

[SYCL][DOC] Move proposed extension docs #5437

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.

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

Merged
merged 2 commits into from
Feb 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions sycl/ReleaseNotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -271,11 +271,11 @@ Release notes for commit range 6a49170027fb..962909fe9e78
extension specification [edaee9b]
- Added [initial draft](doc/extensions/supported/SYCL_EXT_ONEAPI_BACKEND_LEVEL_ZERO.md)
for querying of free device memory in LevelZero backend extension [fa428bf]
- Added [InvokeSIMD](doc/extensions/InvokeSIMD/InvokeSIMD.asciidoc) and
[Uniform](doc/extensions/Uniform/Uniform.asciidoc) extensions [72e1611]
- Added [InvokeSIMD](doc/extensions/proposed/SYCL_EXT_ONEAPI_INVOKE_SIMD.asciidoc) and
[Uniform](doc/extensions/proposed/SYCL_EXT_ONEAPI_UNIFORM.asciidoc) extensions [72e1611]
- Added [Matrix Programming Extension for DPC++ document](doc/extensions/experimental/SYCL_EXT_ONEAPI_MATRIX.asciidoc) [ace4c733]
- Implemented SYCL 2020 `sycl::span` [9356d53]
- Added [device-if](doc/extensions/DeviceIf/device_if.asciidoc) extension
- Added [device-if](doc/extensions/proposed/SYCL_EXT_ONEAPI_DEVICE_IF.asciidoc) extension
[4fb95fc]
- Added a [programming guide](doc/MultiTileCardWithLevelZero.md) for
multi-tile and multi-card under Level Zero backend [d581178a]
Expand Down
8 changes: 4 additions & 4 deletions sycl/doc/CompileTimeProperties.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ One use for compile-time properties is with types that are used exclusively
for declaring global variables. One such example is the
[SYCL\_EXT\_ONEAPI\_DEVICE\_GLOBAL][2] extension:

[2]: <extensions/DeviceGlobal/SYCL_INTEL_device_global.asciidoc>
[2]: <extensions/proposed/SYCL_EXT_ONEAPI_DEVICE_GLOBAL.asciidoc>

```
namespace sycl::ext::oneapi {
Expand Down Expand Up @@ -270,11 +270,11 @@ the property value to a string if it is not already a string.
## Properties on kernel functions

Compile-time properties can also be used to decorate kernel functions as with
the [SYCL\_EXT\_ONEAPI\_KERNEL\_PROPERTIES][8] extension. There are two ways
the application can specify these properties. The first is by passing a
the [SYCL\_EXT\_ONEAPI\_PROPERTIES][8] extension. There are two ways the
application can specify these properties. The first is by passing a
`property_list` parameter to the function that submits the kernel:

[8]: <https://github.com/intel/llvm/blob/sycl/sycl/doc/extensions/KernelProperties/KernelProperties.asciidoc>
[8]: <extensions/proposed/SYCL_EXT_ONEAPI_PROPERTIES.asciidoc>

```
namespace sycl {
Expand Down
2 changes: 1 addition & 1 deletion sycl/doc/DeviceGlobal.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This document describes the implementation design for the DPC++ extension
[SYCL\_EXT\_ONEAPI\_DEVICE\_GLOBAL][1], which allows applications to declare
global variables in device code.

[1]: <extensions/DeviceGlobal/SYCL_INTEL_device_global.asciidoc>
[1]: <extensions/proposed/SYCL_EXT_ONEAPI_DEVICE_GLOBAL.asciidoc>


## Requirements
Expand Down
2 changes: 1 addition & 1 deletion sycl/doc/OptionalDeviceFeatures.md
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ non-FPGA users may want to use the `device_global` property
[`device_image_scope`][5], which requires even non-FPGA users to have precise
control over the way kernels are bundled into device images.

[5]: <extensions/DeviceGlobal/SYCL_INTEL_device_global.asciidoc#properties-for-device-global-variables>
[5]: <extensions/proposed/SYCL_EXT_ONEAPI_DEVICE_GLOBAL.asciidoc#properties-for-device-global-variables>

The new definition of `-fsycl-device-code-split` is as follows:

Expand Down
5 changes: 0 additions & 5 deletions sycl/doc/extensions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,7 @@ DPC++ extensions status:
| [SYCL_INTEL_static_local_memory_query](StaticLocalMemoryQuery/SYCL_INTEL_static_local_memory_query.asciidoc) | Proposal | |
| [Sub-groups for NDRange Parallelism](SubGroupNDRange/SubGroupNDRange.md) | Deprecated(OpenCL: CPU, GPU) | |
| [Sub-groups](SubGroup/SYCL_INTEL_sub_group.asciidoc) | Deprecated | |
| [SYCL_EXT_ONEAPI_DEVICE_IF](DeviceIf/device_if.asciidoc) | Proposal | |
| [Invoke SIMD](InvokeSIMD/InvokeSIMD.asciidoc) | Proposal | |
| [Uniform](Uniform/Uniform.asciidoc) | Proposal | |
| [SYCL_EXT_ONEAPI_DEVICE_GLOBAL](DeviceGlobal/SYCL_INTEL_device_global.asciidoc) | Proposal | |
| [Property List](PropertyList/SYCL_EXT_ONEAPI_property_list.asciidoc) | Proposal | |
| [KernelProperties](KernelProperties/KernelProperties.asciidoc) | Proposal | |
| [DiscardQueueEvents](DiscardQueueEvents/SYCL_EXT_ONEAPI_DISCARD_QUEUE_EVENTS.asciidoc) | Proposal | |

Legend:
Expand Down
9 changes: 9 additions & 0 deletions sycl/doc/extensions/proposed/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
This directory contains the specifications for SYCL extensions that are
proposed for the DPC++ implementation. These extensions are not implemented
in DPC++, so they cannot be used. These extension documents are published
here to gather community feedback.

A proposed extension may eventually be implemented, thus promoting it to
"supported" or "experimental". When this happens, the specification document
is generally moved to either the "supported" or "experimental" directory, and
there may also be some changes to its APIs.
File renamed without changes.