llvm-project/clang-tools-extra/docs
Alexander Droste 1512f9a0f9 [clang-tidy] MPIBufferDerefCheck
...
This check verifies if a buffer passed to an MPI (Message Passing Interface)
function is sufficiently dereferenced. Buffers should be passed as a single
pointer or array. As MPI function signatures specify void * for their buffer
types, insufficiently dereferenced buffers can be passed, like for example
as double pointers or multidimensional arrays, without a compiler warning
emitted.

Instructions on how to apply the check can be found at:
https://github.com/0ax1/MPI-Checker/tree/master/examples

Reviewers: Haojian Wu
Differential revision: https://reviews.llvm.org/D22729

llvm-svn: 278553
2016-08-12 19:30:31 +00:00
..
clang-tidy [clang-tidy] MPIBufferDerefCheck 2016-08-12 19:30:31 +00:00
CMakeLists.txt Add clang-tools-extra documentation to the CMake build. 2016-01-27 11:37:08 +00:00
Doxyfile [clang-tidy] Move clang-tidy docs to a separate directory. Create doc files for checks 2015-08-27 18:10:07 +00:00
ModularizeUsage.rst Added mechanism to modularize for doing a compilation precheck 2015-07-10 00:37:25 +00:00
README.txt cpp11-migrate: Add Replace-AutoPtr Transform 2013-07-03 13:21:24 +00:00
ReleaseNotes.rst [clang-tidy] MPIBufferDerefCheck 2016-08-12 19:30:31 +00:00
clang-modernize.rst Orphaning these RST files; each one is retained only for link backwards compatibility. 2015-12-28 19:59:15 +00:00
clang-rename.rst [Documentation] Improve consistency. 2016-08-10 22:00:49 +00:00
clang-tidy.rst [clang-tidy] Use relative URL for redirection. 2016-01-27 11:37:12 +00:00
conf.py docs/conf.py: update version to 4.0 2016-07-18 18:13:46 +00:00
cpp11-migrate.rst Orphaning these RST files; each one is retained only for link backwards compatibility. 2015-12-28 19:59:15 +00:00
doxygen-mainpage.dox [docs] Fix docs to work with doxygen 1.8.11 2016-03-03 10:45:59 +00:00
doxygen.cfg.in [clang-tidy] Fix doxygen errors. NFC. 2016-06-17 11:43:33 +00:00
include-fixer.rst [Documentation] Improve consistency. 2016-08-10 22:00:49 +00:00
index.rst [clang-rename] add documentation 2016-07-14 09:46:07 +00:00
make.bat
modularize.rst Fixing a sphinx warning. 2015-09-28 19:27:37 +00:00
pp-trace.rst fix some minor typos in the doc 2016-03-03 20:57:16 +00:00

README.txt

-------------------------------------------------------------
Documentation for the tools of clang-tools-extra repo project
-------------------------------------------------------------

Sphinx and doxygen documentation is generated by executing make.

Sphinx html files can be generated separately using make html.

Doxygen html files can also be generated using make doxygen.

The generated documentation will be placed in _build/html.