Userspace utilities to manage btrfs filesystems
Go to file
David Sterba 29e2dd7a23 btrfs-progs: initialize formatter context properly
In cases where the compiler does not initialize the formatter context to
all zeros, there could be garbage values left on the depth 0 that is not
explicitly initialized. This could lead to mistakenly printing a ","
separator before the last closing "}", like

{
  "__header": {
    "version": "1"
  },
}

Signed-off-by: David Sterba <dsterba@suse.com>
2021-01-13 22:33:09 +01:00
Documentation btrfs-progs: check: add option to remove ino cache 2020-12-16 17:08:53 +01:00
check btrfs-progs: check: add option to remove ino cache 2020-12-16 17:08:53 +01:00
ci btrfs-progs: ci: add sanitizer coverage 2020-10-20 15:49:07 +02:00
cmds btrfs-progs: send: fix crash on unknown option 2021-01-13 22:33:09 +01:00
common btrfs-progs: initialize formatter context properly 2021-01-13 22:33:09 +01:00
convert btrfs-progs: convert: show more info when reserve_space fails 2020-09-29 22:46:12 +02:00
crypto btrfs-progs: build: add support for libkcapi as crypto backend 2020-06-09 22:19:07 +02:00
image btrfs-progs: image: fix invalid size check for extent items 2020-12-16 17:08:53 +01:00
kernel-lib btrfs-progs: move volumes.c to kernel-shared/ 2020-08-31 17:01:06 +02:00
kernel-shared btrfs-progs: print the eb flags for nodes as well 2020-12-16 17:08:53 +01:00
libbtrfsutil libbtrfsutil: set pkg-config Version to follow main package 2020-10-22 20:34:30 +02:00
m4
mkfs btrfs-progs: mkfs: refactor how we handle sectorsize override 2020-12-10 17:10:30 +01:00
tests btrfs-progs: tests: add Makefile for testsuite 2021-01-13 22:33:09 +01:00
.editorconfig btrfs-progs: add basic .editorconfig 2020-08-31 17:01:02 +02:00
.gitignore libbtrfsutil: add pkg-config spec file 2020-10-20 15:49:07 +02:00
.gitlab-ci.yml btrfs-progs: ci: setup GitLab-CI 2019-10-16 23:03:52 +02:00
.travis.yml btrfs-progs: ci: add sanitizer coverage 2020-10-20 15:49:07 +02:00
64-btrfs-dm.rules
Android.mk btrfs-progs: merge find-root.c and btrfs-find-root.c 2020-08-31 17:01:06 +02:00
CHANGES btrfs-progs: update CHANGES for 5.9 2020-10-23 15:24:17 +02:00
COPYING
INSTALL btrfs-progs: build: add support for libkcapi as crypto backend 2020-06-09 22:19:07 +02:00
Makefile libbtrfsutil: add pkg-config spec file 2020-10-20 15:49:07 +02:00
Makefile.extrawarn
Makefile.inc.in libbtrfsutil: add pkg-config spec file 2020-10-20 15:49:07 +02:00
README.md btrfs-progs: Update README.md with editorconfig hint 2020-08-31 17:01:03 +02:00
VERSION Btrfs progs v5.9 2020-10-23 15:25:01 +02:00
androidcompat.h
autogen.sh
btrfs-completion
btrfs-corrupt-block.c btrfs-progs: move volumes.c to kernel-shared/ 2020-08-31 17:01:06 +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: merge find-root.c and btrfs-find-root.c 2020-08-31 17:01:06 +02:00
btrfs-fragments.c btrfs-progs: move ctree.c to kernel-shared/ 2020-08-31 17:01:05 +02:00
btrfs-list.c btrfs-progs: move transaction.c to kernel-shared/ 2020-08-31 17:01:06 +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: move volumes.c to kernel-shared/ 2020-08-31 17:01:06 +02:00
btrfs-sb-mod.c btrfs-progs: sb-mod: add syntax to the help text 2020-10-20 15:49:07 +02:00
btrfs-select-super.c btrfs-progs: move volumes.c to kernel-shared/ 2020-08-31 17:01:06 +02:00
btrfs.c btrfs-progs: sort main help menu entries 2020-12-10 17:10:30 +01:00
btrfsck.h btrfs-progs: move ctree.c to kernel-shared/ 2020-08-31 17:01:05 +02:00
btrfstune.c btrfs-progs: move volumes.c to kernel-shared/ 2020-08-31 17:01:06 +02:00
configure.ac btrfs-progs: build: provide variables for main package version 2020-10-22 20:34:30 +02:00
fsck.btrfs
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: move send-utils.c to common/ 2020-08-31 17:01:04 +02:00
libbtrfsutil.sym libbtrfsutil: bump version to 1.2 2020-03-04 19:21:09 +01:00
props.c btrfs-progs: move ctree.c to kernel-shared/ 2020-08-31 17:01:05 +02:00
props.h
qgroup.c btrfs-progs: move ctree.c to kernel-shared/ 2020-08-31 17:01:05 +02:00
qgroup.h btrfs-progs: qgroups: introduce btrfs_qgroup_query 2019-07-03 13:31:14 +02:00
quick-test.c btrfs-progs: move transaction.c to kernel-shared/ 2020-08-31 17:01:06 +02:00
random-test.c btrfs-progs: move transaction.c to kernel-shared/ 2020-08-31 17:01:06 +02:00
repair.c btrfs-progs: move ctree.c to kernel-shared/ 2020-08-31 17:01:05 +02:00
repair.h btrfs-progs: move ctree.c to kernel-shared/ 2020-08-31 17:01:05 +02:00
send.h btrfs-progs: move ctree.c to kernel-shared/ 2020-08-31 17:01:05 +02:00
show-blocks
version.h.in

README.md

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

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

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