pw_bluetooth_sapphire: Document clangd configuration

Bug: b/368654273 Change-Id: Ib04efff46f56fafe5c0a98b67a6bb86fdd1fefba Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/237412 Pigweed-Auto-Submit: Ben Lawson <[email protected]> Commit-Queue: Auto-Submit <[email protected]> Presubmit-Verified: CQ Bot Account <[email protected]> Lint: Lint 🤖 <[email protected]> Reviewed-by: Kayce Basques <[email protected]>
google · Sep 24, 2024 · 5bf0e36 · 5bf0e36
1 parent ca679a2
commit 5bf0e36
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/pw_bluetooth_sapphire/docs.rst b/pw_bluetooth_sapphire/docs.rst
@@ -76,6 +76,18 @@ Running tests
       You can also use ``pw watch`` if you install all the packages and set
       your GN args to match the `GN presubmit step`_.
 
+Clangd configuration
+====================
+Currently some manual steps are required to get clangd working with Fuchsia
+code (for example, for FIDL server files).
+
+1. Execute ``bazel run //:refresh_compile_commands_for_fuchsia_sdk`` to
+   generate ``compile_commands.json``. This needs to be done whenever the build
+   graph changes.
+2. Add this flag to your clangd configuration, fixing the full path to your
+   Pigweed checkout:
+   ``--compile-commands-dir=/path/to/pigweed/.compile_commands/fuchsia``
+
 ---------------
 Fuchsia support
 ---------------