llvm-project/clang
Nathan Ridge 5233ad17e7 Compilation Database: Point Bazel users to a solution
This doc lists ways of getting compilation databases out of some popular build systems for use with clangd and other tooling.

We built such a way for Bazel and just released it after a bunch of requests on GitHub. Thought I should propose that we add a link to help people find it and use clang tooling.

(This is my first revision submitted via LLVM Phabricator, so if I've messed something up, I'd really appreciate your help and patience. Asking for a review from Sam McCall, because I've had a great time working with him elsewhere on GitHub before and because I saw him in the Git history for this file.)

Reviewed By: sammccall

Differential Revision: https://reviews.llvm.org/D114213
2021-11-28 19:30:06 -05:00
..
INPUTS
bindings Recommit: Compress formatting of array type names (int [4] -> int[4]) 2021-10-21 11:34:43 -07:00
cmake [Fuchsia][CMake] Don't set libcxxabi and libunwind variables on Windows 2021-11-11 19:29:39 -08:00
docs Compilation Database: Point Bazel users to a solution 2021-11-28 19:30:06 -05:00
examples [clang][driver] Add -fplugin-arg- to pass arguments to plugins 2021-11-25 10:47:55 +01:00
include [clang][deps] NFC: Extract function 2021-11-26 14:01:24 +01:00
lib [Driver] Support PowerPC SPE musl dynamic linker name ld-musl-powerpc-sf.so.1 2021-11-28 15:39:55 -08:00
runtime
test [Driver] Support PowerPC SPE musl dynamic linker name ld-musl-powerpc-sf.so.1 2021-11-28 15:39:55 -08:00
tools [clang] Allow clang-check to customize analyzer output file or dir name 2021-11-15 16:49:41 +01:00
unittests [clang][deps] NFC: Clean up wording (ignored vs minimized) 2021-11-26 12:18:37 +01:00
utils [NFC][clang]Inclusive language: remove remaining uses of sanity 2021-11-24 14:20:13 -05:00
www [NFC] Inclusive language: Remove instances of master in URLs 2021-11-05 08:48:41 -05:00
.clang-format
.clang-tidy
.gitignore
CMakeLists.txt [clang] Remove CLANG_ROUND_TRIP_CC1_ARGS and always roundtrip in +assert builds 2021-11-18 08:31:21 -05:00
CODE_OWNERS.TXT Add myself as a code owner for SYCL support 2021-09-20 09:32:25 +03:00
INSTALL.txt
LICENSE.TXT
ModuleInfo.txt
NOTES.txt
README.txt

README.txt

//===----------------------------------------------------------------------===//
// C Language Family Front-end
//===----------------------------------------------------------------------===//

Welcome to Clang.  This is a compiler front-end for the C family of languages
(C, C++, Objective-C, and Objective-C++) which is built as part of the LLVM
compiler infrastructure project.

Unlike many other compiler frontends, Clang is useful for a number of things
beyond just compiling code: we intend for Clang to be host to a number of
different source-level tools.  One example of this is the Clang Static Analyzer.

If you're interested in more (including how to build Clang) it is best to read
the relevant web sites.  Here are some pointers:

Information on Clang:             http://clang.llvm.org/
Building and using Clang:         http://clang.llvm.org/get_started.html
Clang Static Analyzer:            http://clang-analyzer.llvm.org/
Information on the LLVM project:  http://llvm.org/

If you have questions or comments about Clang, a great place to discuss them is
on the Clang development mailing list:
  http://lists.llvm.org/mailman/listinfo/cfe-dev

If you find a bug in Clang, please file it in the LLVM bug tracker:
  http://llvm.org/bugs/