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

Improving the doc of disabling safety checks #3370

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions docs/src/pages/docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,13 @@ anchor build

Builds programs in the workspace targeting Solana's BPF runtime and emitting IDLs in the `target/idl` directory.


```shell
anchor build --skip-lint
```

Disables [Safety Checks](/docs/the-accounts-struct#safety-checks) during the build process.

```shell
anchor build --verifiable
```
Expand Down Expand Up @@ -283,6 +290,12 @@ anchor test
Run an integration test suit against the configured cluster, deploying new versions
of all workspace programs before running them.

```shell
anchor test --skip-lint
```

Similar to `anchor build`, `--skip-lint` option disables [Safety Checks](/docs/the-accounts-struct#safety-checks).

If the configured network is a localnet, then automatically starts the localnetwork and runs
the test.

Expand Down
12 changes: 12 additions & 0 deletions docs/src/pages/docs/manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,18 @@ Example:
resolution = true
```

#### skip-lint

This disables the safety checks globally. The default is `false`.

Example:

```
[features]
skip-lint = true
```
See [Safety Checks](/docs/the-accounts-struct#safety-checks) for more information.

## workspace

#### types
Expand Down
17 changes: 17 additions & 0 deletions docs/src/pages/docs/the-accounts-struct.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,23 @@ pub struct Initialize<'info> {
The doc comment needs to be a [line or block doc comment](https://doc.rust-lang.org/reference/comments.html#doc-comments) (/// or /\*\*) to be interpreted as doc attribute by Rust. Double slash comments (//) are not interpreted as such.
{% /callout %}

### Disabling safety checks

For purposes like quick prototyping, you can disable the safety checks by appending the `--skip-lint` option to Anchor CLI commands:

```bash
anchor build --skip-lint
# or
anchor test --skip-lint
```

Or, you can disable the safety checks globally by setting `skip-lint` to `true` in the `[features]` section of your `Anchor.toml` file.

```toml
[features]
skip-lint = true
```

## Other Resources

- [Solana Cookbook](https://solanacookbook.com/core-concepts/accounts.html)
2 changes: 2 additions & 0 deletions lang/syn/src/parser/context.rs
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ impl CrateContext {
{}:{}:{}
Struct field "{}" is unsafe, but is not documented.
Please add a `/// CHECK:` doc comment explaining why no checks through types are necessary.
Alternatively, for reasons like quick prototyping, you may disable the safety checks
by using the `skip-lint` option.
See https://www.anchor-lang.com/docs/the-accounts-struct#safety-checks for more information.
"#,
ctx.file.canonicalize().unwrap().display(),
Expand Down