[PATCH] D93942: [OpenCL] Improve online documentation.

Sven van Haastregt via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Thu Dec 31 09:42:13 PST 2020


svenvh added a comment.

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?)



================
Comment at: clang/docs/OpenCLSupport.rst:34
 
-Bugzilla bugs for this functionality are typically prefixed
-with '[C++]'.
+Clang implements the language version 1.0 published in `the official
+release of C++ for OpenCL Documentation
----------------



================
Comment at: clang/docs/OpenCLSupport.rst:47-48
 
-- Use of ObjC blocks is disabled.
-
-- Global destructor invocation is not generated correctly.
-
-- Initialization of objects in `__constant` address spaces is not guaranteed to work.
-
-- `addrspace_cast` operator is not supported.
+- Use of ObjC blocks is disabled and therefore there is no support of
+  `enqueue_kernel` builtin function at present.   It is expected that
+  if support for this feature is added in the future, it will utilize
----------------
the `enqueue_kernel` builtin function is not supported


================
Comment at: clang/docs/OpenCLSupport.rst:50
+  if support for this feature is added in the future, it will utilize
+  C++ lamdas instead of ObjC blocks.
+
----------------
lambdas


================
Comment at: clang/docs/OpenCLSupport.rst:52
+
+- IR generation for global destructor is incomplete (See:
+  `PR48047 <https://llvm.org/PR48047>`_).
----------------
destructors


================
Comment at: clang/docs/OpenCLSupport.rst:63
+
+The following table provides overview of features in OpenCL C 3.0 and their
+implementation status. 
----------------



================
Comment at: clang/docs/UsersManual.rst:2828
 
-This will produce a generic test.bc file that can be used in vendor toolchains
+This will produce test.bc file that can be used in vendor toolchains
 to perform machine code generation.
----------------
Drop "file", or say "... produce a file test.bc that ..."


================
Comment at: clang/docs/UsersManual.rst:2832
+Note that if compiled to bitcode for generic targets such as SPIR,
+portable IR is produced i.e. it can be used with various vendor
+tools as well as open source tools such as `SPIRV-LLVM Translator
----------------



================
Comment at: clang/docs/UsersManual.rst:2839
+Clang currently supports OpenCL C language standards up to v2.0. Clang mainly
+supports full profile, there is only very limited support of the embedded
+profile. 
----------------
Full stop. New sentence.


================
Comment at: clang/docs/UsersManual.rst:3057
 
-Declaring the same types in different vendor extensions is disallowed.
+There is no conflict resolution for identifiers clash among extensions.
+It is therefore recommended that the identifiers are prefixed with the
----------------
identifier clashes


================
Comment at: clang/docs/UsersManual.rst:3058
+There is no conflict resolution for identifiers clash among extensions.
+It is therefore recommended that the identifiers are prefixed with the
+double underscore to avoid clashing with user space identifiers. Vendor
----------------



================
Comment at: clang/docs/UsersManual.rst:3242
 
-Since C++ features are to be used on top of OpenCL C functionality, all existing
-restrictions from OpenCL C v2.0 will inherently apply. All OpenCL C builtin types
-and function libraries are supported and can be used in this mode.
+Clang currently support the C++ for OpenCL v1.0.
+For detailed information about this language refer to the C++ for OpenCL
----------------



CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D93942/new/

https://reviews.llvm.org/D93942



More information about the cfe-commits mailing list