Page MenuHomePhabricator

Adding doxygen comments to the LLVM intrinsics (part 5, f16cintrin.h)
ClosedPublic

Authored by kromanova on Feb 9 2016, 12:13 AM.

Details

Summary

Eric Christopher told me that from now on it's OK to commit doxygen comments for x86 intrinsics without formal OK from the open source reviewers. Post-commit reviews could be done later if needed. It should speed up the process.

I still think it's worth posting a code review. At first, it's nice for bookkeeping. At second, I made one tiny non-comment related change by replacing the name of the parameter in one of the intrinsics. It's done for consistency purpose. It might be the only thing that needs to be briefly looked at during pre-commit review.

Here is the patch with the doxygen comments for the intrinsincs in the header file f16cintrin.h.
The doxygen comments are automatically generated based on SCE internal intrinsics document using DCG tool that I wrote.

I will submit more doxygen comments for the other intrinsic header files as soon as this patch is approved.

Here is the link to the general discussion about adding comments to x86 intrinsics headers.
http://permalink.gmane.org/gmane.comp.compilers.clang.devel/42032

Here are the links to the similar code reviews for the doxygen comments other header files.

http://reviews.llvm.org/D8762 (closed)
http://reviews.llvm.org/D15999 (closed)
http://reviews.llvm.org/D16562 (closed)
http://reviews.llvm.org/D16913 (closed)

Diff Detail

Repository
rL LLVM

Event Timeline

kromanova updated this revision to Diff 47299.Feb 9 2016, 12:13 AM
kromanova retitled this revision from to Adding doxygen comments to the LLVM intrinsics (part 5, f16cintrin.h).
kromanova updated this object.
kromanova set the repository for this revision to rL LLVM.
kromanova added a subscriber: cfe-commits.
This revision was automatically updated to reflect the committed changes.

It's best not to commit things without approval once they've been sent for
review (the assumption being that if you asked for review it's because the
change needed review - time doesn't change that fact) - if approval was
given off-list (eg: on IRC) it's best to mention who gave it & where (&
ideally the person should provide it on-list just for record keeping)

My apologies…

From: David Blaikie [mailto:dblaikie@gmail.com]
Sent: Tuesday, February 09, 2016 4:42 PM
To: reviews+D17021+public+89c4dbb2f75e8fba@reviews.llvm.org; Romanova, Katya
Cc: Gao, Yunzhong; Robinson, Paul; Eric Christopher; Dmitri Gribenko; Craig Topper; Jonathan Roelofs; cfe-commits
Subject: Re: [PATCH] D17021: Adding doxygen comments to the LLVM intrinsics (part 5, f16cintrin.h)

It's best not to commit things without approval once they've been sent for review (the assumption being that if you asked for review it's because the change needed review - time doesn't change that fact) - if approval was given off-list (eg: on IRC) it's best to mention who gave it & where (& ideally the person should provide it on-list just for record keeping)