Skip to content

Commit b9b4e62

Browse files
authored
Merge pull request #175 from Pennycook/docs/rsp-files
Recommend using cmake -G Ninja in the tutorial
2 parents 630732e + d57a9f6 commit b9b4e62

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/source/compilation-databases.rst

+9-1
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,19 @@ obtain a compilation database for the CPU:
5454
.. code :: sh
5555
5656
$ mkdir build-cpu
57-
$ cmake ../
57+
$ cmake -G Ninja ../
5858
$ ls
5959
6060
CMakeCache.txt CMakeFiles Makefile cmake_install.cmake compile_commands.json
6161
62+
.. tip::
63+
Using the "Ninja" generator is not required, but is often faster and can
64+
improve the quality of CBI's results. Other generators (such as "Unix
65+
Makefiles") may use response (:code:`.rsp`) files to pass command-line
66+
options, and any options passed this way will not be respected by CBI.
67+
You may need to install Ninja on your system (e.g., with :code:`pip install
68+
ninja` or similar).
69+
6270
This :code:`compile_commands.json` file includes all the commands required to
6371
build the code, corresponding to the commands that would be executed if we were
6472
to actually run :code:`make`.

0 commit comments

Comments
 (0)