From 70df1b9abefb4faead29e10d107539ffae92f497 Mon Sep 17 00:00:00 2001 From: Paolo Tranquilli Date: Fri, 10 Jan 2025 11:45:55 +0100 Subject: [PATCH] Rust: give more options for building in `README.md` --- rust/README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/rust/README.md b/rust/README.md index 2f9a7503abb..d2e77e2a001 100644 --- a/rust/README.md +++ b/rust/README.md @@ -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