Userspace utilities to manage btrfs filesystems
Go to file
David Sterba dc29a5c51d btrfs-progs: convert: update default output
The messages printed by convert are incomplete regarding the source and
target filesystems and can be improved and unified with the style we
already have eg. in mkfs:

  $ btrfs-convert image
  btrfs-convert from btrfs-progs v5.13.1

  Source filesystem:
    Type:           ext2
    Label:
    Blocksize:      4096
    UUID:           b9bb96e0-7b2f-44a1-9670-1b6da27b26b0
  Target filesystem:
    Label:          NEWLABEL
    Blocksize:      4096
    Nodesize:       16384
    UUID:           c7dd7532-7e17-41b0-bf7c-12d695bbf6d0
    Checksum:       crc32c
    Features:       extref, skinny-metadata (default)
      Data csum:    yes
      Inline data:  yes
      Copy xattr:   yes
  Reported stats:
    Total space:      1073741824
    Free space:        805240832 (74.99%)
    Inode count:           65536
    Free inodes:           65525
    Block count:          262144
  Create initial btrfs filesystem
  Create ext2 image file
  Create btrfs metadata
  Copy inodes [o] [         0/        11]
  Set label to 'NEWLABEL'
  Conversion complete

  $ btrfs-convert -r image
  btrfs-convert from btrfs-progs v5.13.1

  Open filesystem for rollback:
    Label:
    UUID:            c7dd7532-7e17-41b0-bf7c-12d695bbf6d0
    Restoring from:  ext2_saved/image

Signed-off-by: David Sterba <dsterba@suse.com>
2021-08-20 14:24:55 +02:00
Documentation btrfs-progs: convert: new option to copy or specify uuid 2021-08-20 14:24:55 +02:00
check btrfs-progs: check/original: detect directory inode with nlinks >= 2 2021-07-30 15:50:48 +02:00
ci btrfs-progs: ci: add script to do build test on musl 2021-07-26 13:45:35 +02:00
cmds btrfs-progs: remove stale command declarations 2021-08-20 14:24:55 +02:00
common btrfs-progs: correct check_running_fs_exclop() return value 2021-07-02 17:27:53 +02:00
convert btrfs-progs: convert: update default output 2021-08-20 14:24:55 +02:00
crypto btrfs-progs: crypto: add perf support to speed test 2021-06-01 22:19:38 +02:00
image btrfs-progs: image: enlarge output file if no tree modification is needed for restore 2021-05-06 16:41:47 +02:00
kernel-lib btrfs-progs: remove unnecessary linux/*.h includes 2021-05-06 16:41:47 +02:00
kernel-shared btrfs-progs: mkfs: set super_cache_generation to 0 if we're using free space tree 2021-08-20 14:24:55 +02:00
libbtrfsutil libbtrfsutil: fix race between subvolume iterator and deletion 2021-07-29 13:01:55 +02:00
m4 btrfs-progs: a bunch of typo fixes 2021-01-13 22:33:10 +01:00
mkfs btrfs-progs: mkfs: update message when creating zoned fs with non-single profiles 2021-07-30 16:13:58 +02:00
tests btrfs-progs: tests: add test for convert --uuid option 2021-08-20 14:24:55 +02:00
.editorconfig btrfs-progs: add basic .editorconfig 2020-08-31 17:01:02 +02:00
.gitignore btrfs-progs: ci: add docker build and test scripts 2021-03-01 15:46:34 +01:00
64-btrfs-dm.rules
CHANGES btrfs-progs: update CHANGES for 5.13.1 2021-07-30 16:14:29 +02:00
COPYING
INSTALL btrfs-progs: build: note minimal version for zoned support 2021-05-12 13:12:13 +02:00
Makefile btrfs-progs: build: remove duplicate library from libbtrfs-test 2021-05-11 20:13:52 +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 Revert "btrfs-progs: build: add libmount dependency" 2021-02-19 15:24:42 +01:00
README.md btrfs-progs: README: update links 2021-07-08 14:53:16 +02:00
VERSION Btrfs progs v5.13.1 2021-07-30 16:14:58 +02:00
autogen.sh
btrfs-completion btrfs-progs: rescue: add create-control-device subcommand 2021-02-19 16:19:37 +01:00
btrfs-corrupt-block.c btrfs-progs: switch %Lu to %llu format 2021-06-19 22:07:49 +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: factor open_ctree parameters to a structure 2021-03-24 22:20:19 +01: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: switch %Lu to %llu format 2021-06-19 22:07:49 +02:00
btrfs-sb-mod.c btrfs-progs: pass in fs_info to btrfs_csum_data 2021-03-24 22:20:19 +01:00
btrfs-select-super.c btrfs-progs: split open/close helpers from utils.c 2021-05-06 16:41:47 +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: split open/close helpers from utils.c 2021-05-06 16:41:47 +02:00
configure.ac btrfs-progs: crypto: add perf support to speed test 2021-06-01 22:19:38 +02:00
fsck.btrfs
ioctl.h btrfs-progs: remove stale user transaction ioctl definitions 2021-06-19 22:07:50 +02:00
kerncompat.h btrfs-progs: kerncompat: add const_ilog2 2021-05-06 16:41:46 +02:00
libbtrfs.sym btrfs-progs: move send-utils.c to common/ 2020-08-31 17:01:04 +02:00
props.c btrfs-progs: split open/close helpers from utils.c 2021-05-06 16:41:47 +02:00
props.h
qgroup.c btrfs-progs: split unit related helpers from utils.c 2021-05-06 16:41:47 +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
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 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:

  • 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)
  • libbtrfsutil (LGPL v2.1) — C and python 3 bindings, 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 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.

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