From 1bb320fe62c80aecf30e8f007205918087de5fde Mon Sep 17 00:00:00 2001 From: Isaac van Bakel Date: Wed, 19 Jul 2023 17:27:46 +0200 Subject: [PATCH] docs: origin_live_at -> origin_live_on_entry This rule was renamed a while ago, but the old name lived on in the documentation, which made it a bit confusing. This updates the rule name in the docs so it matches the one in the code. --- book/src/rules/relations.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/book/src/rules/relations.md b/book/src/rules/relations.md index 4612a3fce7..e64ece0d4a 100644 --- a/book/src/rules/relations.md +++ b/book/src/rules/relations.md @@ -122,9 +122,9 @@ let b: &u32 = &a; To be valid, this last expression requires that the type `&'a u32` is a subtype of `&'b u32`. This requires `'a: 'b` and the `subset_base` relation will contain this basic fact that `'a` outlives / is a subset of / flows into `'b` at this point. -### 6. `origin_live_at` +### 6. `origin_live_on_entry` -`origin_live_at(origin, point)`: this relation stores that the origin `origin` appears in a live variable at the point `point`. +`origin_live_on_entry(origin, point)`: this relation stores that the origin `origin` appears in a live variable at the point `point`. These facts are created by the liveness computation, and its facts and relations will be described later in a lot more detail. In the meantime, its implementation is in [liveness.rs here](https://github.com/rust-lang/polonius/blob/master/polonius-engine/src/output/liveness.rs).