Skip to content

Commit

Permalink
Add headers to licenses code snippets (#364)
Browse files Browse the repository at this point in the history
  • Loading branch information
TuckerBMorgan committed Sep 2, 2021
1 parent 24b7cac commit b4b8cd4
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/src/checks/licenses/cfg.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,13 +201,15 @@ It's often not useful or wanted to check for licenses in your own private worksp
If `true`, workspace members will not have their license expression checked if they are not published.

```ini
# Cargo.toml
[package]
name = "sekret"
license = "¯\_(ツ)_/¯"
publish = false # "private"!
```

```ini
# deny.toml
[licenses]
# The sekret package would be ignored now
private = { ignore = true }
Expand All @@ -218,13 +220,15 @@ private = { ignore = true }
A list of private registries you may publish your workspace crates to. If a workspace member **only** publishes to private registries, it will also be ignored if `private.ignore = true`

```ini
# Cargo.toml
[package]
name = "sekret"
license = "¯\_(ツ)_/¯"
publish = ["sauce"]
```

```ini
# deny.toml
[licenses]
# Still ignored!
private = { ignore = true, registries = ["sauce"] }
Expand Down

0 comments on commit b4b8cd4

Please sign in to comment.