pvf: Update docs for PVF artifacts (#6551)

* pvf: Update docs for PVF artifacts

* pvf: Clarify doc re. node start-up
This commit is contained in:
Marcin S
2023-04-19 18:08:01 +02:00
committed by GitHub
parent 116619661f
commit b3e2153f2f
3 changed files with 46 additions and 7 deletions
+4 -6
View File
@@ -72,14 +72,12 @@
//! ## Artifacts
//!
//! An artifact is the final product of preparation. If the preparation succeeded, then the artifact
//! will contain the compiled code usable for quick execution by a worker later on.
//!
//! If the preparation failed, then the worker will still write the artifact with the error message.
//! We save the artifact with the error so that we don't try to prepare the artifacts that are broken
//! repeatedly.
//! will contain the compiled code usable for quick execution by a worker later on. If the
//! preparation failed, then no artifact is created.
//!
//! The artifact is saved on disk and is also tracked by an in memory table. This in memory table
//! doesn't contain the artifact contents though, only a flag that the given artifact is compiled.
//! doesn't contain the artifact contents though, only a flag for the state of the given artifact
//! and some associated data. If the artifact failed to process, this also includes the error.
//!
//! A pruning task will run at a fixed interval of time. This task will remove all artifacts that
//! weren't used or received a heads up signal for a while.