alex/bcachefs-tools
1
0
Fork 0
mirror of https://github.com/koverstreet/bcachefs-tools.git synced 2025-01-22 00:04:31 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc(versioning): document version semantics of this project

Browse Source 
It's semantic versioning applied to bcachefs kernel data structures.

Signed-off-by: Kent Overstreet <kent.overstreet@linux.dev>
This commit is contained in:
Raito Bezarius 2024-01-27 02:51:11 +01:00 committed by Kent Overstreet
parent 5787b1c234
commit 11d2a45bc0
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -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
-----------------