[PATCH] D109225: [clang-nvlink-wrapper] Add documentation in clang docs

[Aaron Ballman via Phabricator via cfe-commits]

aaron.ballman accepted this revision.
aaron.ballman added a comment.
This revision is now accepted and ready to land.

LGTM with only minor nits from me, thank you!



================
Comment at: clang/docs/ClangNvlinkWrapper.rst:13
+
+This tool works as a wrapper over nvlink program. It is required because nvlink does not
+support linking of archive files implicitly. It transparently passes every
----------------



================
Comment at: clang/docs/ClangNvlinkWrapper.rst:15
+support linking of archive files implicitly. It transparently passes every
+input option and objects to nvlink except archive files. It reads each input
+archive file to extract archived cubin files as temporary files.
----------------



================
Comment at: clang/docs/ClangNvlinkWrapper.rst:16
+input option and objects to nvlink except archive files. It reads each input
+archive file to extract archived cubin files as temporary files.
+These temp (*.cubin) files are passed to nvlink.
----------------



================
Comment at: clang/docs/ClangNvlinkWrapper.rst:17
+archive file to extract archived cubin files as temporary files.
+These temp (*.cubin) files are passed to nvlink.
+
----------------



================
Comment at: clang/docs/ClangNvlinkWrapper.rst:22
+creates a device specific archive of cubin files. Such an archive is then
+passed to this wrapper tool to extract cubin files before passing to nvlink.
+
----------------



================
Comment at: clang/docs/ClangNvlinkWrapper.rst:29
+
+  A command line generated by the OpenMP-Clang driver targeting NVPTX, containing a set of flags, cubin object files, and zero or more archive files
+
----------------
Also, 80-col limit.


================
Comment at: clang/docs/ClangNvlinkWrapper.rst:39
+  2. Create a new command line, `NVLinkCommand`, such that
+     * Program is nvlink
+     * All input flags are transparently passed on as flags
----------------



================
Comment at: clang/docs/ClangNvlinkWrapper.rst:51
+
+  Output file generated by nvlink by linking all cubin files.
----------------



================
Comment at: clang/docs/ClangNvlinkWrapper.rst:52
+  Output file generated by nvlink by linking all cubin files.
\ No newline at end of file

----------------
sylvestre.ledru wrote:
> please add a new line
> 
Might as well add the newline.


================
Comment at: clang/docs/ReleaseNotes.rst:150
 
-- ...
+- clang-nvlink-wrapper tool introduced to support linking of cubin files
+  archived in an archive. See `Clang Nvlink Wrapper <https://clang.llvm.org/docs/ClangNvlinkWrapper.html>`_ .
----------------



Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D109225