Userspace utilities to manage btrfs filesystems
Go to file
Su Yanjun 07cead1a1e btrfs-progs: silence build warning caused by gcc 8 '-Wformat-truncation'
When using gcc8 + glibc 2.28.5 compiles utils.c, it complains as below:

  utils.c:852:45: warning: '%s' directive output may be truncated writing
  up to 4095 bytes into a region of size 4084 [-Wformat-truncation=]
     snprintf(path, sizeof(path), "/dev/mapper/%s", name);
                                             ^~   ~~~~
  In file included from /usr/include/stdio.h:873,
                   from utils.c:20:
  /usr/include/bits/stdio2.h:67:10: note: '__builtin___snprintf_chk'
  output between 13 and 4108 bytes into a destination of size 4096
     return __builtin___snprintf_chk (__s, __n, __USE_FORTIFY_LEVEL - 1,
            ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
          __bos (__s), __fmt, __va_arg_pack ());
          ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This isn't a type of warning we care about, particularly when calling
snprintf() we expect string to be truncated.

Use the GCC option -Wno-format-truncation to disable this for default
build and W=1 build, while still keeping it for W=2 and W=3 builds.

Signed-off-by: Su Yanjun <suyj.fnst@cn.fujitsu.com>
[ Use cc-disable-warning to fix the not working CFLAGS setting in configure.ac ]
[ Keep the warning in W=2/W=3 build ]
Signed-off-by: Qu Wenruo <wqu@suse.com>
Signed-off-by: David Sterba <dsterba@suse.com>
2019-01-15 16:20:10 +01:00
Documentation btrfs-progs: docs: fix typos in Documentation 2018-11-26 17:32:10 +01:00
check btrfs-progs: Remove fsid/metdata_uuid fields from fs_info 2019-01-15 16:20:09 +01:00
convert btrfs-progs: Add support for metadata_uuid field 2018-12-06 12:51:36 +01:00
image btrfs-progs: Add support for metadata_uuid field 2018-12-06 12:51:36 +01:00
kernel-lib btrfs-progs: fix typos in comments 2018-11-26 18:24:48 +01:00
kernel-shared
libbtrfsutil libbtrfsutil: fix unprivileged tests if kernel lacks support 2019-01-15 16:20:09 +01:00
m4 btrfs-progs: build: detect whether -std=gnu90 is supported 2018-06-07 16:37:35 +02:00
mkfs btrfs-progs: mkfs: fix typo in "multipler" variables 2018-11-26 18:24:49 +01:00
tests btrfs-progs: tests: Add tests for changing fsid feature 2019-01-15 16:20:09 +01: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: clean up .gitignore 2018-10-23 14:48:39 +02:00
.travis.yml btrfs-progs: ci: enable clang and python for musl build test 2018-03-06 11:28:38 +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.19.1 2018-12-05 15:04:23 +01:00
COPYING
INSTALL btrfs-progs: docs: fix typos in READMEs, INSTALL and CHANGES 2018-11-26 17:47:22 +01:00
Makefile btrfs-progs: silence build warning caused by gcc 8 '-Wformat-truncation' 2019-01-15 16:20:10 +01:00
Makefile.extrawarn btrfs-progs: silence build warning caused by gcc 8 '-Wformat-truncation' 2019-01-15 16:20:10 +01: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 v4.19.1 2018-12-05 15:05:38 +01: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
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: convert strerror to implicit %m 2018-10-31 18:24:14 +01:00
btrfs-crc.c
btrfs-debugfs
btrfs-find-root.c btrfs-progs: convert strerror to implicit %m 2018-10-31 18:24:14 +01:00
btrfs-fragments.c
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: convert strerror to implicit %m 2018-10-31 18:24:14 +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: fix typos in user-visible strings 2018-11-26 18:24:49 +01:00
btrfs.c btrfs-progs: fix typos in comments 2018-11-26 18:24:48 +01: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: Directly pass root to change_devices_uuid 2019-01-15 16:20:09 +01:00
chunk-recover.c btrfs-progs: Remove fsid/metdata_uuid fields from fs_info 2019-01-15 16:20:09 +01:00
cmds-balance.c btrfs-progs: Fix wrong optind re-initialization to allow mixed option and non-option 2018-08-06 14:59:45 +02:00
cmds-device.c btrfs-progs: convert strerror to implicit %m 2018-10-31 18:24:14 +01:00
cmds-fi-du.c btrfs-progs: convert strerror to implicit %m 2018-10-31 18:24:14 +01:00
cmds-fi-usage.c btrfs-progs: Fix wrong optind re-initialization to allow mixed option and non-option 2018-08-06 14:59:45 +02: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: Add support for metadata_uuid field 2018-12-06 12:51:36 +01:00
cmds-inspect-dump-super.c btrfs-progs: Add support for metadata_uuid field 2018-12-06 12:51:36 +01:00
cmds-inspect-dump-tree.c btrfs-progs: print-tree: Use bool for @follow 2018-10-31 18:24:14 +01:00
cmds-inspect-tree-stats.c btrfs-progs: convert strerror to implicit %m 2018-10-31 18:24:14 +01:00
cmds-inspect.c btrfs-progs: convert strerror to implicit %m 2018-10-31 18:24:14 +01:00
cmds-property.c btrfs-progs: convert strerror to implicit %m 2018-10-31 18:24:14 +01:00
cmds-qgroup.c btrfs-progs: qgroup: make --rescan the default behavior after assign 2018-10-31 18:24:14 +01:00
cmds-quota.c btrfs-progs: Fix wrong optind re-initialization to allow mixed option and non-option 2018-08-06 14:59:45 +02:00
cmds-receive.c btrfs-progs: convert strerror to implicit %m 2018-10-31 18:24:14 +01:00
cmds-replace.c btrfs-progs: convert strerror to implicit %m 2018-10-31 18:24:14 +01:00
cmds-rescue.c btrfs-progs: fix typos in comments 2018-11-26 18:24:48 +01:00
cmds-restore.c btrfs-progs: Replace root parameter using fs_info for reada_for_search() 2018-10-31 18:24:14 +01:00
cmds-scrub.c btrfs-progs: convert strerror to implicit %m 2018-10-31 18:24:14 +01:00
cmds-send.c btrfs-progs: convert strerror to implicit %m 2018-10-31 18:24:14 +01:00
cmds-subvolume.c btrfs-progs: convert strerror to implicit %m 2018-10-31 18:24:14 +01:00
commands.h
common-defs.h
configure.ac btrfs-progs: fix typos in user-visible strings 2018-11-26 18:24:49 +01:00
ctree.c btrfs-progs: Remove fsid/metdata_uuid fields from fs_info 2019-01-15 16:20:09 +01:00
ctree.h btrfs-progs: Remove btrfs_fs_info::new_fsid 2019-01-15 16:20:09 +01:00
delayed-ref.c btrfs-progs: kerncompat: rename swap to __swap 2018-11-13 13:33:15 +01:00
delayed-ref.h btrfs-progs: Add delayed refs infrastructure 2018-10-23 14:48:41 +02:00
dir-item.c btrfs-progs: dir-item: Make btrfs_delete_one_dir_name more robust to handle corrupted name len 2018-06-07 16:32:03 +02:00
disk-io.c btrfs-progs: Remove fsid/metdata_uuid fields from fs_info 2019-01-15 16:20:09 +01:00
disk-io.h btrfs-progs: fix typos in comments 2018-11-26 18:24:48 +01: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: treewide: Fix missing declarations 2018-11-13 13:32:41 +01:00
extent_io.c btrfs-progs: Add extent buffer bitmap manipulation infrastructure 2018-10-23 15:46:33 +02:00
extent_io.h btrfs-progs: Add extent buffer bitmap manipulation infrastructure 2018-10-23 15:46:33 +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
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
free-space-tree.c btrfs-progs: Remove fsid/metdata_uuid fields from fs_info 2019-01-15 16:20:09 +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
fsfeatures.h
hash.h
hasher.c
help.c btrfs-progs: fix typos in comments 2018-11-26 18:24:48 +01:00
help.h btrfs-progs: Remove unused parameter 2018-03-30 22:15:55 +02:00
inode-item.c
inode-map.c
inode.c
internal.h
ioctl-test.c
ioctl.h btrfs-progs: ioctl/libbtrfsutil: add 3 definitions of new unprivileged ioctl 2018-10-31 18:24:14 +01:00
kerncompat.h btrfs-progs: kerncompat: rename swap to __swap 2018-11-13 13:33:15 +01:00
library-test.c
messages.c
messages.h btrfs-progs: Eliminate remaining uses of strerror(errno) 2018-10-25 16:11:40 +02:00
print-tree.c btrfs-progs: fix typos in comments 2018-11-26 18:24:48 +01: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: convert strerror to implicit %m 2018-10-31 18:24:14 +01:00
qgroup.h
quick-test.c btrfs-progs: fix build of quick-test 2018-08-06 15:01:36 +02:00
random-test.c
rbtree-utils.c
rbtree-utils.h
repair.c
repair.h
root-tree.c
send-dump.c btrfs-progs: fix typos in comments 2018-11-26 18:24:48 +01:00
send-dump.h
send-stream.c btrfs-progs: fix typos in comments 2018-11-26 18:24:48 +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
show-blocks btrfs-progs: Remove btrfs-debug-tree command 2018-04-24 13:00:10 +02:00
string-table.c
string-table.h
super-recover.c btrfs-progs: rescue-super: don't double free fs_devices 2018-10-23 14:48:40 +02: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 typos in user-visible strings 2018-11-26 18:24:49 +01:00
transaction.h btrfs-progs: Add delayed refs infrastructure 2018-10-23 14:48:41 +02:00
utils-lib.c btrfs-progs: treewide: Fix missing declarations 2018-11-13 13:32:41 +01:00
utils.c btrfs-progs: utils: fix typo in a variable 2018-11-26 18:24:49 +01:00
utils.h btrfs-progs: treewide: Fix missing declarations 2018-11-13 13:32:41 +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: Remove fsid/metdata_uuid fields from fs_info 2019-01-15 16:20:09 +01:00
volumes.h btrfs-progs: Add support for metadata_uuid field 2018-12-06 12:51:36 +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