Go to file
David Sterba 3793e987d2
Btrfs progs v6.8
Signed-off-by: David Sterba <dsterba@suse.com>
2024-03-26 15:18:02 +01:00
.github/workflows btrfs-progs: ci: save test logs to artifacts on failure 2024-01-31 18:35:31 +01:00
Documentation btrfs-progs: docs: update memory related problems 2024-03-25 23:33:25 +01:00
check btrfs-progs: check: make all transaction start failures verbose 2024-03-16 23:14:02 +01:00
ci btrfs-progs: ci: add script to delete runs of a branch 2024-01-31 18:47:29 +01:00
cmds btrfs-progs: prop set: enhance error message when changing subvolume from ro->rw 2024-03-25 23:13:46 +01:00
common btrfs-progs: print error when zeroing device fails in device_zero_blocks() 2024-03-16 22:25:50 +01:00
config btrfs-progs: detect PCLMUL CPU support for accelerated crc32c 2023-09-13 00:38:50 +02:00
convert btrfs-progs: convert defined constants to enums 2024-02-08 08:30:37 +01:00
crypto btrfs-progs: crypto: add openssl as crypto provider 2023-11-30 22:04:45 +01:00
image btrfs-progs: fix all variable shadowing 2023-10-10 19:16:29 +02:00
include btrfs-progs: use unsigned types for bit shifts 2024-03-12 22:05:09 +01:00
kernel-lib btrfs-progs: clean up includes, using include-what-you-use 2023-10-03 01:11:57 +02:00
kernel-shared btrfs-progs: enable send v3 correctly (use EXPERIMENTAL instead of CONFIG_BTRFS_DEBUG) 2024-03-18 23:19:52 +01:00
libbtrfs libbtrfs: use unsigned types for bit shifts 2024-03-12 22:03:36 +01:00
libbtrfsutil libbtrfsutil: use unsigned types for bit shifts 2024-03-12 22:04:09 +01:00
mkfs btrfs-progs: mkfs: make transaction start and commit errors verbose 2024-03-22 01:19:47 +01:00
tests btrfs-progs: tests: use unsigned types for bit shifts in fsstress 2024-03-12 22:05:20 +01:00
tune btrfs-progs: tune: fix the missing close() of filesystem fd 2024-02-08 08:30:37 +01:00
.editorconfig btrfs-progs: add basic .editorconfig 2020-08-31 17:01:02 +02:00
.gitignore btrfs-progs: docs: placeholder for contents.rst file on older sphinx version 2024-01-11 17:04:48 +01:00
.readthedocs.yaml btrfs-progs: docs: add config file for readthedocs.io 2023-12-05 16:36:24 +01:00
64-btrfs-dm.rules btrfs-progs: udev: add rules for dm devices 2016-06-01 14:56:56 +02:00
64-btrfs-zoned.rules btrfs-progs: add udev rule to use mq-deadline on zoned btrfs 2022-02-01 18:41:43 +01:00
CHANGES btrfs-progs: update CHANGES for 6.8 2024-03-26 15:17:19 +01:00
COPYING fix COPYING 2007-06-12 15:41:08 -04:00
INSTALL btrfs-progs: crypto: add openssl as crypto provider 2023-11-30 22:04:45 +01:00
Makefile btrfs-progs: build: add target for all internal APIs 2023-12-01 01:39:27 +01:00
Makefile.extrawarn btrfs-progs: enable -Wshadow for default build 2023-10-10 19:23:10 +02:00
Makefile.inc.in btrfs-progs: crypto: add openssl as crypto provider 2023-11-30 22:04:45 +01:00
README.md btrfs-progs: README: fix typo in changelog link 2024-02-08 08:30:37 +01:00
VERSION Btrfs progs v6.8 2024-03-26 15:18:02 +01:00
autogen.sh btrfs-progs: build: reuse config/ directory for m4 macros 2023-05-26 21:08:17 +02:00
btrfs-completion btrfs-progs: move space cache removal to rescue group 2023-11-03 18:04:37 +01:00
btrfs-corrupt-block.c btrfs-progs: clean up includes, using include-what-you-use 2023-10-03 01:11:57 +02:00
btrfs-crc.c btrfs-progs: move crc32c implementation to crypto/ 2019-11-18 19:20:02 +01:00
btrfs-debugfs btrfs-progs: port btrfs-debugfs to python3 2020-07-02 22:24:33 +02:00
btrfs-find-root.c btrfs-progs: clean up includes, using include-what-you-use 2023-10-03 01:11:57 +02:00
btrfs-map-logical.c btrfs-progs: clean up includes, using include-what-you-use 2023-10-03 01:11:57 +02:00
btrfs-sb-mod.c btrfs-progs: sb-mod: fix build after removing log_root_transid 2023-10-21 15:51:07 +02:00
btrfs-select-super.c btrfs-progs: clean up includes, using include-what-you-use 2023-10-03 01:11:57 +02:00
btrfs.c btrfs-progs: add support for dry-run options 2023-11-03 18:04:37 +01:00
configure.ac btrfs-progs: use unsigned types for bit shifts in configure.ac and docs 2024-03-12 22:05:49 +01:00
fsck.btrfs btrfs-progs: fsck.btrfs: Fix bashism and bad getopts processing 2015-05-21 16:53:44 +02:00
inject-error btrfs-progs: add error injection helper script 2023-07-27 14:45:29 +02:00
show-blocks btrfs-progs: Remove btrfs-debug-tree command 2018-04-24 13:00:10 +02:00

