Skip to content

Commit 2aa3f6c

Browse files
committed
Move config to root, not under contrib
1 parent 83680d9 commit 2aa3f6c

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

cargo-rbmt/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ Maintainer tools for Rust-based projects in the Bitcoin domain. Built with [xshe
44

55
## Configuration
66

7-
Configuration for `rbmt` is stored in `contrib/rbmt.toml`. The file can live at both the workspace root (e.g. `$ROOT/contrib/rbmt.toml`) as well as per-crate (e.g. `$ROOT/$CRATE/contrib/rbmt.toml`) within a repository.
7+
Configuration for `rbmt` is stored in `rbmt.toml`. The file can live at both the workspace root (e.g. `$ROOT/rbmt.toml`) as well as per-package (e.g. `$ROOT/$PACKAGE/rbmt.toml`) within a repository.
88

99
### Lint
1010

11-
The `lint` command detects duplicate dependencies, but some may be unavoidable (e.g., during dependency updates where transitive dependencies haven't caught up). Configure the `[lint]` section to whitelist specific duplicates for a workspace (or a crate if only one crate in a repository).
11+
The `lint` command detects duplicate dependencies, but some may be unavoidable (e.g., during dependency updates where transitive dependencies haven't caught up). Configure the `[lint]` section to whitelist specific duplicates for a workspace (or a package if only one package in a repository).
1212

1313
```toml
1414
[lint]
@@ -20,7 +20,7 @@ allowed_duplicates = [
2020

2121
### Test
2222

23-
The `test` command can be configured to run feature matrix testing for your crate. Configure with the `contrib/rbmt.toml` file at the crate level.
23+
The `test` command can be configured to run feature matrix testing for your package. Configure with the `rbmt.toml` file at the package level.
2424

2525
```toml
2626
[test]
@@ -42,7 +42,7 @@ features_with_std = ["serde", "rand"]
4242
features_without_std = ["serde", "rand"]
4343

4444
# Exact feature combinations to test.
45-
# Use for crates that don't follow conventional `std` patterns.
45+
# Use for packages that don't follow conventional `std` patterns.
4646
# Each inner array is tested as-is with no automatic combinations.
4747
# Example: [["serde", "rand"], ["rand"]] tests exactly those two combinations
4848
exact_features = [
@@ -51,7 +51,7 @@ exact_features = [
5151
]
5252

5353
# Features to test with an explicit `no-std` feature enabled.
54-
# Only use if your crate has a `no-std` feature (rust-miniscript pattern).
54+
# Only use if your package has a `no-std` feature (rust-miniscript pattern).
5555
# Tests each feature with no-std, all pairs, and all together.
5656
# Example: ["serde", "rand"] tests: no-std+serde, no-std+rand, no-std+serde+rand
5757
features_with_no_std = ["serde", "rand"]
@@ -63,7 +63,7 @@ features_with_no_std = ["serde", "rand"]
6363

6464
## Lock Files
6565

66-
To ensure your crate works with the full range of declared dependency versions, `cargo-rbmt` requires two lock files in your repository.
66+
To ensure your package works with the full range of declared dependency versions, `cargo-rbmt` requires two lock files in your repository.
6767

6868
* `Cargo-minimal.lock` - Minimum versions that satisfy your dependency constraints.
6969
* `Cargo-recent.lock` - Recent/updated versions of dependencies.
@@ -100,9 +100,9 @@ When you specify `--lock-file`, the tool copies that lock file to `Cargo.lock` b
100100

101101
## Workspace Integration
102102

103-
`cargo-rbmt` can simply be installed globally, or as a dev-dependency for more granular control of dependency versions.
103+
`cargo-rbmt` can simply be installed globally on a system or added as a dev-dependency to a package.
104104

105-
### 1. Install globally
105+
### 1. Install on system
106106

107107
Install the tool globally on your system with `cargo install`.
108108

cargo-rbmt/src/environment.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ use xshell::{cmd, Shell};
77
const LOG_LEVEL_ENV_VAR: &str = "RBMT_LOG_LEVEL";
88

99
/// Path to the RBMT configuration file relative to workspace/crate root.
10-
pub const CONFIG_FILE_PATH: &str = "contrib/rbmt.toml";
10+
pub const CONFIG_FILE_PATH: &str = "rbmt.toml";
1111

1212
/// Check if we're in quiet mode via environment variable.
1313
pub fn is_quiet_mode() -> bool {

cargo-rbmt/src/lint.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use crate::environment::{get_crate_dirs, quiet_println, CONFIG_FILE_PATH};
55
use crate::quiet_cmd;
66
use crate::toolchain::{check_toolchain, Toolchain};
77

8-
/// Lint configuration loaded from contrib/rbmt.toml.
8+
/// Lint configuration loaded from rbmt.toml.
99
#[derive(Debug, serde::Deserialize, Default)]
1010
#[serde(default)]
1111
struct Config {

cargo-rbmt/src/test.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ use serde::Deserialize;
77
use std::path::Path;
88
use xshell::Shell;
99

10-
/// Test configuration loaded from contrib/rbmt.toml.
10+
/// Test configuration loaded from rbmt.toml.
1111
#[derive(Debug, Deserialize, Default)]
1212
#[serde(default)]
1313
struct Config {

0 commit comments

Comments
 (0)