Skip to content

Commit 3e01ed2

Browse files
authored
Document generateCompileCommands task better (wpilibsuite#2582)
Includes a warning about not being recommended for most users and mentions clangd
1 parent 3d85f8d commit 3e01ed2

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

source/docs/software/advanced-gradlerio/gradlew-tasks.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@ This article aims to highlight the gradle commands supported by the WPILib team
1010

1111
## CompileCommands tasks
1212

13-
``./gradlew generateCompileCommands`` - Generate compile_commands.json for C++ programs. This is a configuration file that is supported by many Integrated Development Environments and build tools.
13+
``./gradlew generateCompileCommands`` - Generate compile_commands.json for C++ programs. This is a configuration file that is used by clangd, which is supported by many Integrated Development Environments and build tools. This file will be saved in ``build/TargetedCompileCommands/targetplatformandbuildtype`` but needs to be moved to the root of your project. Many IDE's will have a way to specify where this file is found, which you can use instead if you desire. Make sure you have gitignored this file.
14+
15+
.. warning::
16+
Using compile commands isn't recommended for most users and has a variety of pitfalls compared to the built-in intellisense.
1417

1518
## DeployUtils tasks
1619

0 commit comments

Comments
 (0)