This is an archive of the discontinued LLVM Phabricator instance.

How to set up clang tools for llvm
ClosedPublic

Authored by alexfh on Jul 10 2012, 10:41 AM.

Download Raw Diff

Details

Reviewers

klimek
djasper

Commits

rL160047: How to set up clang tools for llvm

Summary

How to guide for setting up clang tooling for llvm repo.

Diff Detail

Event Timeline

Looks good. A few nits here and there.

docs/HowToSetupToolingForLLVM.html
29	.. create a compilation ..
33–34	In either case you need to configure your build using CMake to use clang tools.
79	Add the section separators (<!-- =...= -->) around this as well.
81	... use the <a ...
82	... aimed at making ...
83	... using a development version ..
86	I'd remove "when this how-to is being written"..
97	... clone the Ninja ...
105	.. just be copied ...
111	... all of this ...
123	Really? "For lazy people"?

Let's see whether replying works...

Looks like inline comments don't work :(

Updated text as per djasper's comments.

Trying to remove unrelated diffs...

alexfh added inline comments.Jul 11 2012, 3:54 AM

docs/HowToSetupToolingForLLVM.html
29	Done.
33–34	Done.
79	Done.
81	Done.
82	Done.
83	Done.
86	Done.
97	Done.
105	Done.
111	Done.
123	Is this wrong? Anyway, to be more polite, I changed this to a more pleasant wording ;)

Can we add a short note on vim integration:

VIM integration **

Put this into your .vimrc:
set makeprg=clang-check\ %
map <F5> :make<CR><CR>

When editing C++ code, hit F5 to reparse the current buffer. The
output will go into the error window, which you can enable with :cope.

Added vim integration tips.

klimek accepted this revision.Jul 11 2012, 4:54 AM

alexfh closed this revision.Jul 11 2012, 7:27 AM

• HaoLiu mentioned this in D8242: [MachineCopyPropagation] Incorrect COPY removal in AArch64 backend.Mar 10 2015, 8:01 PM

nwilson mentioned this in D10528: [PATCH] [CONCEPTS] Parsing of concept keyword.Jun 18 2015, 8:16 PM

