search

snowleopard / build

Build Systems à la Carte
MIT License
247 stars 18 forks source link

Out of date comment on `shake` #11

Closed pyrtsa closed 6 years ago

pyrtsa commented 6 years ago

The doc comment for shake talks about verifying traces while the implementation has moved to ST.

snowleopard commented 6 years ago

@pyrtsa Step traces (ST) is one type of verifying traces. Like other verifying traces, they support two operations: verify -- to check if a given key is up to date, and record -- to record the result of rebuilding a key.

VT is one of the most direct implementation of this interface, and ST is an optimised one.

It's certainly worth clarifying this in the docs, thank you!

snowleopard commented 6 years ago

I've added a clarification -- see the above commit.