Userspace utilities to manage btrfs filesystems
Go to file
Naohiro Aota 0792c17028 btrfs-progs: build: set include path relatively
Currently, gcc is passed the include directory with full path. As a result,
dependency files (*.o.d) also record the full path at the build time. Such
full path dependency is annoying for sharing the source between multiple
machines, containers, or anything the path differ.

And this is the same way what other program using autotools e.g. e2fsprogs
is doing:

$ grep top_builddir Makefile
top_builddir = .
CPPFLAGS = -I. -I$(top_builddir)/lib -I$(top_srcdir)/lib
BUILD_CFLAGS = -g -O2  -I. -I$(top_builddir)/lib -I$(top_srcdir)/lib -DHAVE_CONFIG_H
<snip>

Signed-off-by: Naohiro Aota <naota@elisp.net>
[ set TOPDIR=. instead of -I as discussed, does not harm linker ]
Signed-off-by: David Sterba <dsterba@suse.com>
2017-10-13 20:16:01 +02:00
Documentation btrfs-progs: docs: update btrfs-balance 2017-10-06 13:41:12 +02:00
convert btrfs-progs: add a parameter to btrfs_mksubvol 2017-10-06 13:23:37 +02:00
image btrfs-progs: image: use CRC32C reversing instead of brute force to find collisions 2017-09-25 15:17:01 +02: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
m4
mkfs btrfs-progs: mkfs: remove unused function 2017-10-06 13:23:46 +02:00
tests btrfs-progs: tests: add more configure option coverage 2017-10-13 20:15:54 +02:00
travis btrfs-progs: build: move travis helper script to own directory 2017-10-13 20:15:50 +02:00
.gitignore btrfs-progs: kernel-lib: add generated tables.c 2017-08-24 19:06:31 +02:00
.travis.yml btrfs-progs: tests: add testing image for zstd for btrfs-restore 2017-09-25 15:17:15 +02:00
64-btrfs-dm.rules
Android.mk btrfs-progs: build: sync Makefile to Android.mk 2017-09-25 15:17:09 +02:00
CHANGES btrfs-progs: update CHANGES for v4.13.2 2017-10-06 14:36:50 +02:00
COPYING
INSTALL btrfs-progs: Add zstd support 2017-09-25 15:17:13 +02:00
Makefile btrfs-progs: build: set include path relatively 2017-10-13 20:16:01 +02:00
Makefile.extrawarn
Makefile.inc.in btrfs-progs: Add zstd support 2017-09-25 15:17:13 +02:00
README.md btrfs-progs: README: update links, enhance contribution section 2017-09-25 15:17:04 +02:00
androidcompat.h
autogen.sh
backref.c btrfs-progs: backref: use separate list for indirect refs 2017-10-06 13:41:10 +02: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: Removed missing header file, fixes compilation error 2017-09-25 15:16:52 +02: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-progs: use symbolic tree name when searching 2016-11-09 13:47:29 +01:00
btrfs-list.c btrfs-progs: subvol list: don't list FS_TREE as deleted 2017-10-06 13:41:37 +02: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: 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: deprecate standalone btrfs-show-super 2016-11-24 13:06:36 +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: add crude error handling when transaction start fails 2017-09-08 16:15:05 +02:00
cmds-balance.c btrfs-progs: balance: minor wording adjustment for full balance warning 2017-04-19 18:07:03 +02:00
cmds-check.c btrfs-progs: check: drop exclusive open mode for --force 2017-10-13 20:15:43 +02:00
cmds-device.c btrfs-progs: Fix 'btrfs device stats --check' cli option 2017-06-26 17:09:48 +02: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: device usage: don't calculate slack on missing device 2017-09-08 16:15:05 +02:00
cmds-fi-usage.h btrfs-progs: move command definitions to commands.h 2017-08-24 19:08:24 +02:00
cmds-filesystem.c btrfs-progs: change seen_fsid to hold fd and DIR 2017-10-06 13:23:30 +02:00
cmds-inspect-dump-super.c btrfs-progs: Add zstd support 2017-09-25 15:17:13 +02:00
cmds-inspect-dump-tree.c btrfs-progs: drop blocksize from read_tree_block 2017-09-08 16:15:05 +02:00
cmds-inspect-tree-stats.c btrfs-progs: drop blocksize from read_tree_block 2017-09-08 16:15:05 +02:00
cmds-inspect.c btrfs-progs: inspect rootid: Allow a file to be specified 2017-09-08 16:15:05 +02: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: move help defines to own header 2017-03-08 13:00:45 +01:00
cmds-quota.c btrfs-progs: move help defines to own header 2017-03-08 13:00:45 +01:00
cmds-receive.c btrfs-progs: recieve: add missing short option E to getopt 2017-08-24 19:14:19 +02:00
cmds-replace.c btrfs-progs: move more mkfs declarations to the common header 2017-03-08 13:00:46 +01:00
cmds-rescue.c btrfs-progs: add crude error handling when transaction start fails 2017-09-08 16:15:05 +02:00
cmds-restore.c btrfs-progs: Add zstd support 2017-09-25 15:17:13 +02:00
cmds-scrub.c btrfs-progs: move help defines to own header 2017-03-08 13:00:45 +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: subvol: group options in help 2017-10-06 13:41:21 +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: build: allow '--with-convert=' to accept comma-separated values 2017-10-13 20:15:51 +02:00
ctree.c btrfs-progs: drop blocksize argument from readahead_tree_block 2017-09-08 16:15:05 +02:00
ctree.h btrfs-progs: add a parameter to btrfs_mksubvol 2017-10-06 13:23:37 +02:00
dir-item.c btrfs-progs: drop unused argument from btrfs_extend_item 2017-03-08 13:00:47 +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: handle transaction start failure in close_ctree 2017-09-08 16:15:05 +02: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: Fix one-byte overlap bug in free_block_group_cache 2017-09-25 15:17:52 +02: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: convert: add support for converting reiserfs 2017-09-08 16:15:05 +02: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 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: Refactor sectorsize users in free-space-tree.c 2017-07-03 13:35:10 +02: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
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 btrfs-progs: move btrfs_extref_hash() to hash.h 2016-10-25 14:28:36 +02:00
hasher.c
help.c btrfs-progs: updated and add missing function attributes to the definition 2017-09-25 15:18:32 +02: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: add a parameter to btrfs_mksubvol 2017-10-06 13:23:37 +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: ioctl: fix compilation if ioctl.h is included standalone 2016-11-23 10:49:33 +01:00
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: use proper helper for reading offset 2017-09-25 15:18:19 +02: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
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: qgroup show: refine error messages 2017-01-25 09:47:58 +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: add crude error handling when transaction start fails 2017-09-08 16:15:05 +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
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 btrfs-progs: introduce new send-dump object 2016-12-14 15:06:34 +01:00
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: handle failed strdup in subvol_uuid_search2 2016-12-14 15:06:36 +01:00
send-utils.h btrfs-progs: fixup API after change in subvol_uuid_search 2016-12-14 15:06:36 +01:00
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 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: Refactor write_all_supers and its callers to use btrfs_fs_info 2017-07-12 17:53:28 +02: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 btrfs-progs: move lookup_path_rootid to library utils 2016-11-24 13:06:36 +01:00
utils.c btrfs-progs: extent-cache: actually cache extent buffers 2017-10-06 13:41:06 +02:00
utils.h btrfs-progs: extent-cache: actually cache extent buffers 2017-10-06 13:41:06 +02:00
uuid-tree.c
version.h.in
version.sh Btrfs progs v4.13.2 2017-10-06 14:37:57 +02:00
volumes.c btrfs-progs: Refactor find_next_chunk to get rid of parameter root and objectid 2017-09-25 15:17:48 +02:00
volumes.h btrfs-progs: Refactor chunk creation functions to use btrfs_fs_info 2017-07-12 17:54:16 +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. 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