This is an archive of the discontinued LLVM Phabricator instance.

[OpenCL][Docs] Change decription for the OpenCL standard headers
ClosedPublic

Authored by Anastasia on Feb 12 2021, 10:11 AM.

Details

Summary

After updating the user interface (https://reviews.llvm.org/D96515), make sure the doc reflects the change.

Diff Detail

Event Timeline

Anastasia created this revision.Feb 12 2021, 10:11 AM
Anastasia requested review of this revision.Feb 12 2021, 10:11 AM
Anastasia retitled this revision from [OpenCL][Docs] Change documentation for the OpenCL standard headers to [OpenCL][Docs] Change decription for the OpenCL standard headers.
svenvh added inline comments.Feb 16 2021, 6:31 AM
clang/docs/OpenCLSupport.rst
67
123

"are" or "can be"?

clang/docs/UsersManual.rst
2942
2943
2948

Maybe include the error output from running this as well, because otherwise a hasty reader might assume this command should work?

3016

I wonder if we need to keep this example? You're not referring to it from the text and it's not demonstrating any special flags anymore.

Anastasia updated this revision to Diff 324591.Feb 18 2021, 3:51 AM

Added corrections from Sven.

clang/docs/UsersManual.rst
3016

it's still demonstrating the use of default clang driver invocation i.e. there are no flags needed to compile the code that uses BIFs.

svenvh accepted this revision.Feb 18 2021, 8:37 AM

LGTM!

clang/docs/UsersManual.rst
3016

Okay, if you want to make that explicit then I would suggest to add a line like:

The following example shows how an OpenCL program that calls various standard builtin functions can be compiled without the need for any explicit includes or compiler flags.
This revision is now accepted and ready to land.Feb 18 2021, 8:37 AM
Anastasia added inline comments.Feb 19 2021, 5:03 AM
clang/docs/UsersManual.rst
3016

Ok, good idea. I will add this in my final commit.

Herald added a project: Restricted Project. · View Herald TranscriptFeb 23 2021, 3:49 AM