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

Rust: give more options for building in README.md #18468

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+23 −2
Open

Rust: give more options for building in README.md #18468

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
70df1b9
Rust: give more options for building in `README.md`
redsun82 Jan 10, 2025
7c0409d
Rust: add instructions for `codegen` in `README.md`
redsun82 Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions rust/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,18 @@ If you don't have the `semmle-code` repo you may need to install Bazel manually,

### Building the Rust Extractor

This approach uses a released `codeql` version and is simpler to use for QL development. From your `semmle-code` directory run:
This approach uses a released `codeql` version and is simpler to use for QL development. From anywhere under your `semmle-code` or `codeql` directory you can run:
```bash
bazel run @codeql//rust:install
```

You can use shorter versions of the above command:
```bash
bazel run //rust:install # if under the `codeql` checkout
bazel run rust:install # if at the root of the `codeql` checkout
bazel run :install # if at the `rust` directory of the `codeql` checkout
```

You now need to create a [per-user CodeQL configuration file](https://docs.github.com/en/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/specifying-command-options-in-a-codeql-configuration-file#using-a-codeql-configuration-file) and specify the option:
```
--search-path PATH/TO/semmle-code/ql
Expand All @@ -40,4 +48,17 @@ TODO

### Code Generation

TODO
If you do changes to either
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
If you do changes to either
If you make changes to either

* `ast-generator`, or
Copy link
Contributor

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?

Suggested change
* `ast-generator`, or
* `ast-generator/`, or

* `schema/*.py`

you'll need to regenerate code. You can do so running
```bash
Copy link
Contributor

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.

Suggested change
```bash
```sh

bazel run @codeql//rust/codegen
```

Sometimes, especially if resolving conflicts on generated files, you might need to run
```bash
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
```bash
```sh

bazel run @codeql//rust/codegen -- --force
Copy link
Contributor

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.

```
for code generation to succeed.
Loading