Skip to content

Commit

Permalink
docs: Add info on updating dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
markgoddard committed Sep 12, 2024
1 parent ba4695b commit 2a1784c
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,3 +199,17 @@ cargo doc --no-deps
```

The resulting documentation is available under `target/doc`, and may be viewed in a web browser using file:///path/to/reductionist/target/doc/reductionist/index.html.

---

## Maintenance

### Updating dependencies

Rust package dependencies are managed by [Cargo](https://doc.rust-lang.org/cargo/).
The `[dependencies]` section in `Cargo.toml` defines package dependencies and their version constraints.
The `[dev-dependencies]` section includes additional dependencies for testing.
In order to make builds reproducible, Cargo maintains a `Cargo.lock` file that captures the versions of all package dependencies.
This even allows for multiple versions of a package to be used by a single Rust application, although this can lead to incompatibilities at runtime and should be avoided if possible.

To update the versions in the `Cargo.lock` file, run `cargo update`, then inspect and commit the changes.

0 comments on commit 2a1784c

Please sign in to comment.