You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
David Sterba e1d9dab326
Btrfs progs v5.19.1
3 weeks ago
Documentation btrfs-progs: btrfstune: add the ability to convert to block group tree feature 3 weeks ago
check btrfs-progs: separate block group tree from extent tree v2 3 weeks ago
ci btrfs-progs: ci: add helpers to update base images 8 months ago
cmds btrfs-progs: receive: fix a segfault when passing error pointer to free() 3 weeks ago
common btrfs-progs: mkfs: drop numeric flag from -O and -R option list 3 weeks ago
convert btrfs-progs: convert: properly work with large ext4 filesystems 2 months ago
crypto btrfs-progs: libbtrfs: remove unneeded BTRFS_FLAT_INCLUDES protections 1 year ago
image btrfs-progs: avoid repeated data write for metadata 2 months ago
kernel-lib btrfs-progs: kernel-lib: add stubs for overflow builtins 2 months ago
kernel-shared btrfs-progs: btrfstune: add the ability to convert to block group tree feature 3 weeks ago
libbtrfs btrfs-progs: libbtrfs: reduce exports from ctree.h 2 months ago
libbtrfsutil btrfs-progs: add definitions for the block group tree 10 months ago
m4 btrfs-progs: build: add m4 macros for builtin detection 2 months ago
mkfs btrfs-progs: mkfs: add artificial dependency for block group tree 3 weeks ago
tests btrfs-progs: tests: fix misc/016 encoded write, permissions of send stream file 3 weeks ago
.editorconfig btrfs-progs: add basic .editorconfig 2 years ago
.gitignore btrfs-progs: remove asciidoc generated files from .gitignore 7 months ago
64-btrfs-dm.rules btrfs-progs: udev: add rules for dm devices 6 years ago
64-btrfs-zoned.rules btrfs-progs: add udev rule to use mq-deadline on zoned btrfs 8 months ago
CHANGES btrfs-progs: update CHANGES for 5.19.1 3 weeks ago
COPYING fix COPYING 16 years ago
INSTALL btrfs-progs: INSTALL: drop reference to libattr 5 months ago
Makefile btrfs-progs: build: rename compression support variables 2 months ago
Makefile.extrawarn btrfs-progs: build: disable -Waddress-of-packed-member by default 3 years ago
Makefile.inc.in btrfs-progs: build: rename compression support variables 2 months ago
README.md btrfs-progs: INSTALL: update dependencies for docs build 5 months ago
VERSION Btrfs progs v5.19.1 3 weeks ago
autogen.sh btrfs-progs: build: simplify version tracking 5 years ago
btrfs-completion btrfs-progs: rescue: add create-control-device subcommand 2 years ago
btrfs-corrupt-block.c btrfs-progs: corrupt-block: update help text 2 months ago
btrfs-crc.c btrfs-progs: move crc32c implementation to crypto/ 3 years ago
btrfs-debugfs btrfs-progs: port btrfs-debugfs to python3 2 years ago
btrfs-find-root.c btrfs-progs: make btrfs_super_block::log_root_transid deprecated 2 months ago
btrfs-fragments.c btrfs-progs: move ctree.c to kernel-shared/ 2 years ago
btrfs-map-logical.c btrfs-progs: use read_data_from_disk() to replace read_extent_from_disk() and replace read_extent_data() 5 months ago
btrfs-sb-mod.c btrfs-progs: sb-mod: improve help 1 year ago
btrfs-select-super.c btrfs-progs: libbtrfs: drop radix-tree.h from exported headers 1 year ago
btrfs.c btrfs-progs: sort main help menu entries 2 years ago
btrfstune.c btrfs-progs: btrfstune: add the ability to convert to block group tree feature 3 weeks ago
configure.ac btrfs-progs: build: add m4 macros for builtin detection 2 months ago
fsck.btrfs btrfs-progs: fsck.btrfs: Fix bashism and bad getopts processing 7 years ago
ioctl.h btrfs-progs: send: stream v2 ioctl flags 4 months ago
kerncompat.h btrfs-progs: kerncompat: avoid redefined __bitwise__ warning 2 months ago
libbtrfs.sym btrfs-progs: delete commented exports from libbtrfs.sym 5 months ago
quick-test.c btrfs-progs: move transaction.c to kernel-shared/ 2 years ago
random-test.c btrfs-progs: move transaction.c to kernel-shared/ 2 years ago
show-blocks btrfs-progs: Remove btrfs-debug-tree command 5 years ago
version.h.in btrfs-progs: re-introduce BTRFS_BUILD_VERSION in version.h 8 years ago

README.md

Btrfs-progs coverity status

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 and tests/README.md for testing 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 wiki.

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:

  • github issue tracker
  • to the mailing list linux-btrfs@vger.kernel.org -- (not required to subscribe), beware that the mail might get overlooked in other traffic
  • IRC (irc.libera.chat #btrfs) -- good for discussions eg. if a bug is already known, but reports could miss developers' attention
  • bugzilla.kernel.org -- (requires registration), set the product to Filesystems and component Btrfs, please put 'btrfs-progs' into the subject so it's clear that it's not a kernel bug report

Development

The patch submissions, development or general discussions take place at linux-btrfs@vger.kernel.org mailinglist, subsciption is not required to post.

The GitHub pull requests will not be accepted directly, the preferred way is to send patches to the mailinglist instead. You can link to a branch in any git repository if the mails do not make it to the mailinglist or just for convenience (makes it easier to test).

The development model of btrfs-progs shares a lot with the kernel model. The github way is different in some ways. We, the upstream community, expect that the patches meet some criteria (often lacking in github contributions):

  • one logical change per patch: eg. not mixing bugfixes, cleanups, features etc., sometimes it's not clear and will be usually pointed out during reviews
  • proper subject line: eg. 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: 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

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 testing documentation can be found in tests/ and continuous integration/container images in ci/.

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 mailinglist. Pointing out typos via IRC also works, although might get accidentally lost in the noise.

Documents 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 rescure or limited environments harder. The implementations are portable and not optimized for speed nor accelerated. Optionally it's possible to use libgcrypt, libsodium or libkcapi implementations.

Some other code is borrowed from kernel, eg. the raid5 tables or data structure implementation.

References