git.sesse.net Git - bcachefs-tools-debian/blob - README.md

   1 bcachefs-tools
   2 ==============
   3 Userspace tools and docs for bcachefs
   4
   5 Bcachefs is an advanced new filesystem for Linux, with an emphasis on reliability and robustness
   6 and the complete set of features one would expect from a modern filesystem.
   7
   8 This repo primarily consists of the following:
   9
  10 - bcachefs tool, the reason this repo exists.
  11 - {mkfs,mount,fsck}.bcachefs utils, which is just wrappers calling the corresponding subcommands
  12   in the main tool
  13 - docs in the form of man-pages and a user manual
  14
  15 Please refer to the main site for [getting started](https://bcachefs.org/#Getting_started)
  16 An in-depth user manual is (also) found on the [official website](https://bcachefs.org/#Documentation)
  17
  18 Version semantics
  19 -----------------
  20
  21 The tools relies on an expected disk format structure which is reflected by your current kernel version.
  22 Disk format can be upgraded or downgraded automatically by the kernel, if needed.
  23
  24 - Any patch-level change means no disk format change
  25 - Any minor-level change means a potential disk format change which **is not breaking**
  26 - Any major-level change means **breaking changes**
  27
  28 Build and install
  29 -----------------
  30
  31 Refer to [INSTALL.md](./INSTALL.md)
  32
  33 Bug reports and contributions
  34 -----------------------------
  35
  36 - The official mailing list, linux-bcachefs@vger.kernel.org
  37 - IRC: #bcache on OFTC (irc.oftc.net). Although, note that it can be easily missed.