Skip to content

[SYCL][NFC] Update Attribute Document #3102

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

Merged
romanovvlad merged 3 commits into from
Jan 27, 2021
Merged

[SYCL][NFC] Update Attribute Document #3102

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
483006e
[SYCL][NFC] Update Attribute Document
smanna12 Jan 25, 2021
01133d7
Update Docs based on review comments
smanna12 Jan 26, 2021
a4251de
Update Docs based on review comments
smanna12 Jan 26, 2021
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
8 changes: 4 additions & 4 deletions clang/include/clang/Basic/AttrDocs.td
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2199,7 +2199,7 @@ attribute was applied. This effect is equivalent to annotating restrict on
**all** kernel pointer arguments in an OpenCL or SPIR-V kernel.

If ``intel::kernel_args_restrict`` is applied to a function called from a device
kernel, the attribute is ignored and it is not propagated to a kernel.
kernel, the attribute is not ignored and it is propagated to a kernel.
Copy link
Contributor

@premanandrao premanandrao Jan 26, 2021

Choose a reason for hiding this comment

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

I would change it to '... is propagated to the kernel', since it is the same kernel we are talking about. (i.e. 'the' instead of 'a' in that sentence.)

Here and the other three places below as well.

Copy link
Contributor Author

@smanna12 smanna12 Jan 26, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Thanks @premanandrao. Fixed now.


The attribute forms an unchecked assertion, in that implementations
do not need to check/confirm the pre-condition in any way. If a user applies
Expand Down Expand Up @@ -2229,7 +2229,7 @@ def SYCLIntelNumSimdWorkItemsAttrDocs : Documentation {
Applies to a device function/lambda function. Indicates the number of work
items that should be processed in parallel. Valid values are positive integers.
If ``intel::num_simd_work_items`` is applied to a function called from a
device kernel, the attribute is ignored and it is not propagated to a kernel.
device kernel, the attribute is not ignored and it is propagated to a kernel.
}];
}

Expand Down Expand Up @@ -2305,7 +2305,7 @@ of a work group. Values must be positive integers. This is similar to
reqd_work_group_size, but allows work groups that are smaller or equal to the
specified sizes.
If ``intel::max_work_group_size`` is applied to a function called from a
device kernel, the attribute is ignored and it is not propagated to a kernel.
device kernel, the attribute is not ignored and it is propagated to a kernel.
}];
}

Expand All @@ -2321,7 +2321,7 @@ range of [0, 3]. A kernel with max_global_work_dim(0) must be invoked with a
``cl::reqd_work_group_size`` are applied to the kernel as well - they shall
have arguments of (1, 1, 1).
If ``intel::max_global_work_dim`` is applied to a function called from a
device kernel, the attribute is ignored and it is not propagated to a kernel.
device kernel, the attribute is not ignored and it is propagated to a kernel.
}];
}

Expand Down