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

handle case-insensitive asciidoctor attributes #443

Closed
bashbaug opened this issue Sep 11, 2020 · 0 comments · Fixed by #444
Closed

handle case-insensitive asciidoctor attributes #443

bashbaug opened this issue Sep 11, 2020 · 0 comments · Fixed by #444
Assignees
Labels
Coming Soon Issues to Work Next OpenCL API Spec Issues related to the OpenCL API specification.

Comments

@bashbaug
Copy link
Contributor

Unfortunately, asciidoctor attributes are currently case-insensitive. This means that the asciidoctor enum attribute for CL_DEVICE_DEVICE_ENQUEUE_CAPABILITIES is indistinguishable for the asciidoctor type attribute for cl_device_device_enqueue_capabilities. When both attributes are indistinguishable, it looks like the last one "wins", and as a result there are several places in the spec where the type name is used in place of the enum name.

There is an Asciidoctor issue open to fix this, but it's been open for a while without any updates.

Options to fix this issue in the OpenCL specs:

  1. Add a prefix or suffix to one class of attributes to disambiguate, probably the type name since there are fewer of them.
  2. Special-case this particular attribute and try to avoid duplicates in the future.

I suppose we could also rename either the type or the enum to disambiguate - is there any other reason to prefer unique case-insensitive names? - but that feels a bit like the tail wagging the dog.

I'll probably bite the bullet and go with (1) if it doesn't look too bad.

@bashbaug bashbaug added OpenCL API Spec Issues related to the OpenCL API specification. Coming Soon Issues to Work Next labels Sep 11, 2020
@bashbaug bashbaug self-assigned this Sep 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Coming Soon Issues to Work Next OpenCL API Spec Issues related to the OpenCL API specification.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant