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.

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

add a section to better document string representations #1300

Open
bashbaug opened this issue Jan 22, 2025 · 0 comments
Open

add a section to better document string representations #1300

bashbaug opened this issue Jan 22, 2025 · 0 comments

Comments

@bashbaug
Copy link
Contributor

Currently, there is minimal information in the OpenCL specification about strings that are passed into and out of OpenCL, and it is in a footnote:

https://registry.khronos.org/OpenCL/specs/3.0-unified/html/OpenCL_API.html#_footnotedef_3

A null terminated string is returned by OpenCL query function calls if the return type of the information being queried is a char[].

We should better document the behavior for strings passed into and out of OpenCL, such as the expected string encoding, whether strings are null-terminated, etc. As one possibility, we could add "string representations" section similar to the one in Vulkan specification:

https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#fundamentals-strings

@bashbaug bashbaug moved this from To do to Needs WG discussion in OpenCL specification maintenance Jan 22, 2025
@bashbaug bashbaug moved this from Needs WG discussion to Next Spec Release in OpenCL specification maintenance Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Next Spec Release
Development

No branches or pull requests

1 participant