This is an archive of the discontinued LLVM Phabricator instance.

[OpenCL] Improve online documentation.
ClosedPublic

Authored by Anastasia on Dec 30 2020, 4:56 AM.

Details

Summary

Update UsersManual and OpenCLSupport pages to reflect recent functionality i.e. SPIR-V generation, C++ for OpenCL, OpenCL 3.0 development plans.

Diff Detail

Event Timeline

Anastasia created this revision.Dec 30 2020, 4:56 AM
Anastasia requested review of this revision.Dec 30 2020, 4:56 AM
Anastasia updated this revision to Diff 314111.Dec 30 2020, 6:21 AM

Fixed some build warning/formating issues.

Looks good, only a few typos and minor comments.

clang/docs/OpenCLSupport.rst
73

I'm not sure it matters, but just in case it messes up with the rendering: the last | is not aligned.

clang/docs/UsersManual.rst
2832–2833
2864–2869

This also applies to types I believe (e.g. int2). Maybe this paragraph should be slightly altered to reflect this?

2875
2877
2894

I feel "provide" was slightly better.

3060
3242–3245
3279–3280
3309
Anastasia updated this revision to Diff 314184.Dec 31 2020, 5:00 AM

Addressed comments from Marco.

Anastasia marked an inline comment as done.Dec 31 2020, 5:05 AM
Anastasia added inline comments.
clang/docs/UsersManual.rst
2864–2869

Good point. I added types in too.

The header contains only a few types but mainly functions but vector types are important for example. Although they should have been native keywords and they were until some refactoring was made.

2894

True, now that I think about this from the user's perspective it's a better wording indeed.

Thanks for the update. Looks good overall. A minor question about backticks. I'm no native English speaker, so I would recommend a second review from someone else too.

clang/docs/OpenCLSupport.rst
73

Double backticks?

clang/docs/UsersManual.rst
2877

Do you also need to use double back-ticks here? I don't remember.

Looks good to me, just some grammar nitpicks from my side.

(I only discovered the "Suggest Edit" feature halfway through the review; I didn't update the comments I already made as I'm not sure in which format you prefer them?)

clang/docs/OpenCLSupport.rst
36–38
51–159

the enqueue_kernel builtin function is not supported

54

lambdas

56

destructors

67
clang/docs/UsersManual.rst
2828

Drop "file", or say "... produce a file test.bc that ..."

2832
2839

Full stop. New sentence.

3057–3060

identifier clashes

3058
3242–3248
Anastasia updated this revision to Diff 314594.Jan 5 2021, 7:01 AM
Anastasia marked an inline comment as done.

Addressed comments from Sven.

Anastasia updated this revision to Diff 314597.Jan 5 2021, 7:04 AM

Further change suggested by Marco

clang/docs/OpenCLSupport.rst
73

Just to make sure I understand you, do you suggest it for `-cl-std`?

clang/docs/UsersManual.rst
2877

I think we don't use it for file names but mainly code like constructs. But I think it is not very consistent though.

(I only discovered the "Suggest Edit" feature halfway through the review; I didn't update the comments I already made as I'm not sure in which format you prefer them?)

I do like the feature but I wish it would be more useful like on github that you can update the patch automatically...

LGTM, except for a minor typo. Otherwise my comments have been addressed. Thanks.

clang/docs/OpenCLSupport.rst
73

Yes, as you rightly updated. :)

clang/docs/UsersManual.rst
3242–3248
Anastasia updated this revision to Diff 314856.Jan 6 2021, 4:18 AM

Another fix from Marco.

svenvh added inline comments.Jan 8 2021, 4:46 AM
clang/docs/UsersManual.rst
2832
Anastasia updated this revision to Diff 315447.Jan 8 2021, 10:35 AM

Added the correction from Sven.

svenvh accepted this revision.Jan 14 2021, 3:35 AM

LGTM, thanks!

This revision is now accepted and ready to land.Jan 14 2021, 3:35 AM
This revision was automatically updated to reflect the committed changes.
Herald added a project: Restricted Project. · View Herald TranscriptJan 14 2021, 6:57 AM