@@ -72,21 +72,6 @@ cmake . -DLLVM_CONFIG_EXECUTABLE=/usr/local/Cellar/llvm/<your_llvm_version>/bin/
72
72
make
73
73
```
74
74
75
- compile_commands.json
76
- =====================
77
- We need a compile_commands.json file to know how your project is usually compiled.
78
- There are multiple ways to get this file:
79
-
80
- * For cmake, pass -DCMAKE_EXPORT_COMPILE_COMMANDS=ON as a cmake parameter
81
- * For qmake, configure/autoconf and others, follow the instructions in scripts/fake_compiler.sh or scripts/woboq_cc.js.
82
- These are fake compilers that append the compiler invocation to the json file and forward to the real compiler.
83
- Your real compiler is overriden using the CC/CXX environment variables
84
- Make sure to have the json file properly terminated.
85
- * There is also a project called Build EAR (Bear) that achieves a similar thing as our fake compilers
86
- but is using LD_PRELOAD to inject itself into the build process to catch how the compiler is invoked.
87
- https://github.com/rizsotto/Bear
88
-
89
-
90
75
Using the generator
91
76
===================
92
77
@@ -152,7 +137,9 @@ codebrowser_generator -a -o <output_dir> -b <buld_dir> -p <projectname>:<source_
152
137
153
138
-o with the output directory where the generated files will be put
154
139
155
- -b the "build directory" containing the compile_commands.json
140
+ -b the "build directory" containing the compile_commands.json If this argument
141
+ is not passed, the compilation arguments can be passed on the command line
142
+ after --
156
143
157
144
-p (one or more) with project specification. That is the name of the project,
158
145
the absolute path of the source code, and the revision separated by colons
@@ -183,6 +170,23 @@ codebrowser_indexgenerator <output_dir> [-d data_url] [-p project_definition]
183
170
default to ../data relative to the output dir
184
171
example: -d https://code.woboq.org/data
185
172
173
+ Compilation Database
174
+ ====================
175
+ The generator is a tool which uses clang's LibTooling. It needs either a
176
+ compile_commands.json or the arguments to be passed after '--' if they are
177
+ the same for every file.
178
+
179
+ To generate the compile_commands.json:
180
+ * For cmake, pass -DCMAKE_EXPORT_COMPILE_COMMANDS=ON as a cmake parameter
181
+ * For qmake, configure/autoconf and others, follow the instructions in scripts/fake_compiler.sh or scripts/woboq_cc.js.
182
+ These are fake compilers that append the compiler invocation to the json file and forward to the real compiler.
183
+ Your real compiler is overriden using the CC/CXX environment variables
184
+ Make sure to have the json file properly terminated.
185
+ * There is also a project called Build EAR (Bear) that achieves a similar thing as our fake compilers
186
+ but is using LD_PRELOAD to inject itself into the build process to catch how the compiler is invoked.
187
+ https://github.com/rizsotto/Bear
188
+
189
+
186
190
187
191
Getting help
188
192
============
0 commit comments