Diffusion mentioned this in rL267122: Add the D3 visualization library (https://d3js.org/).Apr 22 2016, 1:26 AM

Revision Contents

Path

Size

docs/

HowToSetupToolingForLLVM.html

150 lines

Diff 14

docs/HowToSetupToolingForLLVM.html

This file was added.

				<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
				"http://www.w3.org/TR/html4/strict.dtd">
				<html>
				<head>
				<title>How To Setup Clang Tooling For LLVM</title>
				<link type="text/css" rel="stylesheet" href="../menu.css">
				<link type="text/css" rel="stylesheet" href="../content.css">
				</head>
				<body>

				<!--#include virtual="../menu.html.incl"-->

				<div id="content">

				<h1>How To Setup Clang Tooling For LLVM</h1>
				<p>Clang Tooling provides infrastructure to write tools that need syntactic and
				semantic infomation about a program. This term also relates to a set of specific
				tools using this infrastructure (e.g. <code>clang-check</code>). This document
				provides information on how to set up and use Clang Tooling for the LLVM source
				code.</p>


				<!-- ======================================================================= -->
				<h2><a name="introduction">Introduction</a></h2>
				<!-- ======================================================================= -->

				<p>Clang Tooling needs a compilation database to figure out specific build
				options for each file. Currently it can create a compilation database from the
				<code>compilation_commands.json</code> file, generated by CMake. When invoking
				djasperUnsubmitted Not Done Reply Inline Actions .. create a compilation .. djasper: .. create a compilation ..
				alexfhAuthorUnsubmitted Not Done Reply Inline Actions Done. alexfh: Done.
				clang tools, you can either specify a path to a build directory using a command
				line parameter <code>-p</code> or let Clang Tooling find this file in your
				source tree. In either case you need to configure your build using CMake to use
				clang tools.</p>

				djasperUnsubmitted Not Done Reply Inline Actions In either case you need to configure your build using CMake to use clang tools. djasper: In either case you need to configure your build using CMake to use clang tools.
				alexfhAuthorUnsubmitted Not Done Reply Inline Actions Done. alexfh: Done.
				<!-- ======================================================================= -->
				<h2><a name="using-make">Setup Clang Tooling Using CMake and Make</a></h2>
				<!-- ======================================================================= -->

				<p>If you intend to use make to build LLVM, you should have CMake 2.8.6 or later
				installed (can be found <a href="http://cmake.org">here</a>).</p>
				<p>First, you need to generate Makefiles for LLVM with CMake. You need to make
				a build directory and run CMake from it:</p>
				<pre>
				mkdir your/build/directory
				cd your/build/directory
				cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON path/to/llvm/sources
				</pre>

				<p>If you want to use clang instead of GCC, you can add
				<code>-DCMAKE_C_COMPILER=/path/to/clang
				-DCMAKE_CXX_COMPILER=/path/to/clang++</code>.
				You can also use ccmake, which provides a curses interface to configure CMake
				variables for lazy people.</p>

				<p>As a result, the new <code>compile_commands.json</code> file should appear in
				the current directory. You should link it to the LLVM source tree so that Clang
				Tooling is able to use it:</p>
				<pre>
				ln -s $PWD/compile_commands.json path/to/llvm/source/
				</pre>

				<p>Now you are ready to build and test LLVM using make:</p>
				<pre>
				make check-all
				</pre>

				<!-- ======================================================================= -->
				<h2><a name="using-tools">Using Clang Tools</a></h2>
				<!-- ======================================================================= -->

				<p>After you completed the previous steps, you are ready to run clang tools. If
				you have a recent clang installed, you should have <code>clang-check</code> in
				$PATH. Try to run it on any .cpp file inside the LLVM source tree:</p>
				<pre>
				clang-check tools/clang/lib/Tooling/CompilationDatabase.cpp
				</pre>
				<p>If you're using vim, it's convenient to have clang-check integrated. Put this
				into your .vimrc:</p>
				<pre>
				djasperUnsubmitted Not Done Reply Inline Actions Add the section separators (<!-- =...= -->) around this as well. djasper: Add the section separators (<!-- =...= -->) around this as well.
				alexfhAuthorUnsubmitted Not Done Reply Inline Actions Done. alexfh: Done.
				set makeprg=clang-check\ %
				map <F5> :make<CR><CR>
				djasperUnsubmitted Not Done Reply Inline Actions ... use the <a ... djasper: ... use the <a ...
				alexfhAuthorUnsubmitted Not Done Reply Inline Actions Done. alexfh: Done.
				</pre>
				djasperUnsubmitted Not Done Reply Inline Actions ... aimed at making ... djasper: ... aimed at making ...
				alexfhAuthorUnsubmitted Not Done Reply Inline Actions Done. alexfh: Done.

				djasperUnsubmitted Not Done Reply Inline Actions ... using a development version .. djasper: ... using a development version ..
				alexfhAuthorUnsubmitted Not Done Reply Inline Actions Done. alexfh: Done.
				<p>When editing C++ code, hit F5 to reparse the current buffer. The output will
				go into the error window, which you can enable with <code>:cope</code>.</p>

				djasperUnsubmitted Not Done Reply Inline Actions I'd remove "when this how-to is being written".. djasper: I'd remove "when this how-to is being written"..
				alexfhAuthorUnsubmitted Not Done Reply Inline Actions Done. alexfh: Done.

				<!-- ======================================================================= -->
				<h2><a name="using-ninja">(Experimental) Using Ninja Build System</a></h2>
				<!-- ======================================================================= -->

				<p>Optionally you can use the <a
				href="https://github.com/martine/ninja">Ninja</a> build system instead of
				make. It is aimed at making your builds faster. Currently this step will require
				building Ninja from sources and using a development version of CMake.</p>
				<p>To take advantage of using Clang Tools along with Ninja build you need at
				least CMake 2.8.9. At the moment CMake 2.8.9 is still under development, so you
				djasperUnsubmitted Not Done Reply Inline Actions ... clone the Ninja ... djasper: ... clone the Ninja ...
				alexfhAuthorUnsubmitted Not Done Reply Inline Actions Done. alexfh: Done.
				can get latest development sources and build it yourself:</p>
				<pre>
				git clone git://cmake.org/cmake.git
				cd cmake
				./bootstrap
				make
				sudo make install
				</pre>
				djasperUnsubmitted Not Done Reply Inline Actions .. just be copied ... djasper: .. just be copied ...
				alexfhAuthorUnsubmitted Not Done Reply Inline Actions Done. alexfh: Done.

				<p>Having the correct version of CMake, you can clone the Ninja git repository
				and build Ninja from sources:</p>
				<pre>
				git clone git://github.com/martine/ninja.git
				cd ninja/
				djasperUnsubmitted Not Done Reply Inline Actions ... all of this ... djasper: ... all of this ...
				alexfhAuthorUnsubmitted Not Done Reply Inline Actions Done. alexfh: Done.
				./bootstrap.py
				</pre>
				<p>This will result in a single binary <code>ninja</code> in the current
				directory. It doesn't require installation and can just be copied to any
				location inside <code>$PATH</code>, say <code>/usr/local/bin/</code>:</p>
				<pre>
				sudo cp ninja /usr/local/bin/
				sudo chmod a+rx /usr/local/bin/ninja
				</pre>
				<p>After doing all of this, you'll need to generate Ninja build files for LLVM
				with CMake. You need to make a build directory and run CMake from it:</p>
				<pre>
				djasperUnsubmitted Not Done Reply Inline Actions Really? "For lazy people"? djasper: Really? "For lazy people"?
				alexfhAuthorUnsubmitted Not Done Reply Inline Actions Is this wrong? Anyway, to be more polite, I changed this to a more pleasant wording ;) alexfh: Is this wrong? Anyway, to be more polite, I changed this to a more pleasant wording ;)
				mkdir your/build/directory
				cd your/build/directory
				cmake -G Ninja -DCMAKE_EXPORT_COMPILE_COMMANDS=ON path/to/llvm/sources
				</pre>

				<p>If you want to use clang instead of GCC, you can add
				<code>-DCMAKE_C_COMPILER=/path/to/clang
				-DCMAKE_CXX_COMPILER=/path/to/clang++</code>.
				You can also use ccmake, which provides a curses interface to configure CMake
				variables in an interactive manner.</p>

				<p>As a result, the new <code>compile_commands.json</code> file should appear in
				the current directory. You should link it to the LLVM source tree so that Clang
				Tooling is able to use it:</p>
				<pre>
				ln -s $PWD/compile_commands.json path/to/llvm/source/
				</pre>

				<p>Now you are ready to build and test LLVM using Ninja:</p>
				<pre>
				ninja check-all
				</pre>
				<p>Other target names can be used in the same way as with make.</p>
				</div>
				</body>
				</html>