Userspace utilities to manage btrfs filesystems
Go to file
Jeff Mahoney b3e0faf6f5 btrfs-progs: filesystem balance: split out special handling
In preparation to use cmd_struct as the command entry point, we need
to split out the 'filesystem balance' handling to not call cmd_balance
directly.  The reason is that the flags that indicate a command is
hidden are a part of cmd_struct and so we can use a cmd_struct as a
direct alias in another command group and ALSO have it be hidden
without declaring another cmd_struct.

This change has no immediate impact since cmd_balance will still
use its usage information directly from cmds-balance.c.  It will
take effect once we start passing cmd_structs around for usage
information.

Signed-off-by: Jeff Mahoney <jeffm@suse.com>
Signed-off-by: David Sterba <dsterba@suse.com>
2019-07-03 13:31:15 +02:00
Documentation btrfs-progs: docs: add reference of section 5 page 2019-07-03 13:31:14 +02:00
check btrfs-progs: check/lowmem: Reset path in repair mode to avoid incorrect item from being passed to lowmem check. 2019-06-05 18:02:05 +02:00
convert btrfs-progs: Enable crc32c optimization probe for convert and mkfs 2019-05-27 16:39:51 +02:00
image btrfs-progs: image: Verify the superblock before restore 2019-06-14 17:42:03 +02:00
kernel-lib btrfs-progs: fix typos in comments 2018-11-26 18:24:48 +01:00
kernel-shared btrfs-progs: shared: rename ulist_fini to ulist_release 2019-01-16 21:16:14 +01:00
libbtrfsutil libbtrfsutil: don't close fd on error in btrfs_util_subvolume_id_fd() 2019-04-26 18:23:27 +02:00
m4 btrfs-progs: build: detect whether -std=gnu90 is supported 2018-06-07 16:37:35 +02:00
mkfs btrfs-progs: Fix false ENOSPC alert by tracking used space correctly 2019-07-03 13:31:14 +02:00
tests btrfs-progs: test: cleanup misc-tests/034 2019-06-05 20:27:32 +02:00
travis btrfs-progs: tests: pull zstd version 1.3.7 to the travis CI 2018-11-26 17:26:51 +01:00
.gitignore btrfs-progs: gitignore: Ignore hidden files 2019-03-05 13:27:27 +01:00
.travis.yml btrfs-progs: CI: enable fuzz tests 2019-05-17 13:18:01 +02:00
64-btrfs-dm.rules
Android.mk btrfs-progs: build: Remove unused variable TESTS 2018-01-08 19:25:05 +01:00
CHANGES btrfs-progs: update CHANGES for v5.1.1 2019-06-11 18:44:55 +02:00
COPYING
INSTALL btrfs-progs: docs: fix typos in READMEs, INSTALL and CHANGES 2018-11-26 17:47:22 +01:00
Makefile btrfs-progs: build: disable -Waddress-of-packed-member by default 2019-06-14 15:09:53 +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 --disable-shared and --disable-static 2018-08-06 15:03:41 +02:00
README.md btrfs-progs: docs: fix typos in READMEs, INSTALL and CHANGES 2018-11-26 17:47:22 +01:00
VERSION Btrfs progs v5.1.1 2019-06-11 18:45:20 +02:00
androidcompat.h
autogen.sh btrfs-progs: build: simplify version tracking 2018-01-31 15:14:01 +01:00
backref.c btrfs-progs: do not merge tree block refs have different root_id 2018-06-07 16:37:36 +02:00
backref.h btrfs-progs: move ulist.[ch] to kernel-shared 2017-03-08 13:00:47 +01:00
bcp
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: help: don't print usage on wrong argument counts 2019-03-05 12:57:56 +01:00
btrfs-crc.c btrfs-progs: help: don't print usage on wrong argument counts 2019-03-05 12:57:56 +01:00
btrfs-debugfs btrfs-progs: right-align number columns in btrfs-debugfs output 2017-10-06 13:41:31 +02:00
btrfs-find-root.c btrfs-progs: find-root: use the common help infrastructure 2019-03-05 12:57:56 +01:00
btrfs-fragments.c btrfs-progs: help: don't print usage on wrong argument counts 2019-03-05 12:57:56 +01:00
btrfs-list.c btrfs-progs: convert strerror to implicit %m 2018-10-31 18:24:14 +01:00
btrfs-list.h btrfs-progs: fix typo in btrfs-list function export 2018-11-26 18:24:49 +01:00
btrfs-map-logical.c btrfs-progs: help: don't print usage on wrong argument counts 2019-03-05 12:57:56 +01:00
btrfs-sb-mod.c btrfs-progs: sb-mod: add compat bit to the recognized fields 2018-04-11 15:37:36 +02:00
btrfs-select-super.c btrfs-progs: help: don't print usage on wrong argument counts 2019-03-05 12:57:56 +01:00
btrfs.c btrfs-progs: help: convert ints used as bools to bool 2019-07-03 13:31:15 +02:00
btrfsck.h btrfs-progs: check: fix typo in device_extent_record::chunk_objectid 2018-11-26 18:24:49 +01:00
btrfstune.c btrfs-progs: help: don't print usage on wrong argument counts 2019-03-05 12:57:56 +01:00
chunk-recover.c btrfs-progs: Introduce rescue.h to resolve missing-prototypes for chunk and super rescue 2019-01-15 18:42:12 +01:00
cmds-balance.c btrfs-progs: help: don't print usage on wrong argument counts 2019-03-05 12:57:56 +01:00
cmds-device.c btrfs-progs: help: don't print usage on wrong argument counts 2019-03-05 12:57:56 +01:00
cmds-fi-du.c btrfs-progs: help: don't print usage on wrong argument counts 2019-03-05 12:57:56 +01:00
cmds-fi-usage.c btrfs-progs: help: don't print usage on wrong argument counts 2019-03-05 12:57:56 +01:00
cmds-fi-usage.h btrfs-progs: don't use __u8 for fsid buffers 2017-11-14 15:59:00 +01:00
cmds-filesystem.c btrfs-progs: filesystem balance: split out special handling 2019-07-03 13:31:15 +02:00
cmds-inspect-dump-super.c btrfs-progs: help: don't print usage on wrong argument counts 2019-03-05 12:57:56 +01:00
cmds-inspect-dump-tree.c btrfs-progs: inspect-dump-tree: Allow --block to be specified multiple times 2019-03-05 15:58:06 +01:00
cmds-inspect-tree-stats.c btrfs-progs: help: don't print usage on wrong argument counts 2019-03-05 12:57:56 +01:00
cmds-inspect.c btrfs-progs: help: don't print usage on wrong argument counts 2019-03-05 12:57:56 +01:00
cmds-property.c btrfs-progs: prop: return only common error values 2019-03-05 12:57:56 +01:00
cmds-qgroup.c btrfs-progs: qgroup show: report unrecognized format of sort string 2019-03-05 12:57:57 +01:00
cmds-quota.c btrfs-progs: help: don't print usage on wrong argument counts 2019-03-05 12:57:56 +01:00
cmds-receive.c btrfs-progs: reorder placement of help declarations for send/receive 2019-07-03 13:31:15 +02:00
cmds-replace.c btrfs-progs: help: don't print usage on wrong argument counts 2019-03-05 12:57:56 +01:00
cmds-rescue.c btrfs-progs: help: don't print usage on wrong argument counts 2019-03-05 12:57:56 +01:00
cmds-restore.c btrfs-progs: help: use unknown command option helper 2019-03-05 12:57:55 +01:00
cmds-scrub.c btrfs-progs: help: don't print usage on wrong argument counts 2019-03-05 12:57:56 +01:00
cmds-send.c btrfs-progs: reorder placement of help declarations for send/receive 2019-07-03 13:31:15 +02:00
cmds-subvolume.c btrfs-progs: subvolume: add quota info to btrfs sub show 2019-07-03 13:31:15 +02:00
commands.h btrfs-progs: move command definitions to commands.h 2017-08-24 19:08:24 +02:00
common-defs.h btrfs-progs: move some common definitions to own header 2017-03-08 13:00:45 +01:00
configure.ac btrfs-progs: fix typos in user-visible strings 2018-11-26 18:24:49 +01:00
ctree.c btrfs-progs: pass whole key to btrfs_uuid_to_key 2019-06-13 20:25:26 +02:00
ctree.h btrfs-progs: Fix -Waddress-of-packed-member warning in btrfs_dev_stats_values callers 2019-07-03 13:31:14 +02:00
delayed-ref.c btrfs-progs: Handle error properly in btrfs_commit_transaction() 2019-05-13 15:54:47 +02:00
delayed-ref.h btrfs-progs: delayed-ref: Fix memory leak and use-after-free caused by wrong condition to free delayed ref/head. 2019-07-03 13:31:14 +02:00
dir-item.c btrfs-progs: check: lowmem: Add ability to repair dir item with mismatched hash 2019-01-15 18:42:13 +01:00
disk-io.c btrfs-progs: image: Verify the superblock before restore 2019-06-14 17:42:03 +02:00
disk-io.h btrfs-progs: image: Verify the superblock before restore 2019-06-14 17:42:03 +02:00
extent-cache.c btrfs-progs: Remove objectid argument from alloc_cache_extent 2018-06-07 16:37:32 +02:00
extent-cache.h btrfs-progs: Remove add_cache_extent2 2018-06-07 16:37:32 +02:00
extent-tree.c btrfs-progs: Fix false ENOSPC alert by tracking used space correctly 2019-07-03 13:31:14 +02:00
extent_io.c btrfs-progs: constify extent buffer reader 2019-07-03 13:31:14 +02:00
extent_io.h btrfs-progs: constify extent buffer reader 2019-07-03 13:31:14 +02:00
file-item.c btrfs-progs: Remove root argument from btrfs_del_csums 2018-08-06 15:01:46 +02:00
file.c btrfs-progs: fix typos in comments 2018-11-26 18:24:48 +01:00
find-root.c btrfs-progs: drop blocksize from read_tree_block 2017-09-08 16:15:05 +02:00
find-root.h
free-space-cache.c btrfs-progs: free-space-cache: Don't panic when free space cache is corrupted 2018-08-06 15:00:24 +02:00
free-space-cache.h btrfs-progs: check: add support to clear v1 free space cache 2016-11-09 13:12:47 +01:00
free-space-tree.c btrfs-progs: Export btrfs_create_tree() and move it to disk-io.c 2019-01-15 18:42:13 +01:00
free-space-tree.h btrfs-progs: Pull free space tree related code from kernel 2018-10-25 16:11:39 +02:00
fsck.btrfs
fsfeatures.c btrfs-progs: fix kernel version parsing on some versions past 3.0 2019-03-05 15:33:54 +01:00
fsfeatures.h btrfs-progs: Add zstd support 2017-09-25 15:17:13 +02:00
hash.h btrfs-progs: move btrfs_extref_hash() to hash.h 2016-10-25 14:28:36 +02:00
hasher.c
help.c btrfs-progs: help: convert ints used as bools to bool 2019-07-03 13:31:15 +02:00
help.h btrfs-progs: help: convert ints used as bools to bool 2019-07-03 13:31:15 +02:00
inode-item.c btrfs-progs: remove unused argument from btrfs_lookup_inode_ref 2017-03-08 13:00:47 +01:00
inode-map.c
inode.c btrfs-progs: check: adjustments for further repair 2017-10-16 20:33:00 +02:00
internal.h
ioctl-test.c btrfs-progs: tests: make the ioctl-test actually useful 2016-10-24 14:57:19 +02:00
ioctl.h btrfs-progs: device scan: add new option to forget one or all scanned devices 2019-03-01 13:40:21 +01:00
kerncompat.h btrfs-progs: kerncompat: rename swap to __swap 2018-11-13 13:33:15 +01:00
library-test.c btrfs-progs: library-test: add all exported headers 2017-03-31 14:17:48 +02:00
messages.c btrfs-progs: add prefix to message helpers 2017-03-31 14:17:48 +02:00
messages.h btrfs-progs: Fix Wempty-body warning 2019-01-15 18:42:12 +01:00
print-tree.c btrfs-progs: Fix -Waddress-of-packed-member warning in btrfs_dev_stats_values callers 2019-07-03 13:31:14 +02:00
print-tree.h btrfs-progs: print-tree: Use bool for @follow 2018-10-31 18:24:14 +01:00
props.c btrfs-progs: convert strerror to implicit %m 2018-10-31 18:24:14 +01:00
props.h
qgroup-verify.c btrfs-progs: fix typos in user-visible strings 2018-11-26 18:24:49 +01:00
qgroup-verify.h btrfs-progs: check: enhanced progress indicator 2018-08-06 15:03:23 +02:00
qgroup.c btrfs-progs: qgroups: introduce btrfs_qgroup_query 2019-07-03 13:31:14 +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 2018-08-06 15:01:36 +02:00
random-test.c btrfs-progs: add crude error handling when transaction start fails 2017-09-08 16:15:05 +02:00
rbtree-utils.c
rbtree-utils.h
repair.c
repair.h
rescue.h btrfs-progs: Introduce rescue.h to resolve missing-prototypes for chunk and super rescue 2019-01-15 18:42:12 +01:00
root-tree.c btrfs-progs: Use more strict check to read out tree root 2017-05-02 16:33:04 +02:00
send-dump.c btrfs-progs: fix typos in comments 2018-11-26 18:24:48 +01:00
send-dump.h btrfs-progs: introduce new send-dump object 2016-12-14 15:06:34 +01:00
send-stream.c btrfs-progs: Fix -Wtype-limits warning 2019-01-15 16:20:10 +01:00
send-stream.h
send-utils.c btrfs-progs: convert strerror to implicit %m 2018-10-31 18:24:14 +01:00
send-utils.h btrfs-progs: send-utils: remove unused functions path_cat and path_cat3 2018-04-24 13:00:03 +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
string-table.c btrfs-progs: Fix -Wsuggest-attribute=format warning 2019-01-15 16:20:10 +01:00
string-table.h btrfs-progs: constify string arguments where appropriate 2016-10-03 15:07:23 +02:00
super-recover.c btrfs-progs: Introduce rescue.h to resolve missing-prototypes for chunk and super rescue 2019-01-15 18:42:12 +01:00
task-utils.c btrfs-progs: task-utils: Fix comparison between pointer and integer 2018-11-13 13:22:19 +01:00
task-utils.h btrfs-progs: check: enhanced progress indicator 2018-08-06 15:03:23 +02:00
transaction.c btrfs-progs: Fix false ENOSPC alert by tracking used space correctly 2019-07-03 13:31:14 +02:00
transaction.h btrfs-progs: Avoid nested chunk allocation call 2019-06-05 20:27:31 +02:00
utils-lib.c btrfs-progs: Add utils.h include to solve missing-prototypes warning 2019-01-15 18:42:12 +01:00
utils.c btrfs-progs: Remove unnecessary fallthrough attribute in test_num_disk_vs_raid() 2019-07-03 13:31:14 +02:00
utils.h btrfs-progs: treewide: Fix missing declarations 2018-11-13 13:32:41 +01:00
uuid-tree.c btrfs-progs: pass whole key to btrfs_uuid_to_key 2019-06-13 20:25:26 +02:00
version.h.in
volumes.c btrfs-progs: Unify metadata chunk size with kernel 2019-03-01 17:26:02 +01:00
volumes.h btrfs-progs: Port kernel fs_devices::total_rw_bytes 2019-03-01 17:26:02 +01:00

README.md

Btrfs-progs build status 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)

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.

References