From 11d2a45bc0d61f93e9aeea905606332f03d3e1c6 Mon Sep 17 00:00:00 2001 From: Raito Bezarius Date: Sat, 27 Jan 2024 02:51:11 +0100 Subject: [PATCH] doc(versioning): document version semantics of this project It's semantic versioning applied to bcachefs kernel data structures. Signed-off-by: Kent Overstreet --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 30149ab4..f95defa5 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,16 @@ This repo primarily consists of the following: Please refer to the main site for [getting started](https://bcachefs.org/#Getting_started) An in-depth user manual is (also) found on the [official website](https://bcachefs.org/#Documentation) +Version semantics +----------------- + +The tools relies on an expected disk format structure which is reflected by your current kernel version. +Disk format can be upgraded or downgraded automatically by the kernel, if needed. + +- Any patch-level change means no disk format change +- Any minor-level change means a potential disk format change which **is not breaking** +- Any major-level change means **breaking changes** + Build and install -----------------