Go to file
David Sterba d8f93ce802 btrfs-progs: Update README and other docs
Signed-off-by: David Sterba <dsterba@suse.com>
2016-11-23 11:07:05 +01:00
Documentation btrfs-progs: Update README and other docs 2016-11-23 11:07:05 +01:00
kernel-lib btrfs-progs: crc32: use fallback implementation for unaligned buffers 2016-11-09 13:47:35 +01:00
m4 btrfs-progs: build: add m4 macros for AC_CHECK_DEFINE 2016-06-24 14:05:44 +02:00
tests btrfs-progs: Update README and other docs 2016-11-23 11:07:05 +01:00
.gitignore btrfs-progs: Ignore clang complete file 2016-11-09 13:13:41 +01:00
.travis.yml btrfs-progs: tests: add more tests to the CI build 2016-11-23 11:07:03 +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: Add Android build mk file 2015-09-01 14:02:49 +02:00
CHANGES btrfs-progs: update CHANGES for v4.8.3 2016-11-11 16:26:57 +01:00
COPYING fix COPYING 2007-06-12 15:41:08 -04:00
INSTALL btrfs-progs: Update README and other docs 2016-11-23 11:07:05 +01:00
Makefile.extrawarn btrfs-progs: build: allow to build with various compiler warnings 2015-10-21 14:29:26 +02:00
Makefile.in btrfs-progs: test: fix error of test target of Makefile 2016-11-23 11:07:05 +01:00
README.md btrfs-progs: Update README and other docs 2016-11-23 11:07:05 +01:00
androidcompat.h btrfs-progs: add compat header for android 2015-09-01 14:02:49 +02:00
autogen.sh btrfs-progs: build: let autotools include m4 2016-06-24 14:05:44 +02:00
backref.c btrfs-progs: cleanup, kill trivial btrfs_key_type helper 2016-10-03 11:33:15 +02:00
backref.h btrfs-progs: unify header file inclusion protections 2015-01-21 17:49:26 +01:00
bcp Btrfs-progs: Correct path munging in bcp 2011-10-25 09:18:58 -04:00
bitops.h btrfs-progs: compat: define DIV_ROUND_UP if not already defined 2015-06-05 23:29:59 +02:00
btrfs-calc-size.c btrfs-progs: copy btrfs-calc-size to inspect-internal tree-stats 2016-05-02 14:39:53 +02:00
btrfs-completion btrfs-progs: update docs and completion for tree-stats 2016-05-02 14:39:57 +02:00
btrfs-convert.c btrfs-progs: convert: use on-stack path buffer in link_subvol 2016-11-09 13:47:31 +01:00
btrfs-corrupt-block.c btrfs-progs: corrupt-block: fix assertion condition 2016-10-03 11:33:15 +02:00
btrfs-crc.c btrfs-progs: btrfs-crc: make argc check more strict 2016-06-03 14:49:43 +02:00
btrfs-debug-tree.c btrfs-progs: unify naming of argc and argv 2016-03-14 13:42:47 +01:00
btrfs-debugfs btrfs-progs: btrfs-debugfs: cleanup unused variables reported by pylint 2016-10-24 14:57:46 +02:00
btrfs-find-root.c btrfs-progs: Add new option for specify chunk root bytenr 2016-03-14 13:42:47 +01:00
btrfs-fragments.c btrfs-progs: use symbolic tree name when searching 2016-11-09 13:47:29 +01:00
btrfs-image.c btrfs-progs: image: use embedded array for metadump cluster buffer 2016-11-09 13:47:31 +01:00
btrfs-list.c btrfs-progs: subvol show: print more details about toplevel subvolume 2016-11-09 13:47:29 +01:00
btrfs-list.h btrfs-progs: subvol show: print more details about toplevel subvolume 2016-11-09 13:47:29 +01:00
btrfs-map-logical.c btrfs-progs: use standard allocation functions in non-kenrel code 2016-10-03 11:33:15 +02:00
btrfs-select-super.c btrfs-progs: print help test to stdout 2016-09-05 12:20:24 +02:00
btrfs-show-super.c btrfs-progs: introduce inspect-internal dump-super 2016-03-14 13:42:47 +01:00
btrfs-zero-log.c btrfs-progs: print help test to stdout 2016-09-05 12:20:24 +02:00
btrfs.c btrfs-progs: move prefixcmp to utils 2016-01-14 11:07:10 +01:00
btrfsck.h btrfs-progs: chunk-recovery: Fix a float point error 2015-11-19 18:34:30 +01:00
btrfstune.c btrfs-progs: btrfstune: use on-stack path buffer in change_devices_uuid 2016-11-09 13:47:34 +01:00
chunk-recover.c btrfs-progs: add OPEN_CTREE_INVALIDATE_FST flag 2016-11-23 11:07:05 +01:00
cmds-balance.c btrfs-progs: balance: add another (shorter) option for background 2016-07-26 19:30:39 +02:00
cmds-check.c btrfs-progs: check: fix missing newlines 2016-11-23 11:07:05 +01:00
cmds-device.c btrfs-progs: rename btrfs_scan_lblkid() to btrfs_scan_devices() 2016-10-25 14:28:36 +02:00
cmds-fi-du.c btrfs-progs: fi du: don't redefine standard macro/function 2016-11-09 13:47:31 +01:00
cmds-fi-du.h btrfs-progs: filesystem: add 'du' command 2016-03-14 13:42:47 +01:00
cmds-fi-usage.c btrfs-progs: fi usage: improved error handling in load_device_info 2016-09-21 14:12:10 +02:00
cmds-fi-usage.h btrfs-progs: add missing includes to header files 2015-06-10 02:52:21 +02:00
cmds-filesystem.c btrfs-progs: rename btrfs_scan_lblkid() to btrfs_scan_devices() 2016-10-25 14:28:36 +02:00
cmds-inspect-dump-super.c btrfs-progs: format FREE_SPACE_TREE{,_VALID} nicely in dump-super 2016-11-23 11:07:05 +01:00
cmds-inspect-dump-super.h btrfs-progs: unify naming of argc and argv 2016-03-14 13:42:47 +01:00
cmds-inspect-dump-tree.c btrfs-progs: dump-tree: fix crash on unrecognized tree id 2016-10-25 14:28:36 +02:00
cmds-inspect-dump-tree.h btrfs-progs: unify naming of argc and argv 2016-03-14 13:42:47 +01:00
cmds-inspect-tree-stats.c btrfs-progs: tree-stats: use on-stack path buffer in calc_root_size 2016-11-09 13:47:33 +01:00
cmds-inspect-tree-stats.h btrfs-progs: copy btrfs-calc-size to inspect-internal tree-stats 2016-05-02 14:39:53 +02:00
cmds-inspect.c btrfs-progs: rename lookup_ino_rootid 2016-11-09 13:47:28 +01:00
cmds-property.c btrfs-progs: prop: simplify help printing code 2016-10-03 11:33:14 +02:00
cmds-qgroup.c btrfs-progs: rename lookup_ino_rootid 2016-11-09 13:47:28 +01:00
cmds-quota.c btrfs-progs: do not set optind if not necessary 2016-07-13 19:41:55 +02:00
cmds-receive.c btrfs-progs: use existing rootid resolving helper in btrfs_list_get_path_rootid 2016-11-09 13:47:28 +01:00
cmds-replace.c btrfs-progs: refactor and extend btrfs_prepare_device arguments 2016-07-28 14:08:30 +02:00
cmds-rescue.c btrfs-progs: unify argc min/max checking, a few more 2016-03-14 13:42:47 +01:00
cmds-restore.c btrfs-progs: restore: use on-stack path buffer in find_first_dir 2016-11-09 13:47:34 +01:00
cmds-scrub.c btrfs-progs: scrub: improved error handling in scrub_read_file 2016-09-21 14:12:10 +02:00
cmds-send.c btrfs-progs: send: fix failure of fstests btrfs/038 2016-11-23 11:07:05 +01:00
cmds-subvolume.c btrfs-progs: subvol show: print more details about toplevel subvolume 2016-11-09 13:47:29 +01:00
commands.h btrfs-progs: clean up commands.h 2016-06-01 14:56:56 +02:00
configure.ac btrfs-progs: build: detect fiemap shared flag but don't fail build 2016-10-25 14:28:36 +02:00
ctree.c btrfs-progs: handle errors from btrfs_alloc_path 2016-09-21 14:12:38 +02:00
ctree.h btrfs-progs: add btrfs_clear_free_space_tree() from the kernel 2016-11-23 11:07:05 +01:00
dir-item.c btrfs-progs: cleanup, kill trivial btrfs_key_type helper 2016-10-03 11:33:15 +02:00
dir-test.c btrfs-progs: cleanup, kill trivial btrfs_set_key_type helper 2016-10-03 11:33:15 +02:00
disk-io.c btrfs-progs: add OPEN_CTREE_INVALIDATE_FST flag 2016-11-23 11:07:05 +01:00
disk-io.h btrfs-progs: add OPEN_CTREE_INVALIDATE_FST flag 2016-11-23 11:07:05 +01:00
extent-cache.c btrfs-progs: extent-tree: Add add_merge_cache_extent function 2016-01-12 15:01:03 +01:00
extent-cache.h btrfs-progs: typo review of strings and comments 2016-06-01 14:56:56 +02:00
extent-tree.c btrfs-progs: add btrfs_clear_free_space_tree() from the kernel 2016-11-23 11:07:05 +01:00
extent_io.c btrfs-progs: handler memory allocation error in write_data_to_disk 2016-07-28 14:08:30 +02:00
extent_io.h btrfs-progs: Remove unnecessary parameter to clear_extent_uptodate 2016-10-03 15:07:23 +02:00
file-item.c btrfs-progs: change btrfs_csum_final result param type to u8 2016-10-03 11:35:50 +02:00
file.c btrfs-progs: typo review of strings and comments 2016-06-01 14:56:56 +02:00
find-root.c btrfs-progs: replace leafsize with nodesize 2016-05-02 14:40:18 +02:00
find-root.h btrfs-progs: find-root: Allow btrfs-find-root to search chunk root even chunk root is corrupted 2016-02-26 17:27:58 +01:00
free-space-cache.c btrfs-progs: check: add support to clear v1 free space cache 2016-11-09 13:12:47 +01: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: add btrfs_clear_free_space_tree() from the kernel 2016-11-23 11:07:05 +01:00
free-space-tree.h btrfs-progs: add btrfs_clear_free_space_tree() from the kernel 2016-11-23 11:07:05 +01:00
fsck.btrfs btrfs-progs: fsck.btrfs: Fix bashism and bad getopts processing 2015-05-21 16:53:44 +02:00
hash.h btrfs-progs: move btrfs_extref_hash() to hash.h 2016-10-25 14:28:36 +02:00
hasher.c Unaligned access fixes 2008-02-15 11:19:58 -05:00
help.c btrfs-progs: move prefixcmp to utils 2016-01-14 11:07:10 +01:00
inode-item.c btrfs-progs: move btrfs_extref_hash() to hash.h 2016-10-25 14:28:36 +02:00
inode-map.c btrfs-progs: handle errors from btrfs_alloc_path 2016-09-21 14:12:38 +02:00
inode.c btrfs-progs: convert: Fix a regression that ext2_save/image is not readonly 2016-08-19 13:52:43 +02:00
internal.h btrfs-progs: libbtrfs: remove max/min macros from API 2016-03-14 13:42:47 +01:00
ioctl-test.c btrfs-progs: tests: make the ioctl-test actually useful 2016-10-24 14:57:19 +02:00
ioctl.h btrfs-progs: ioctl: fix compilation if ioctl.h is included standalone 2016-11-23 10:49:33 +01:00
kerncompat.h btrfs-progs: ioctl: make build-time structure size checks optional 2016-10-10 10:11:31 +02:00
library-test.c btrfs-progs: build, add basic build test for library 2014-11-07 17:52:57 +01:00
mkfs.c btrfs-progs: mkfs: print the new UUID 2016-11-11 16:25:18 +01:00
print-tree.c btrfs-progs: dump-tree: use new names for obsoleted keys 2016-11-09 13:47:31 +01:00
print-tree.h btrfs-progs: Enhance and export print_key_type function 2016-09-05 10:04:07 +02:00
props.c btrfs-progs: prop: convert error messages to use error() 2016-05-11 16:37:12 +02:00
props.h btrfs-progs: unify header file inclusion protections 2015-01-21 17:49:26 +01:00
qgroup-verify.c btrfs-progs: qgroup: use on-stack path buffer in repair_qgroup_status 2016-11-09 13:47:32 +01:00
qgroup-verify.h btrfs-progs: check: write corrected qgroup info to disk 2016-07-13 18:44:26 +02:00
qgroup.c btrfs-progs: qgroup: fix error in ASSERT condition expression 2016-11-23 11:07:05 +01:00
qgroup.h btrfs-progs: remove unused function btrfs_get_path_rootid 2016-11-09 13:47:28 +01:00
quick-test.c btrfs-progs: cleanup, kill trivial btrfs_set_key_type helper 2016-10-03 11:33:15 +02:00
raid56.c btrfs-progs: rename raid6.c to raid56.c 2016-10-24 15:03:20 +02:00
random-test.c btrfs-progs: cleanup, kill trivial btrfs_set_key_type helper 2016-10-03 11:33:15 +02:00
rbtree-utils.c Btrfs-progs: break out rbtree util functions 2014-10-14 10:39:39 +02:00
rbtree-utils.h btrfs-progs: libbtrfs, make exported headers compatible with C++ 2014-11-03 23:50:50 +01:00
repair.c btrfs-progs: factor out repair mode 2016-07-04 15:22:53 +02:00
repair.h btrfs-progs: factor out repair mode 2016-07-04 15:22:53 +02:00
root-tree.c btrfs-progs: add btrfs_clear_free_space_tree() from the kernel 2016-11-23 11:07:05 +01:00
send-stream.c btrfs-progs: send-stream: track the read position in the stream 2016-11-23 10:50:35 +01:00
send-stream.h btrfs-progs: add missing includes to header files 2015-06-10 02:52:21 +02:00
send-utils.c btrfs-progs: typo review of strings and comments 2016-06-01 14:56:56 +02:00
send-utils.h btrfs-progs: drop argument from attribute deprecated 2015-06-30 15:05:07 +02:00
send.h btrfs-progs: unify header file inclusion protections 2015-01-21 17:49:26 +01:00
show-blocks btrfs-progs: typo review of strings and comments 2016-06-01 14:56:56 +02:00
string-table.c btrfs-progs: constify string arguments where appropriate 2016-10-03 15:07:23 +02:00
string-table.h btrfs-progs: constify string arguments where appropriate 2016-10-03 15:07:23 +02:00
super-recover.c btrfs-progs: super-recover: Reuse btrfs_read_dev_super function 2016-10-03 15:07:22 +02:00
task-utils.c btrfs-progs: Check periodic.timer_fd's value before use 2015-11-16 14:23:45 +01:00
task-utils.h btrfs-progs: unify header file inclusion protections 2015-01-21 17:49:26 +01:00
transaction.h btrfs-progs: add missing includes to header files 2015-06-10 02:52:21 +02:00
ulist.c btrfs-progs: typo review of strings and comments 2016-06-01 14:56:56 +02:00
ulist.h btrfs-progs: unify header file inclusion protections 2015-01-21 17:49:26 +01:00
utils-lib.c btrfs-progs: drop feature defines from C files, in favour of CFLAGS defines 2015-01-27 14:45:59 +01:00
utils.c btrfs-progs: utils: Fix NULL pointer derefernces in string_is_numerical 2016-11-23 10:48:13 +01:00
utils.h btrfs-progs: rename lookup_ino_rootid 2016-11-09 13:47:28 +01:00
uuid-tree.c btrfs-progs: use ioctl search headers everywhere 2016-05-11 15:53:16 +02:00
version.h.in btrfs-progs: re-introduce BTRFS_BUILD_VERSION in version.h 2015-03-16 18:40:06 +01:00
version.sh Btrfs progs v4.8.3 2016-11-11 16:28:18 +01:00
volumes.c btrfs-progs: Fix memory leak in write_raid56_with_parity 2016-11-11 16:23:30 +01:00
volumes.h btrfs-progs: Fix wrong tree block alignment for unalianged block group 2016-10-25 14:31:06 +02: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.

  • 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
  • to the mailing list linux-btrfs@vger.kernel.org -- (not required to subscribe), beware that the mail might get overlooked in other traffic
  • github issue tracker
  • IRC (irc.freenode.net #btrfs) -- good for discussions eg. if a bug is already known, but reports could miss developers' attention

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 here (chapter 11)

Exceptions: documentation fixes or updates do not need much explanation so sticking to the above rules is not necessary. Github pull requests are OK.

References