salsa-rs / salsa

A generic framework for on-demand, incrementalized computation. Inspired by adapton, glimmer, and rustc's query system.
https://salsa-rs.netlify.app/
Apache License 2.0
2.14k stars 152 forks source link

book: Indicate Salsa version more clearly #448

Open oeb25 opened 1 year ago

oeb25 commented 1 year ago

At the moment the book is split between the two versions, with some some pages using salsa-2022 with a warning, some using salsa-2022 without a warning, and some using the non-salsa-2022 version.

For many pages without warning, the version can be guessed by looking for #[salsa::tracked] vs #[salsa::query_group(..)], but for pages like Tuning it can be hard to determine which version the text applies to.

While the book is in this in-between state, I would think it would be preferable to add the intended salsa version explicitly at the top to every document, although a bit verbose perhaps.

enomado commented 1 year ago

Same idea. Problem is even harder because there is no documentation on "old" version at all, except "use query_group examples in RA"

xffxff commented 1 year ago

Same idea. Problem is even harder because there is no documentation on "old" version at all

@oeb25 @enomado I have deployed the book for the older version from commit 754eea8b5f8a31b1100ba313d59e41260b494225 of Salsa. You can view it at https://old-salsa-rs.netlify.app/