Userspace utilities to manage btrfs filesystems
Go to file
Josef Bacik 5dc3964aaa btrfs-progs: remove the _nr from the item helpers
Now that all callers are using the _nr variations we can simply rename
these helpers to btrfs_item_##member/btrfs_set_item_##member and change
the actual item SETGET funcs to raw_item_##member/set_raw_item_##member
and then change all callers to drop the _nr part.

Reviewed-by: Nikolay Borisov <nborisov@suse.com>
Signed-off-by: Josef Bacik <josef@toxicpanda.com>
Signed-off-by: David Sterba <dsterba@suse.com>
2022-03-09 15:13:13 +01:00
check btrfs-progs: remove the _nr from the item helpers 2022-03-09 15:13:13 +01:00
ci btrfs-progs: ci: add helpers to update base images 2022-02-01 18:41:40 +01:00
cmds btrfs-progs: remove the _nr from the item helpers 2022-03-09 15:13:13 +01:00
common btrfs-progs: repair: bail if we find an unaligned extent 2022-03-08 18:18:01 +01:00
convert btrfs-progs: remove the _nr from the item helpers 2022-03-09 15:13:13 +01:00
crypto btrfs-progs: libbtrfs: remove unneeded BTRFS_FLAT_INCLUDES protections 2021-10-08 20:47:03 +02:00
Documentation btrfs-progs: docs: document generic error 2022-03-08 18:11:40 +01:00
image btrfs-progs: remove the _nr from the item helpers 2022-03-09 15:13:13 +01:00
kernel-lib btrfs-progs: raid56: fix the wrong recovery condition for data and P case 2021-11-18 10:17:33 +01:00
kernel-shared btrfs-progs: remove the _nr from the item helpers 2022-03-09 15:13:13 +01:00
libbtrfs btrfs-progs: libbtrfs: copy btrfs_uuid_tree_lookup_any from uuid-tree.c 2021-10-08 20:46:35 +02:00
libbtrfsutil btrfs-progs: add definitions for the block group tree 2021-11-30 19:08:39 +01:00
m4
mkfs btrfs-progs: remove the _nr from the item helpers 2022-03-09 15:13:13 +01:00
tests btrfs-progs: tests: add a test to check orphaned directories 2022-03-08 18:47:21 +01:00
.editorconfig
.gitignore btrfs-progs: docs: add sphinx build support 2021-10-29 17:30:03 +02:00
64-btrfs-dm.rules
64-btrfs-zoned.rules btrfs-progs: add udev rule to use mq-deadline on zoned btrfs 2022-02-01 18:41:43 +01:00
autogen.sh
btrfs-completion
btrfs-corrupt-block.c btrfs-progs: remove the _nr from the item helpers 2022-03-09 15:13:13 +01:00
btrfs-crc.c
btrfs-debugfs
btrfs-find-root.c
btrfs-fragments.c
btrfs-map-logical.c btrfs-progs: stop accessing ->extent_root directly 2021-11-30 18:56:54 +01:00
btrfs-sb-mod.c btrfs-progs: sb-mod: improve help 2021-10-06 16:50:30 +02:00
btrfs-select-super.c btrfs-progs: libbtrfs: drop radix-tree.h from exported headers 2021-10-08 20:46:35 +02:00
btrfs.c
btrfstune.c btrfs-progs: btrfstune: experimental, new option to switch csums 2022-03-08 18:10:03 +01:00
CHANGES btrfs-progs: update CHANGES for 5.16.2 2022-02-16 23:22:28 +01:00
configure.ac btrfs-progs: docs: generate section 5 to final name directly 2022-02-16 23:24:12 +01:00
COPYING
fsck.btrfs
INSTALL btrfs-progs: build: make libudev selectable 2021-10-06 16:50:43 +02:00
ioctl.h btrfs-progs: remove support for BTRFS_SUBVOL_CREATE_ASYNC 2021-10-06 16:49:21 +02:00
kerncompat.h btrfs-progs: fix 64-bit mips and powerpc types 2022-02-16 22:44:58 +01:00
libbtrfs.sym btrfs-progs: libbtrfs: hide unused symbols, same version 2021-09-08 18:17:30 +02:00
Makefile btrfs-progs: tests: copy fsstress.c from fstests 2022-03-08 18:11:40 +01:00
Makefile.extrawarn
Makefile.inc.in btrfs-progs: build: add optional dependency on libudev 2021-10-06 16:50:32 +02:00
quick-test.c
random-test.c
README.md btrfs-progs: update README 2022-01-11 23:40:48 +01:00
show-blocks
VERSION Btrfs progs v5.16.2 2022-02-16 23:22:56 +01:00
version.h.in

Btrfs-progs 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 and also documentation:

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.libera.chat #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

Source code coding style and preferences follow the kernel coding style. You can find the editor settings in .editorconfig and use the EditorConfig plugin to let your editor use that, or update your editor settings manually.

Testing

The testing documentation can be found in tests/ and continuous integration/container images in ci/.

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.

Documents are written in RST and built by sphinx.

Third-party sources

Build dependencies are listed in INSTALL. Implementation of checksum/hash functions is provided by copies of the respective sources to avoid adding dependencies that would make deployments in rescure or limited environments harder. The implementations are portable and not optimized for speed nor accelerated. Optionally it's possible to use libgcrypt, libsodium or libkcapi implementations.

Some other code is borrowed from kernel, eg. the raid5 tables or data structure implementation.

References