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.

Sign up for GitHub

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

Jump to bottom

add compile_commands.json to .gitignore #1754

Merged
merged 1 commit into from
Apr 16, 2024
Merged

add compile_commands.json to .gitignore #1754

merged 1 commit into from
Apr 16, 2024

Conversation

carsonRadtke
Copy link
Contributor

We set CMAKE_EXPORT_COMPILE_COMMANDS=ON so the compilation database is automatically exported to the build directory. However, many language servers expect this file to be in the project root directory, so a common post-build step is to:

$ ln -s <build-directory>/compile_commands.json

This PR enables developers to do this without having to worry about accidentally commiting a symlink file.

  • Does this PR change the input/output behaviour of a cryptographic algorithm (i.e., does it change known answer test values)? (If so, a version bump will be required from x.y.z to x.(y+1).0.)
  • Does this PR change the list of algorithms available -- either adding, removing, or renaming? Does this PR otherwise change an API? (If so, PRs in fully supported downstream projects dependent on these, i.e., oqs-provider will also need to be ready for review and merge by the time this is merged.)

@carsonRadtke carsonRadtke force-pushed the update-gitignore branch 5 times, most recently from ce2379f to d1e408d Compare April 14, 2024 01:38
@carsonRadtke
add compile_commands.json to .gitignore
b313b00 
We set CMAKE_EXPORT_COMPILE_COMMANDS=ON so the compilation database is
automatically exported to the build directory. However, many language
servers expect this file to be in the project root directory, so a common
post-build step is to:

```shell
$ ln -s <build-directory>/compile_commands.json
```

This PR enables developers to do this without having to worry about
accidentally commiting a symlink file.

Signed-off-by: carson radtke <nosrac925@gmail.com>
SWilson4
SWilson4 approved these changes Apr 15, 2024
View reviewed changes
Copy link
Member

@SWilson4 SWilson4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have no objection to this. Thanks for the contribution!

@dstebila dstebila merged commit 7b6d9f3 into open-quantum-safe:main Apr 16, 2024
11 checks passed
@carsonRadtke carsonRadtke deleted the update-gitignore branch April 16, 2024 01:18
@BrewTestBot BrewTestBot mentioned this pull request Sep 27, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SWilson4 SWilson4 SWilson4 approved these changes

@dstebila dstebila dstebila approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@carsonRadtke @dstebila @SWilson4