This is an archive of the discontinued LLVM Phabricator instance.

Differential D116882

[docs] [clang] Small documentation change for compilation databases
ClosedPublic

Authored by croepha on Jan 9 2022, 12:56 AM.

Download Raw Diff

Details

Reviewers

joerg

Commits

rGb8467952404c: [docs] [clang] Small documentation change for compilation databases

Summary

We have an page dedicated to compliation databases including
various ways to generate them, but we don't mention that clang
has a built in method to do this. This addresses that.

Diff Detail

Repository: rG LLVM Github Monorepo

Event Timeline

croepha requested review of this revision.Jan 9 2022, 12:56 AM

croepha created this revision.

Herald added a project: Restricted Project. · View Herald TranscriptJan 9 2022, 12:56 AM

Herald added a subscriber: cfe-commits. · View Herald Transcript

Harbormaster completed remote builds in B142274: Diff 398400.Jan 9 2022, 1:58 AM

croepha added a reviewer: joerg.Jan 9 2022, 2:05 AM

https://sarcasm.github.io/notes/dev/compilation-database.html#clang

joerg accepted this revision.Jan 9 2022, 1:30 PM

joerg added inline comments.

clang/docs/JSONCompilationDatabase.rst
33	I think you mean "concatenate", but otherwise LGTM?

This revision is now accepted and ready to land.Jan 9 2022, 1:30 PM

Fixed spelling

croepha marked an inline comment as done.Jan 9 2022, 4:06 PM

croepha added inline comments.

clang/docs/JSONCompilationDatabase.rst
33	Yes, thank you

Harbormaster completed remote builds in B142331: Diff 398468.Jan 9 2022, 4:48 PM

Hey, @joerg I don't have commit access, would you mind landing this for me?

Closed by commit rGb8467952404c: [docs] [clang] Small documentation change for compilation databases (authored by croepha, committed by smeenai). · Explain WhyJan 22 2022, 5:42 PM

This revision was automatically updated to reflect the committed changes.

smeenai added a commit: rGb8467952404c: [docs] [clang] Small documentation change for compilation databases.

Revision Contents

Path

Size

clang/

docs/

JSONCompilationDatabase.rst

4 lines

Diff 398400

clang/docs/JSONCompilationDatabase.rst

Show All 23 Lines	- Build systems are inherently sequential in the build graph, for
independently of the build still need the generated source code to		independently of the build still need the generated source code to
exist, running tools multiple times over unchanging source does not		exist, running tools multiple times over unchanging source does not
require serialization of the runs according to the build dependency		require serialization of the runs according to the build dependency
graph.		graph.

Supported Systems		Supported Systems
=================		=================

		Clang has the ablity to generate compilation database fragments via
		the :option:`-MJ argument <clang -MJ\<arg>>`. You can contantinate those
		joergUnsubmitted Done Reply Inline Actions I think you mean "concatenate", but otherwise LGTM? joerg: I think you mean "concatenate", but otherwise LGTM?
		croephaAuthorUnsubmitted Done Reply Inline Actions Yes, thank you croepha: Yes, thank you
		fragments together between ``[`` and ``]`` to create a compilation database.

Currently `CMake <https://cmake.org>`_ (since 2.8.5) supports generation		Currently `CMake <https://cmake.org>`_ (since 2.8.5) supports generation
of compilation databases for Unix Makefile builds (Ninja builds in the		of compilation databases for Unix Makefile builds (Ninja builds in the
works) with the option ``CMAKE_EXPORT_COMPILE_COMMANDS``.		works) with the option ``CMAKE_EXPORT_COMPILE_COMMANDS``.

For projects on Linux, there is an alternative to intercept compiler		For projects on Linux, there is an alternative to intercept compiler
calls with a tool called `Bear <https://github.com/rizsotto/Bear>`_.		calls with a tool called `Bear <https://github.com/rizsotto/Bear>`_.

`Bazel <https://bazel.build>`_ can export a compilation database via		`Bazel <https://bazel.build>`_ can export a compilation database via
▲ Show 20 Lines • Show All 78 Lines • Show Last 20 Lines