Userspace utilities to manage btrfs filesystems
Go to file
David Sterba 071cb030a4 btrfs-progs: mkfs: clean up default profile settings
Extract the defaults for data and metadata profiles to a header and
use the symbolic names instead of hardcoding the profiles.

Signed-off-by: David Sterba <dsterba@suse.com>
2020-07-21 12:13:27 +02:00
check btrfs-progs: qgroup-verify: allow repair_qgroups to do silent repair 2020-05-28 19:59:56 +02:00
ci btrfs-progs: lots of typo fixes (codespell) 2020-03-31 18:37:38 +02:00
cmds btrfs-progs: inspect tree-stats: print number of nodes for each level 2020-07-09 16:14:44 +02:00
common btrfs-progs: fix seemly wrong format overflow warning 2020-06-29 17:45:39 +02:00
convert btrfs-progs: convert: ensure the data chunks size never exceed device size 2020-06-29 17:45:39 +02:00
crypto btrfs-progs: build: add support for libkcapi as crypto backend 2020-06-09 22:19:07 +02:00
Documentation btrfs-progs: docs: note when subvolume cannot be deleted 2020-07-14 15:04:05 +02:00
image btrfs-progs: image: pin down log tree blocks before fixup 2020-05-29 12:42:49 +02:00
kernel-lib btrfs-progs: move crc32c implementation to crypto/ 2019-11-18 19:20:02 +01:00
kernel-shared btrfs-progs: move uuid-tree.c to kernel-shared/ 2020-06-09 22:19:09 +02:00
libbtrfsutil libbtrfsutil: update btrfs_util_delete_subvolume docs 2020-05-29 12:42:49 +02:00
m4 btrfs-progs: build: detect whether -std=gnu90 is supported 2018-06-07 16:37:35 +02:00
mkfs btrfs-progs: mkfs: clean up default profile settings 2020-07-21 12:13:27 +02:00
tests btrfs-progs: tests: check that convert does not create extents beyond device boundary 2020-06-29 17:45:39 +02:00
.gitignore btrfs-progs: gitignore: Ignore hidden files 2019-03-05 13:27:27 +01:00
.gitlab-ci.yml btrfs-progs: ci: setup GitLab-CI 2019-10-16 23:03:52 +02:00
.travis.yml btrfs-progs: ci: use newer image base on travis 2019-11-18 19:21:08 +01:00
64-btrfs-dm.rules btrfs-progs: udev: add rules for dm devices 2016-06-01 14:56:56 +02:00
Android.mk btrfs-progs: move crc32c implementation to crypto/ 2019-11-18 19:20:02 +01:00
androidcompat.h
autogen.sh btrfs-progs: build: simplify version tracking 2018-01-31 15:14:01 +01:00
btrfs-completion btrfs-progs: completion: let dump-tree/dump-super/inode-resolve accept any file 2018-10-23 14:48:38 +02:00
btrfs-corrupt-block.c btrfs-progs: disk-io: do proper error handling in in write_and_map_eb() 2020-03-04 19:21:08 +01: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: move crc32c implementation to crypto/ 2019-11-18 19:20:02 +01:00
btrfs-fragments.c btrfs-progs: Fix printf formats 2019-10-14 17:31:05 +02:00
btrfs-list.c btrfs-progs: move rbtree-utils.[ch] to common/ 2019-07-03 20:49:04 +02:00
btrfs-list.h btrfs-progs: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02:00
btrfs-map-logical.c btrfs-progs: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02:00
btrfs-sb-mod.c btrfs-progs: move crc32c implementation to crypto/ 2019-11-18 19:20:02 +01:00
btrfs-select-super.c btrfs-progs: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02:00
btrfs.c btrfs-progs: add global verbose and quiet options and helper functions 2020-06-12 19:30:43 +02:00
btrfsck.h btrfs-progs: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02:00
btrfstune.c btrfs-progs: build most common tools into one binary (busybox style) 2019-07-04 15:30:40 +02:00
CHANGES btrfs-progs: update CHANGES for 5.7 2020-07-02 22:58:38 +02:00
configure.ac btrfs-progs: build: add support for libkcapi as crypto backend 2020-06-09 22:19:07 +02:00
COPYING
ctree.c btrfs-progs: ctree: introduce function to create an empty tree 2020-05-28 19:59:56 +02:00
ctree.h btrfs-progs: mkfs: remove alloc start options and docs 2020-07-02 22:24:34 +02:00
disk-io.c btrfs-progs: refactor btrfs_scan_devices() to accept verbose argument 2020-06-12 19:31:58 +02:00
disk-io.h btrfs-progs: dump-tree: rename to option to --hide-names 2020-03-20 22:05:27 +01:00
extent_io.c btrfs-progs: remove extent_buffer::tree member 2020-05-04 20:48:35 +02:00
extent_io.h btrfs-progs: remove extent_buffer::tree member 2020-05-04 20:48:35 +02:00
extent-cache.c btrfs-progs: do proper error handling in add_cache_extent() 2020-05-04 20:48:35 +02:00
extent-cache.h btrfs-progs: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02:00
extent-tree.c btrfs-progs: fix wrong chunk profile for do_chunk_alloc() 2020-06-29 17:45:35 +02:00
file.c btrfs-progs: move utils.[ch] to common/ 2019-07-03 20:49:04 +02:00
find-root.c btrfs-progs: move utils.[ch] to common/ 2019-07-03 20:49:04 +02:00
find-root.h btrfs-progs: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02:00
free-space-cache.c btrfs-progs: rename btrfs_block_group_cache to btrfs_block_group 2020-05-11 20:50:00 +02:00
free-space-cache.h btrfs-progs: rename btrfs_block_group_cache to btrfs_block_group 2020-05-11 20:50:00 +02:00
fsck.btrfs
inode.c btrfs-progs: move btrfs_find_free_objectid to inode.c 2020-06-09 22:19:09 +02:00
INSTALL btrfs-progs: build: add support for libkcapi as crypto backend 2020-06-09 22:19:07 +02:00
ioctl.h btrfs-progs: complete the implementation RAID1C34 definitions 2020-04-01 20:20:59 +02:00
kerncompat.h btrfs-progs: Fix printf formats 2019-10-14 17:31:05 +02:00
libbtrfs.sym btrfs-progs: libbtrfs: add list of exported symbols 2019-10-24 16:31:25 +02:00
libbtrfsutil.sym libbtrfsutil: bump version to 1.2 2020-03-04 19:21:09 +01:00
Makefile btrfs-progs: move btrfs_find_free_objectid to inode.c 2020-06-09 22:19:09 +02:00
Makefile.extrawarn btrfs-progs: build: disable -Waddress-of-packed-member by default 2019-06-14 15:09:53 +02:00
Makefile.inc.in btrfs-progs: build: add support for libkcapi as crypto backend 2020-06-09 22:19:07 +02:00
print-tree.c btrfs-progs: print-tree: export dump_superblock() 2020-05-29 12:42:49 +02:00
print-tree.h btrfs-progs: print-tree: export dump_superblock() 2020-05-29 12:42:49 +02:00
props.c btrfs-progs: props: fix typo in help text 2020-03-04 19:21:03 +01:00
props.h
qgroup.c btrfs-progs: move utils.[ch] to common/ 2019-07-03 20:49:04 +02:00
qgroup.h btrfs-progs: qgroups: introduce btrfs_qgroup_query 2019-07-03 13:31:14 +02:00
quick-test.c btrfs-progs: fix build of quick-test 2020-03-31 18:37:34 +02:00
random-test.c btrfs-progs: Fix printf formats 2019-10-14 17:31:05 +02:00
README.md btrfs-progs: build: add support for libkcapi as crypto backend 2020-06-09 22:19:07 +02:00
repair.c btrfs-progs: move utils.[ch] to common/ 2019-07-03 20:49:04 +02:00
repair.h btrfs-progs: factor out repair mode 2016-07-04 15:22:53 +02:00
send-dump.c btrfs-progs: move utils.[ch] to common/ 2019-07-03 20:49:04 +02:00
send-dump.h btrfs-progs: introduce new send-dump object 2016-12-14 15:06:34 +01:00
send-stream.c btrfs-progs: move crc32c implementation to crypto/ 2019-11-18 19:20:02 +01:00
send-stream.h
send-utils.c btrfs-progs: send: add gcc9 workaround for root item reset 2019-07-04 02:06:34 +02:00
send-utils.h btrfs-progs: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02:00
send.h btrfs-progs: Introduce kernel sizes to cleanup large intermediate number 2017-03-08 13:00:45 +01:00
show-blocks btrfs-progs: Remove btrfs-debug-tree command 2018-04-24 13:00:10 +02:00
transaction.c btrfs-progs: move delayed-ref.[ch] to kernel-shared/ 2020-03-31 18:37:34 +02:00
transaction.h btrfs-progs: rename btrfs_block_group_cache to btrfs_block_group 2020-05-11 20:50:00 +02:00
utils-lib.c btrfs-progs: move utils.[ch] to common/ 2019-07-03 20:49:04 +02:00
VERSION Btrfs progs v5.7 2020-07-02 22:59:41 +02:00
version.h.in
volumes.c btrfs-progs: mkfs: remove alloc start options and docs 2020-07-02 22:24:34 +02:00
volumes.h btrfs-progs: rename btrfs_block_group_cache to btrfs_block_group 2020-05-11 20:50:00 +02:00

Btrfs-progs build status coverity status gitlab CI/CD

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:

  • btrfs — the main administration tool (manual page)
  • mkfs.btrfs — utility to create the filesystem (manual page)
  • all-in-one binary in the busybox style with mkfs.btrfs, btrfs-image and other tools built-in (standalone tools)

The C and python 3 bindings are provided by a LGPL library libbtrfsutil see libbtrfsutil/README.md for more.

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.freenode.net #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

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.

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.

References