Userspace utilities to manage btrfs filesystems
Go to file
Omar Sandoval 172c0d1a12 libbtrfsutil: add btrfs_util_[gs]et_read_only()
In the future, btrfs_util_[gs]et_subvolume_flags() might be useful, but
since these are the only subvolume flags we've defined in all this time,
this will do for now.

Signed-off-by: Omar Sandoval <osandov@fb.com>
Signed-off-by: David Sterba <dsterba@suse.com>
2018-03-06 11:28:36 +01:00
Documentation btrfs-progs: build: add support for asciidoctor doc generator 2018-02-02 21:02:13 +01:00
check btrfs-progs: Move chunk stripe size calculation function to volumes.h 2018-03-06 11:28:26 +01:00
convert btrfs-progs: convert/ext2: Fix memory leak caused by handled ext2_filsys 2018-02-14 16:33:31 +01:00
image btrfs-progs: treewide: Replace strerror(errno) with %m. 2018-01-31 15:14:03 +01:00
kernel-lib btrfs-progs: kernel-lib: add generated tables.c 2017-08-24 19:06:31 +02:00
kernel-shared btrfs-progs: shared: cleanup includes in ulist.c 2017-03-08 13:00:47 +01:00
libbtrfsutil libbtrfsutil: add btrfs_util_[gs]et_read_only() 2018-03-06 11:28:36 +01:00
m4
mkfs btrfs-progs: mkfs/rootdir: Fix memory leak in traverse_directory() 2018-02-14 16:31:19 +01:00
tests btrfs-progs: tests: add helper to log pipe stdout 2018-02-19 19:24:07 +01:00
travis btrfs-progs: ci: replace inline shell commands with scripts 2018-02-13 15:41:32 +01:00
.gitignore Add libbtrfsutil 2018-02-24 01:37:16 +01:00
.travis.yml btrfs-progs: ci: add python dependencies for libbtrfsutil 2018-02-24 01:37:17 +01: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 v4.15.1 2018-02-16 16:59:42 +01:00
COPYING
INSTALL libbtrfsutil: add Python bindings 2018-02-24 01:37:17 +01:00
Makefile libbtrfsutil: add btrfs_util_is_subvolume() and btrfs_util_subvolume_id() 2018-03-06 11:28:36 +01:00
Makefile.extrawarn
Makefile.inc.in libbtrfsutil: add Python bindings 2018-02-24 01:37:17 +01:00
README.md btrfs-progs: README: update links, enhance contribution section 2017-09-25 15:17:04 +02:00
VERSION Btrfs progs v4.15.1 2018-02-16 17:01:17 +01:00
androidcompat.h
autogen.sh btrfs-progs: build: simplify version tracking 2018-01-31 15:14:01 +01:00
backref.c btrfs-progs: backref: Allow backref walk to handle direct parent ref 2018-01-03 17:09:17 +01:00
backref.h btrfs-progs: move ulist.[ch] to kernel-shared 2017-03-08 13:00:47 +01:00
bcp
btrfs-calc-size.c btrfs-progs: Fix build of btrfs-calc-size 2018-01-08 18:18:47 +01:00
btrfs-completion btrfs-progs: cleanup whitespaces of btrfs-completion 2017-09-25 15:17:19 +02:00
btrfs-corrupt-block.c btrfs-progs: add crude error handling when transaction start fails 2017-09-08 16:15:05 +02:00
btrfs-crc.c
btrfs-debug-tree.c btrfs-progs: move command definitions to commands.h 2017-08-24 19:08:24 +02: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: move help defines to own header 2017-03-08 13:00:45 +01:00
btrfs-fragments.c
btrfs-list.c btrfs-progs: treewide: Replace strerror(errno) with %m. 2018-01-31 15:14:03 +01:00
btrfs-list.h
btrfs-map-logical.c btrfs-progs: updated and add missing function attributes to the definition 2017-09-25 15:18:32 +02:00
btrfs-select-super.c btrfs-progs: Refactor write_all_supers and its callers to use btrfs_fs_info 2017-07-12 17:53:28 +02:00
btrfs-show-super.c btrfs-progs: fix build of btrfs-show-super 2018-01-03 17:09:00 +01:00
btrfs-zero-log.c btrfs-progs: add crude error handling when transaction start fails 2017-09-08 16:15:05 +02:00
btrfs.c btrfs-progs: rework option parser to use getopt for global options 2017-03-31 19:40:57 +02:00
btrfsck.h
btrfstune.c btrfs-progs: add crude error handling when transaction start fails 2017-09-08 16:15:05 +02:00
chunk-recover.c btrfs-progs: Factor out common print_device_info 2018-01-31 15:14:01 +01:00
cmds-balance.c btrfs-progs: treewide: Replace strerror(errno) with %m. 2018-01-31 15:14:03 +01:00
cmds-device.c btrfs-progs: treewide: Replace strerror(errno) with %m. 2018-01-31 15:14:03 +01:00
cmds-fi-du.c btrfs-progs: fi du: don't call lookup_path_rootid for BTRFS_EMPTY_SUBVOL_DIR_OBJECTID 2017-09-08 16:15:05 +02:00
cmds-fi-usage.c btrfs-progs: treewide: Replace strerror(errno) with %m. 2018-01-31 15:14:03 +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: treewide: Replace strerror(errno) with %m. 2018-01-31 15:14:03 +01:00
cmds-inspect-dump-super.c btrfs-progs: treewide: Replace strerror(errno) with %m. 2018-01-31 15:14:03 +01:00
cmds-inspect-dump-tree.c btrfs-progs: dump_tree: remove superfluous _TREE 2018-01-03 17:09:33 +01:00
cmds-inspect-tree-stats.c btrfs-progs: treewide: Replace strerror(errno) with %m. 2018-01-31 15:14:03 +01:00
cmds-inspect.c btrfs-progs: treewide: Replace strerror(errno) with %m. 2018-01-31 15:14:03 +01:00
cmds-property.c btrfs-progs: move get_fsid() to utils.c 2017-10-06 13:23:27 +02:00
cmds-qgroup.c btrfs-progs: let callers of btrfs_show_qgroups free the buffers 2018-02-16 16:59:42 +01:00
cmds-quota.c btrfs-progs: treewide: Replace strerror(errno) with %m. 2018-01-31 15:14:03 +01:00
cmds-receive.c btrfs-progs: treewide: Replace strerror(errno) with %m. 2018-01-31 15:14:03 +01:00
cmds-replace.c btrfs-progs: treewide: Replace strerror(errno) with %m. 2018-01-31 15:14:03 +01:00
cmds-rescue.c btrfs-progs: rescue: Introduce fix-device-size 2017-11-14 15:59:00 +01:00
cmds-restore.c btrfs-progs: treewide: Replace strerror(errno) with %m. 2018-01-31 15:14:03 +01:00
cmds-scrub.c btrfs-progs: treewide: Replace strerror(errno) with %m. 2018-01-31 15:14:03 +01:00
cmds-send.c btrfs-progs: move help defines to own header 2017-03-08 13:00:45 +01:00
cmds-subvolume.c btrfs-progs: treewide: Replace strerror(errno) with %m. 2018-01-31 15:14:03 +01: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 libbtrfsutil: add Python bindings 2018-02-24 01:37:17 +01:00
ctree.c btrfs-progs: Cleanup use of root in leaf_data_end 2018-02-02 16:01:57 +01:00
ctree.h btrfs-progs: Introduce btrfs_raid_array and related infrastructures 2018-02-24 01:37:17 +01:00
dir-item.c btrfs-progs: Use fs_info instead of root for BTRFS_MAX_XATTR_SIZE 2018-02-02 16:01:57 +01:00
dir-test.c btrfs-progs: add crude error handling when transaction start fails 2017-09-08 16:15:05 +02:00
disk-io.c btrfs-progs: treewide: Replace strerror(errno) with %m. 2018-01-31 15:14:03 +01:00
disk-io.h btrfs-progs: move transaction code out of disk-io 2017-09-08 16:15:05 +02:00
extent-cache.c
extent-cache.h
extent-tree.c btrfs-progs: do clean up for redundancy value assignment 2018-02-02 16:01:57 +01:00
extent_io.c btrfs-progs: extent-cache: actually cache extent buffers 2017-10-06 13:41:06 +02:00
extent_io.h btrfs-progs: extent-cache: actually cache extent buffers 2017-10-06 13:41:06 +02:00
file-item.c btrfs-progs: Use fs_info instead of root for BTRFS_LEAF_DATA_SIZE 2018-02-02 16:01:56 +01:00
file.c btrfs-progs: Refactor read_extent_data to use btrfs_fs_info 2017-07-12 17:53:13 +02: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: fix endianity when reading from disk_key 2017-09-25 15:18:27 +02:00
free-space-cache.h
free-space-tree.c btrfs-progs: Refactor sectorsize users in free-space-tree.c 2017-07-03 13:35:10 +02:00
free-space-tree.h
fsck.btrfs
fsfeatures.c btrfs-progs: move fs features implementation to own file 2017-03-08 13:00:45 +01:00
fsfeatures.h btrfs-progs: Add zstd support 2017-09-25 15:17:13 +02:00
hash.h
hasher.c
help.c btrfs-progs: help: print multiple syntax schemas on separate lines 2017-11-14 15:59:00 +01:00
help.h btrfs-progs: updated and add missing function attributes to the definition 2017-09-25 15:18:32 +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
ioctl.h
kerncompat.h btrfs-progs: kerncompat: Fix re-definition of __bitwise 2017-03-16 17:40:35 +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 debugging macro checks 2017-09-25 15:18:17 +02:00
print-tree.c btrfs-progs: print-tree: fix INODE_ITEM sequence and flags 2018-02-13 16:22:55 +01:00
print-tree.h btrfs-progs: print-tree: rename item callbacks to match the key name 2017-09-08 16:15:05 +02:00
props.c btrfs-progs: prop: also allow "none" to disable compression 2017-11-14 15:59:00 +01:00
props.h
qgroup-verify.c btrfs-progs: drop blocksize from read_tree_block 2017-09-08 16:15:05 +02:00
qgroup-verify.h
qgroup.c btrfs-progs: let callers of btrfs_show_qgroups free the buffers 2018-02-16 16:59:42 +01:00
qgroup.h
quick-test.c btrfs-progs: Use fs_info instead of root for BTRFS_NODEPTRS_PER_BLOCK 2018-02-02 16:01:57 +01: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
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: send: always print a space after path in dump 2017-04-19 19:33:43 +02:00
send-dump.h
send-stream.c btrfs-progs: fix btrfs send & receive with -e flag 2017-04-07 18:51:19 +02:00
send-stream.h
send-utils.c btrfs-progs: treewide: Replace strerror(errno) with %m. 2018-01-31 15:14:03 +01:00
send-utils.h
send.h btrfs-progs: Introduce kernel sizes to cleanup large intermediate number 2017-03-08 13:00:45 +01:00
show-blocks
string-table.c
string-table.h
super-recover.c btrfs-progs: super-recover: fix the broken sb detection 2018-01-31 15:14:01 +01:00
task-utils.c
task-utils.h
transaction.c btrfs-progs: don't start or commit after transaction abort 2017-09-08 16:15:05 +02:00
transaction.h btrfs-progs: start framework for transaction abort 2017-09-08 16:15:05 +02:00
utils-lib.c
utils.c btrfs-progs: prevent incorrect use of subvol_strip_mountpoint 2018-02-19 19:07:02 +01:00
utils.h btrfs-progs: Factor out common print_device_info 2018-01-31 15:14:01 +01:00
uuid-tree.c btrfs-progs: treewide: Replace strerror(errno) with %m. 2018-01-31 15:14:03 +01:00
version.h.in
volumes.c btrfs-progs: volumes: Allow find_free_dev_extent() to return maximum hole size 2018-02-24 01:37:17 +01:00
volumes.h btrfs-progs: Move chunk stripe size calculation function to volumes.h 2018-03-06 11:28:26 +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)

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