Skip to main content

Module project_format

Module project_format 

Source
Expand description

The project format: .overbrainer/version, one integer line naming the layout of the project’s files. A project without it predates 0.4.0, whose format is 1; overbrainer migrate brings it up to date.

Constants§

CURRENT
The format this overbrainer writes and reads.
VERSION_FILE
File name of the format version in the state directory.

Functions§

predates_versions
Whether project_dir holds a project (overbrainer.toml) from before 0.4.0: no .overbrainer/version. An unreadable version says no.
read
The format of the project in project_dir, None when it has no .overbrainer/version (a project from before 0.4.0).
write_current
Writes CURRENT into .overbrainer/version, atomically.