README.md

Btrfs-progs

devel coverage codecov static release

Userspace utilities to manage btrfs filesystems. License: GPLv2.

Btrfs is a copy on write (COW) filesystem for Linux aimed at implementing advanced features while focusing on fault tolerance, repair and easy administration.

This repository hosts following utilities and also documentation:

See INSTALL for build instructions, tests/README.md for testing information and ci/README.md for CI information.

Release cycle

The major version releases are time-based and follow the cycle of the linux kernel releases. The cycle usually takes 2 months. A minor version releases may happen in the meantime if there are bug fixes or minor useful improvements queued.

The release tags are signed with a GPG key ID F2B4 1200 C54E FB30 380C 1756 C565 D5F9 D76D 583B, release tarballs are hosted at kernel.org. See file CHANGES or changelogs on RTD.

Releases with changelog are also published at Github release page.

Static binaries

For each release there are static binaries of btrfs and btrfs.box provided. These can be used in rescue environments and are built for x86_64 architecture (with maximum backward compatibility), inside the Github Actions workflow. The btrfs.box is an all-in-one tool in the busybox style, the functionality is determined by the binary names (either symlink, hradlink or a file copy).

Feature compatibility

The btrfs-progs of version X.Y declare support of kernel features of the same version. New progs on old kernel are expected to work, limited only by features provided by the kernel.

Build compatibility

Build is supported on the GNU C library as the primary target, and on the musl libc.

The supported compilers are gcc (minimal version 4.8) and clang (minimal version 3.4).

Build tests are done on several distributions, see Github actions workflow.

Reporting bugs

There are several ways, each has its own specifics and audience that can give feedback or work on a fix. The following list is sorted in the order of preference:

Development

The development takes place in the mailing list (linux-btrfs@vger.kernel.org) or at Github (issues, pull requests). Changes should be split to logical parts if possible, documentation may be included in the same patch as to code or separately.

The development model of btrfs-progs shares a lot with the kernel model. The

  • one logical change per patch: e.g. not mixing bugfixes, cleanups, features etc., sometimes it's not clear and will be usually pointed out during reviews
  • proper subject line: e.g. prefix with btrfs-progs: subpart, ... , descriptive yet not too long, see git log --oneline for some inspiration
  • proper changelog: the changelogs are often missing or lacking explanation why the change was made, or how is something broken, what are user-visible effects of the bug or the fix, how does an improvement help or the intended usecase
  • the Signed-off-by line is not mandatory for less significant changes (typos, documentation) but is desired as this documents who authored the change, you can read more about the The Developer's Certificate of Origin (chapter 11)
    • if you are not used to the signed-off style, your contributions won't be rejected just because of it's missing, the Author: tag will be added as a substitute in order to allow contributions without much bothering with formalities

Pull requests

The pull requests on Github may be used for code or documentation contributions. There are basic build checks enabled in the Github actions CI for pull requests. The status can be checked at the workflow page.

  • open a PR against branches devel or master
  • push update to the same branch if you need to
  • close the PR in case it's wrong, a mistake or needs rework
  • if you're sure the changes don't need a CI build verification, please add [skip ci] to the changelog

Source code coding style and preferences follow the kernel coding style. You can find the editor settings in .editorconfig and use the EditorConfig plugin to let your editor use that, or update your editor settings manually.

Testing

The documentation for writing and running tests can be found in tests/ and continuous integration/container images in ci/.

Development branches are tested by Github Action workflows.

Code coverage provided by codecov.io can be found here.

Documentation updates

Documentation fixes or updates do not need much explanation so sticking to the code rules in the previous section is not necessary. GitHub pull requests are OK, patches could be sent to me directly and not required to be also in the mailing list. Pointing out typos via IRC also works, although might get accidentally lost in the noise.

Documentation sources are written in RST and built by sphinx.

Third-party sources

Build dependencies are listed in INSTALL. Implementation of checksum/hash functions is provided by copies of the respective sources to avoid adding dependencies that would make deployments in rescue or limited environments harder. The implementations are portable and there are optimized versions for some architectures. Optionally it's possible to use libgcrypt, libsodium, libkcapi, Botan or OpenSSL implementations.

The builtin implemtations uses the following sources: CRC32C, XXHASH, SHA256, BLAKE2.

Some other code is borrowed from kernel, eg. the raid5 tables or data structure implementation (list, rb-tree).

References