[PATCH] D154123: [HIP] Start document HIP support by clang

[Yaxun Liu via Phabricator via cfe-commits]

yaxunl marked 5 inline comments as done.
yaxunl added inline comments.


================
Comment at: clang/docs/HIPSupport.rst:33
+
+   clang -c --offload-arch=gfx906 test.hip -o test.o
+
----------------
scchan wrote:
> can we add -xhip to enable HIP for files without the .hip file ext?
will do


================
Comment at: clang/docs/HIPSupport.rst:56
+Environment Variables
+=====================
+
----------------
scchan wrote:
> I'd suggest adding a section to cover compiler options to pass various hip/rocm related paths and that using the compiler options would be a much more preferable alternative.
It may be clearer to put the options and environment vars for setting dependency paths side by side since they are connected


================
Comment at: clang/docs/HIPSupport.rst:87
+   * - ``__HIPCC__``
+     - This macro indicates that the code is being compiled using the HIP compiler.
+   * - ``__HIP_MEMORY_SCOPE_SINGLETHREAD``
----------------
scchan wrote:
> I think this macro is essentially an alias to __HIP__?
Yes. will change the description 


================
Comment at: clang/docs/HIPSupport.rst:99
+   * - ``__HIP_DEVICE_COMPILE__``
+     - This macro is defined when the code is being compiled for a HIP device.
+   * - ``__HIP_NO_IMAGE_SUPPORT``
----------------
scchan wrote:
> It might be helpful to provide more context here as to how a HIP source file gets compiled (once for the host and then once for each device arch).  Also I'd suggest moving this up closer to __HIP__ given they are related.
will do


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

https://reviews.llvm.org/D154123