summaryrefslogtreecommitdiffstats
path: root/build/clang-plugin/mozsearch-plugin/README
blob: d948e9aca3cf51c0e606ebacc483979ec9607df1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
This clang plugin code generates a JSON file for each compiler input
file. The JSON file contains information about the C++ symbols that
are referenced by the input file. The data is eventually consumed by
Searchfox. See https://github.com/mozsearch/mozsearch for more
information.

This plugin is enabled with the --enable-clang-plugin and
--enable-mozsearch-plugin mozconfig options. The output of the plugin
is stored in $OBJDIR/mozsearch_index.

This code is not a checker, unlike other parts of the Mozilla clang
plugin. It cannot be used with clang-tidy.