-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Rust: give more options for building in README.md
#18468
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.
Tip: If you use Visual Studio Code, you can request a review from Copilot before you push from the "Source Control" tab. Learn more
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Really nice to have better docs 😃
I've left a few minor comments.
@@ -40,4 +48,17 @@ TODO | |||
|
|||
### Code Generation | |||
|
|||
TODO | |||
If you do changes to either |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you do changes to either | |
If you make changes to either |
@@ -40,4 +48,17 @@ TODO | |||
|
|||
### Code Generation | |||
|
|||
TODO | |||
If you do changes to either | |||
* `ast-generator`, or |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps this will make it a bit clearer that it's talking about a directory?
* `ast-generator`, or | |
* `ast-generator/`, or |
* `schema/*.py` | ||
|
||
you'll need to regenerate code. You can do so running | ||
```bash |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mega nitpick, but I think it's cleaner to use sh
for things that works in any shell and not just Bash.
```bash | |
```sh |
``` | ||
|
||
Sometimes, especially if resolving conflicts on generated files, you might need to run | ||
```bash |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
```bash | |
```sh |
|
||
Sometimes, especially if resolving conflicts on generated files, you might need to run | ||
```bash | ||
bazel run @codeql//rust/codegen -- --force |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Really great to have this documented 👍. I struggled with that until I found the --force
flag.
No description provided.