-
Notifications
You must be signed in to change notification settings - Fork 769
[SYCL][Doc] Add new free function queries proposal #5106
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
Conversation
In preparation for moving the FreeFunctionQueries extension out of the experimental namespace, this commit makes the following changes: - Expands upon the motivation for the extension, and provides some non-normative recommendations for when it should be used. - Reformats the description of the functions to match the style used by ISO C++ and the newest sections of SYCL 2020. - Moves all functionality into the this_kernel namespace, to more closely align with the this_thread namespace in ISO C++. - Documents outstanding issues regarding undefined behavior. Signed-off-by: John Pennycook <john.pennycook@intel.com>
Signed-off-by: John Pennycook <john.pennycook@intel.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall, looks good but I am planning to look at it deeper after the vacation/holidays (if it is not merged). If this PR is urgent, please don't wait for me since I already put my preliminary review
sycl/doc/extensions/FreeFunctionQueries/FreeFunctionQueries.asciidoc
Outdated
Show resolved
Hide resolved
sycl/doc/extensions/FreeFunctionQueries/FreeFunctionQueries.asciidoc
Outdated
Show resolved
Hide resolved
sycl/doc/extensions/FreeFunctionQueries/FreeFunctionQueries.asciidoc
Outdated
Show resolved
Hide resolved
sycl/doc/extensions/FreeFunctionQueries/FreeFunctionQueries.asciidoc
Outdated
Show resolved
Hide resolved
Co-authored-by: Greg Lueck <gregory.m.lueck@intel.com>
Co-authored-by: Greg Lueck <gregory.m.lueck@intel.com>
Signed-off-by: John Pennycook <john.pennycook@intel.com>
sycl/doc/extensions/FreeFunctionQueries/FreeFunctionQueries.asciidoc
Outdated
Show resolved
Hide resolved
@Pennycook, please, resolve merge conflicts in README.md file. |
@gmlueck, @bader: The diff doesn't look very nice any more, but if I did everything correctly then de41bf2 just moves these changes into experimental/ with the new filename, and 05f1f77 moves things out into proposed/. My justification for putting things into proposed/ now is: 1) we've dropped the experimental namespace; and 2) the new API isn't implemented yet. |
Oh wait. I just noticed that you deleted the existing "sycl/doc/extensions/experimental/SYCL_EXT_ONEAPI_FREE_FUNCTION_QUERIES.asciidoc". Was that your intention? |
I don't think we need to keep the documentation for the old APIs around. Since they were experimental we can remove them without deprecation, and that's what I expect we'll do once the new API is implemented. |
@Pennycook, is PR description reflects the changes correctly? I'm using it as a commit message, so I'd like to make sure doesn't conflict with recent updates. |
@bader: I've tweaked things slightly to reflect that we're now adding a new proposal, rather than updating the old extension documentation. I think it can be merged now. |
* upstream/sycl: (3571 commits) [ESIMD] Doxygen update part III - core APIs. (intel#5472) [SYCL][DOC] Move proposed FPGA extensions (intel#5453) [SYCL] Add -fsycl-fp32-prec-sqrt flag (intel#5309) [SYCL] Emit program build logs for warning levels >= 2 (intel#5319) [SYCL] Add clang support for code_location in KernelInfo (intel#5335) [SYCL][Doc] Move FPGA extensions (intel#5470) [ESIMD] Fix public simd and simd_view APIs. (intel#5465) [SYCL] Deprecate sycl::atomics in SYCL 2020 mode (intel#5440) [SYCL] Add unit test for PR 5414 (intel#5450) [XPTI] Allow arbitrary data types in metadata (intel#4998) [SYCL][DOC] Move discard queue events to supported (intel#5452) [Driver][SYCL] Initial support for allowing fat static -lname processing (intel#5413) [SYCL] Fix dead pointer usage if leaf buffer overflows (intel#5417) [SYCL][L0] Fix memory leak in USM prefetch (intel#5461) [SYCL][Doc] Add new free function queries proposal (intel#5106) [SYCL][ESIMD] Update vc-intrinsics deps to the top of the trunk (intel#5460) [SYCL][DOC] Move old spec constant extension spec (intel#5456) [SYCL][DOC] Move deprecated extensions (intel#5458) [SYCL][DOC] Fix links to old SubGroupMask doc (intel#5459) [ESIMD] Doxygen update part II - memory APIs. (intel#5443) ...
The new proposal makes the following changes:
Expands upon the motivation for the extension, and provides some
non-normative recommendations for when it should be used.
Reformats the description of the functions to match the style used
by ISO C++ and the newest sections of SYCL 2020.
Moves all functionality into the this_kernel namespace, to more
closely align with the this_thread namespace in ISO C++.
Documents outstanding issues regarding undefined behavior.
Signed-off-by: John Pennycook john.pennycook@intel.com