Skip to content

Commit 6190289

Browse files
committed
[determinator] small update to readme
Minor wording update.
1 parent eb376fc commit 6190289

File tree

4 files changed

+18
-16
lines changed

4 files changed

+18
-16
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,12 @@
55

66
This repository contains the source code for:
77
* [`guppy`](guppy): a library for performing queries on Cargo dependency graphs [![guppy on crates.io](https://img.shields.io/crates/v/guppy)](https://crates.io/crates/guppy) [![Documentation (latest release)](https://docs.rs/guppy/badge.svg)](https://docs.rs/guppy/) [![Documentation (master)](https://img.shields.io/badge/docs-master-59f)](https://facebookincubator.github.io/cargo-guppy/rustdoc/guppy/)
8-
* [`guppy-summaries`](guppy-summaries): a library for managing build summaries listing packages and features [![guppy-summaries on crates.io](https://img.shields.io/crates/v/guppy-summaries)](https://crates.io/crates/guppy-summaries) [![Documentation (latest release)](https://docs.rs/guppy-summaries/badge.svg)](https://docs.rs/guppy/) [![Documentation (master)](https://img.shields.io/badge/docs-master-59f)](https://facebookincubator.github.io/cargo-guppy/rustdoc/guppy_summaries/)
9-
* [`cargo-guppy`](cargo-guppy): a command-line frontend for the `guppy` library [![Documentation (master)](https://img.shields.io/badge/docs-master-59f)](https://facebookincubator.github.io/cargo-guppy/rustdoc/cargo_guppy/)
10-
* [`target-spec`](target-spec): an evaluator for `Cargo.toml` target specifications [![target-spec on crates.io](https://img.shields.io/crates/v/target-spec)](https://crates.io/crates/target-spec) [![Documentation (latest release)](https://docs.rs/target-spec/badge.svg)](https://docs.rs/target-spec/) [![Documentation (master)](https://img.shields.io/badge/docs-master-59f)](https://facebookincubator.github.io/cargo-guppy/rustdoc/target_spec/)
11-
* [`determinator`](tools/determinator): figure out what packages changed between two revisions [![determinator on crates.io](https://img.shields.io/crates/v/determinator)](https://crates.io/crates/determinator) [![Documentation (latest release)](https://docs.rs/determinator/badge.svg)](https://docs.rs/determinator/) [![Documentation (master)](https://img.shields.io/badge/docs-master-59f)](https://facebookincubator.github.io/cargo-guppy/rustdoc/determinator/)
8+
* libraries used by guppy:
9+
* [`guppy-summaries`](guppy-summaries): a library for managing build summaries listing packages and features [![guppy-summaries on crates.io](https://img.shields.io/crates/v/guppy-summaries)](https://crates.io/crates/guppy-summaries) [![Documentation (latest release)](https://docs.rs/guppy-summaries/badge.svg)](https://docs.rs/guppy/) [![Documentation (master)](https://img.shields.io/badge/docs-master-59f)](https://facebookincubator.github.io/cargo-guppy/rustdoc/guppy_summaries/)
10+
* [`target-spec`](target-spec): an evaluator for `Cargo.toml` target specifications [![target-spec on crates.io](https://img.shields.io/crates/v/target-spec)](https://crates.io/crates/target-spec) [![Documentation (latest release)](https://docs.rs/target-spec/badge.svg)](https://docs.rs/target-spec/) [![Documentation (master)](https://img.shields.io/badge/docs-master-59f)](https://facebookincubator.github.io/cargo-guppy/rustdoc/target_spec/)
11+
* tools built on top of guppy:
12+
* [`determinator`](tools/determinator): figure out what packages changed between two revisions [![determinator on crates.io](https://img.shields.io/crates/v/determinator)](https://crates.io/crates/determinator) [![Documentation (latest release)](https://docs.rs/determinator/badge.svg)](https://docs.rs/determinator/) [![Documentation (master)](https://img.shields.io/badge/docs-master-59f)](https://facebookincubator.github.io/cargo-guppy/rustdoc/determinator/)
13+
* [`cargo-guppy`](cargo-guppy): a command-line frontend for the `guppy` library [![Documentation (master)](https://img.shields.io/badge/docs-master-59f)](https://facebookincubator.github.io/cargo-guppy/rustdoc/cargo_guppy/)
1214
* and a number of [internal tools](internal-tools) and [test fixtures](fixtures) used to verify that `guppy` behaves correctly.
1315

1416
## Use cases

tools/determinator/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -199,11 +199,11 @@ dependencies if they're in the same repository.
199199

200200
## Alternatives and tradeoffs
201201

202-
One way to look at the determinator is through the lens of *cache invalidation*.
203-
Viewed through this lens, the main purpose of a build or test system is to cache results, and
204-
[invalidate those caches](https://martinfowler.com/bliki/TwoHardThings.html) based on certain
205-
parameters. When the determinator marks a package as changed, it invalidates any cached results
206-
for that package.
202+
One way to look at the determinator is as a kind of
203+
[*cache invalidation*](https://martinfowler.com/bliki/TwoHardThings.html). Viewed through this
204+
lens, the main purpose of a build or test system is to cache results, and invalidate those
205+
caches based on certain parameters. When the determinator marks a package as changed, it
206+
invalidates any cached results for that package.
207207

208208
There are several other ways to design caching systems:
209209
* The caching built into Cargo and other systems like GNU Make, which is based on file
@@ -241,7 +241,7 @@ Facebook's main source repository.
241241

242242
## Contributing
243243

244-
See the [CONTRIBUTING](../CONTRIBUTING.md) file for how to help out.
244+
See the [CONTRIBUTING](../../CONTRIBUTING.md) file for how to help out.
245245

246246
## License
247247

tools/determinator/README.tpl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## Contributing
88

9-
See the [CONTRIBUTING](../CONTRIBUTING.md) file for how to help out.
9+
See the [CONTRIBUTING](../../CONTRIBUTING.md) file for how to help out.
1010

1111
## License
1212

tools/determinator/src/lib.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -200,11 +200,11 @@
200200
//!
201201
//! # Alternatives and tradeoffs
202202
//!
203-
//! One way to look at the determinator is through the lens of *cache invalidation*.
204-
//! Viewed through this lens, the main purpose of a build or test system is to cache results, and
205-
//! [invalidate those caches](https://martinfowler.com/bliki/TwoHardThings.html) based on certain
206-
//! parameters. When the determinator marks a package as changed, it invalidates any cached results
207-
//! for that package.
203+
//! One way to look at the determinator is as a kind of
204+
//! [*cache invalidation*](https://martinfowler.com/bliki/TwoHardThings.html). Viewed through this
205+
//! lens, the main purpose of a build or test system is to cache results, and invalidate those
206+
//! caches based on certain parameters. When the determinator marks a package as changed, it
207+
//! invalidates any cached results for that package.
208208
//!
209209
//! There are several other ways to design caching systems:
210210
//! * The caching built into Cargo and other systems like GNU Make, which is based on file

0 commit comments

Comments
 (0)