Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve discoverability of --compiledb flag #24930

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Conversation

Jari27
Copy link

@Jari27 Jari27 commented Feb 18, 2025

Description

Add documentation for the compiledb flag.

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout (addition or update)
  • Documentation

Issues Fixed or Closed by This PR

Checklist

  • My code follows the code style of this project: C, Python
  • I have read the PR Checklist document and have made the appropriate changes.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

Jari27 and others added 2 commits February 18, 2025 20:39
Helps users of the external userspace discover how to generate the compile_commands.json file so their language server can provide more functionalities (e.g. jump to references, jump to definition, etc.).
@Jari27
Copy link
Author

Jari27 commented Feb 19, 2025

Updated the text based on comments on discord.

@Jari27 Jari27 marked this pull request as draft February 28, 2025 18:47
@Jari27 Jari27 marked this pull request as ready for review February 28, 2025 18:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant