pub/scm/linux/kernel/git/kdave/btrfs-progs.git  about / heads / tags
Userspace tools for btrfs
$ git log --pretty=format:'%h %s (%cs)%d'
5d97c32d Btrfs progs v6.8.1 (2024-05-02)
	(HEAD -> master, tag: v6.8.1)
f2518c82 btrfs-progs: update CHANGES for 6.8.1 (2024-05-02)
10da73dc btrfs-progs: tests: remove misc/061-subvol-delete-qgroup test case (2024-04-30)
99447fb7 Revert "btrfs-progs: subvol delete: add options to delete the qgroup" (2024-04-30)
40588d4a btrfs-progs: docs: fix build due to phony contents.rst (2024-04-30)
152c7089 btrfs-progs: docs: update feature status (2024-04-30)
7f396f5c btrfs-progs: reorder key initializations (2024-04-30)
5a956bb3 btrfs-progs: docs: how to get the length of the portion used by btrfs on a device (2024-04-30)
8af90d49 btrfs-progs: docs: minor improvement in resize (2024-04-30)
ad1de33b btrfs-progs: docs: fix broken link from Status to Changes (feature/version) (2024-04-30)
...

$ git cat-file blob HEAD:README.md
Btrfs-progs
===========

[![devel](https://github.com/kdave/btrfs-progs/actions/workflows/devel.yml/badge.svg)](https://github.com/kdave/btrfs-progs/actions/workflows/devel.yml)
[![coverage](https://github.com/kdave/btrfs-progs/actions/workflows/coverage.yml/badge.svg)](https://github.com/kdave/btrfs-progs/actions/workflows/coverage.yml)
[![codecov](https://codecov.io/gh/kdave/btrfs-progs/branch/coverage-test/graph/badge.svg?token=fhLI8V9s0k)](https://codecov.io/gh/kdave/btrfs-progs)
[![static](https://github.com/kdave/btrfs-progs/actions/workflows/artifacts-static-build.yml/badge.svg)](https://github.com/kdave/btrfs-progs/actions/workflows/artifacts-static-build.yml)
[![release](https://github.com/kdave/btrfs-progs/actions/workflows/ci-build-test.yml/badge.svg)](https://github.com/kdave/btrfs-progs/actions/workflows/ci-build-test.yml)

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:

* **btrfs** — the main administration tool ([manual page](https://btrfs.readthedocs.io/en/latest/btrfs.html))
* **mkfs.btrfs** — utility to create the filesystem ([manual page](https://btrfs.readthedocs.io/en/latest/mkfs.btrfs.html))
* all-in-one binary in the busybox style with mkfs.btrfs, btrfs-image and other tools built-in ([standalone tools](https://btrfs.readthedocs.io/en/latest/btrfs.html#standalone-tools))
* **libbtrfsutil** (LGPL v2.1) — C and python 3 bindings, see [libbtrfsutil/README.md](libbtrfsutil/README.md) for more
* manual pages and documentation source published at [btrfs.readthedocs.io](https://btrfs.readthedocs.io) (RTD)

See [INSTALL](INSTALL) for build instructions, [tests/README.md](tests/README.md) for
testing information and [ci/README.md](ci/README.md) for CI 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](https://www.kernel.org/pub/linux/kernel/people/kdave/btrfs-progs/).
See file [CHANGES](CHANGES) or [changelogs on RTD](https://btrfs.readthedocs.io/en/latest/CHANGES.html).

Releases with changelog are also published at [Github release page](https://github.com/kdave/btrfs-progs/releases).

### Static binaries

For each release there are static binaries of `btrfs` and `btrfs.box` provided.
These can be used in rescue environments and are built for `x86_64`
architecture (with maximum backward compatibility), inside the [Github Actions
workflow](https://github.com/kdave/btrfs-progs/actions/workflows/artifacts-static-build.yml).
The `btrfs.box` is an all-in-one tool in the [busybox](https://www.busybox.net)
style, the functionality is determined by the binary names (either symlink,
hradlink or a file copy).

### Feature compatibility

The *btrfs-progs* of version *X.Y* declare support of kernel features of the same
version. New progs on old kernel are expected to work, limited only by features
provided by the kernel.

### Build compatibility

Build is supported on the [GNU C library](https://www.gnu.org/software/libc/)
as the primary target, and on the [musl libc](https://musl.libc.org/).

The supported compilers are [gcc](https://gcc.gnu.org/) (minimal version 4.8)
and [clang](https://clang.llvm.org/) (minimal version 3.4).

Build tests are done on [several distributions](https://github.com/kdave/btrfs-progs/blob/master/.github/workflows/ci-build-test.yml), see
[Github actions workflow](https://github.com/kdave/btrfs-progs/actions/workflows/ci-build-test.yml).

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](https://github.com/kdave/btrfs-progs/issues)
* 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
* please don't use https://bugzilla.kernel.org for btrfs-progs bugs

Development
-----------

The development takes place in the mailing list (*linux-btrfs@vger.kernel.org*)
or at Github (issues, pull requests). Changes should be split to logical parts
if possible, documentation may be included in the same patch as to code or
separately.

The development model of btrfs-progs shares a lot with the kernel model. The

* **one logical change per patch**: e.g. not mixing bugfixes, cleanups, features
  etc., sometimes it's not clear and will be usually pointed out during reviews
* proper **subject line**: e.g. 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 is not mandatory for less significant changes
  (typos, documentation) but is desired as this documents who authored the
  change, you can read more about the
  [The Developer's Certificate of Origin (chapter 11)](https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin)
  * 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

### Pull requests

The pull requests on Github may be used for code or documentation
contributions. There are basic build checks enabled in the Github actions CI
for pull requests. The status can be checked at the
[workflow page](https://github.com/kdave/btrfs-progs/actions/workflows/pull-request.yml).

* open a PR against branches *devel* or *master*
* push update to the same branch if you need to
* close the PR in case it's wrong, a mistake or needs rework
* if you're sure the changes don't need a CI build verification, please add `[skip ci]` to the changelog

Source code coding style and preferences follow the
[kernel coding style](https://www.kernel.org/doc/html/latest/process/coding-style.html).
You can find the editor settings in `.editorconfig` and use the
[EditorConfig](https://editorconfig.org/) plugin to let your editor use that,
or update your editor settings manually.

Testing
-------

The documentation for writing and running tests can be found in
[tests/](tests/README.md) and continuous integration/container images in
[ci/](ci/README.md).

Development branches are tested by Github
[Action workflows](https://github.com/kdave/btrfs-progs/actions).

Code coverage provided by [codecov.io](https://codecov.io) can be found
[here](https://codecov.io/gh/kdave/btrfs-progs).

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
mailing list. Pointing out typos via IRC also works, although might get
accidentally lost in the noise.

Documentation sources are written in
[RST](https://en.wikipedia.org/wiki/ReStructuredText) and built by sphinx.

Third-party sources
-------------------

Build dependencies are listed in [INSTALL](INSTALL). Implementation of checksum/hash
functions is provided by copies of the respective sources to avoid adding
dependencies that would make deployments in rescue or limited environments
harder. The implementations are portable and there are optimized versions for
some architectures.  Optionally it's possible to use
[libgcrypt](https://www.gnupg.org/software/libgcrypt/index.html),
[libsodium](https://doc.libsodium.org),
[libkcapi](https://www.chronox.de/libkcapi.html),
[Botan](https://botan.randombit.net) or
[OpenSSL](https://www.openssl.org) implementations.

The builtin implemtations uses the following sources:
[CRC32C](https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git),
[XXHASH](https://github.com/Cyan4973/xxHash),
[SHA256](https://tools.ietf.org/html/rfc4634),
[BLAKE2](https://github.com/BLAKE2/BLAKE2).

Some other code is borrowed from kernel, eg. the raid5 tables or data structure
implementation (list, rb-tree).

References
----------

* [Documentation](https://btrfs.readthedocs.io)
* [Manual pages](https://btrfs.readthedocs.io/en/latest/man-index.html)
* [Changes -- btrfs-progs](https://btrfs.readthedocs.io/en/latest/CHANGES.html)
* [Features by kernel version](https://btrfs.readthedocs.io/en/latest/Feature-by-version.html)

# heads (aka `branches'):
$ git for-each-ref --sort=-creatordate refs/heads \
	--format='%(HEAD) %(refname:short) %(subject) (%(creatordate:short))'
* master       Btrfs progs v6.8.1 (2024-05-02)

# tags:
$ git for-each-ref --sort=-creatordate refs/tags \
	--format='%(refname:short) %(subject) (%(creatordate:short))'
v6.8.1       v6.8.1 (2024-05-02) tar.gz
v6.8         v6.8 (2024-03-26) tar.gz
v6.7.1       v6.7.1 (2024-02-14) tar.gz
v6.7         v6.7 (2024-01-22) tar.gz
v6.6.3       v6.6.3 (2023-12-14) tar.gz
v6.6.2       v6.6.2 (2023-11-15) tar.gz
v6.6.1       v6.6.1 (2023-11-05) tar.gz
v6.6         v6.6 (2023-11-03) tar.gz
v6.5.3       v6.5.3 (2023-10-21) tar.gz
v6.5.2       v6.5.2 (2023-10-03) tar.gz
...

# associated public inboxes:
# (number on the left is used for dev purposes)
       3823 linux-btrfs
        160 lkml
         51 qemu-devel
         50 xen-devel
         45 u-boot
         42 netdev
         35 stable
         25 linux-fsdevel
         25 linux-arm-kernel
         22 git
         20 linux-devicetree
         20 dpdk-dev
         19 intel-gfx
         15 linux-mm
         14 linux-wireless
         14 buildroot
         13 kvm
         13 dri-devel
         12 openembedded-core
         11 linux-xfs
         11 linux-omap
         11 openembedded-devel
         10 linuxppc-dev
          9 linux-scsi
          9 amd-gfx
          8 linux-block
          8 linux-ext4
          7 bpf
          7 linux-acpi
          7 linux-bluetooth
          6 linux-samsung-soc
          6 linux-media
          6 linux-pm
          6 linux-kselftest
          6 linux-iio
          6 linux-rdma
          6 linux-pci
          6 linux-serial
          6 linux-api
          6 linux-perf-users
          6 nouveau
          6 linux-staging
          6 ltp
          6 yocto
          6 linux-patches
          5 linux-mediatek
          5 netfilter-devel
          5 alsa-devel
          5 linux-gpio
          5 linux-security-module
          5 linux-trace-devel
          5 linux-doc
          5 dm-devel
          5 qemu-riscv
          5 kvm-ppc
          4 linux-mtd
          4 linux-nvme
          4 linux-nfs
          4 linux-mips
          4 fstests
          4 selinux
          4 linux-clk
          4 linux-rt-users
          4 linux-ide
          4 virtualization
          4 linux-kbuild
          4 linux-arch
          4 linux-can
          4 containers
          4 linux-fbdev
          4 linux-sh
          4 linux-s390
          4 cluster-devel
          3 linux-fscrypt
          3 linux-riscv
          3 linux-crypto
          3 linux-integrity
          3 linux-arm-msm
          3 linux-erofs
          3 linux-iommu
          3 linux-input
          3 kvmarm
          3 driverdev-devel
          3 linux-usb
          3 linux-renesas-soc
          3 dmaengine
          3 linux-watchdog
          3 util-linux
          3 backports
          3 linux-man
          3 linux-mmc
          3 linux-i2c
          3 linux-sparse
          3 linux-tegra
          3 linux-raid
          3 ocfs2-devel
          3 sparclinux
          3 mptcp
          3 linux-coco
          3 iwd
          3 bitbake-devel
          3 yocto-meta-virtualization
          3 outreachy
          3 asahi
          3 openrisc
          3 intel-wired-lan
          3 kexec
          3 batman
          3 intel-xe
          3 linux-um
          3 poky
          3 grub-devel
          3 linux-alpha
          3 reiserfs-devel
          3 lm-sensors
          3 lvm-devel
          3 ../../../../../../../fuego
          3 ../../../../../../../igt-dev
          2 linux-cifs
          2 linux-amlogic
          2 linux-nvdimm
          2 linux-rtc
          2 kernel-hardening
          2 linux-f2fs-devel
          2 linux-modules
          2 linux-hyperv
          2 selinux-refpolicy
          2 cip-dev
          2 linux-spi
          2 linux-pwm
          2 lttng-dev
          2 linux-rockchip
          2 platform-driver-x86
          2 openbmc
          2 keyrings
          2 linux-cxl
          2 target-devel
          2 ath10k
          2 ath11k
          2 nvdimm
          2 llvm
          2 ofono
          2 yocto-meta-freescale
          2 yocto-toaster
          2 yocto-meta-arm
          2 yocto-meta-ti
          2 yocto-meta-arago
          2 oe-kbuild-all
          2 virtio-comment
          2 cpufreq
          2 linux-hams
          2 linux-hexagon
          2 lvs-devel
          2 netfilter
          2 bridge
          2 virtio-fs
          1 cocci
          1 live-patching
          1 linux-efi
          1 linux-edac
          1 linux-snps-arc
          1 linux-hwmon
          1 linux-next
          1 linux-parisc
          1 linux-leds
          1 kernelnewbies
          1 linux-sgx
          1 workflows
          1 rcu
          1 linux-m68k
          1 linux-i3c
          1 linux-spdx
          1 linux-wpan
          1 ksummit-discuss
          1 wireguard
          1 io-uring
          1 linux-kernel-mentees
          1 linux-csky
          1 tpmdd-devel
          1 linux-unionfs
          1 linux-firmware
          1 linux-audit
          1 linux-remoteproc
          1 linux-dash
          1 linux-bcache
          1 mm-commits
          1 linux-fpga
          1 ceph-devel
          1 xdp-newbies
          1 phone-devel
          1 linux-hardening
          1 dash
          1 linux-sctp
          1 lustre-devel
          1 soc
          1 rust-for-linux
          1 linux-phy
          1 kernel-janitors
          1 linux-sunxi
          1 regressions
          1 ksummit
          1 b43-dev
          1 linux-nfc
          1 linux-bcachefs
          1 ath9k-devel
          1 ntfs3
          1 fio
          1 ell
          1 yocto-docs
          1 chrome-platform
          1 ntb
          1 xenomai
          1 damon
          1 loongarch
          1 imx
          1 ath12k
          1 b4-sent
          1 linux-trace-kernel
          1 oe-linux-nfc
          1 oe-chipsec
          1 virtio-dev
          1 v9fs
          1 ecryptfs
          1 linux-ia64
          1 gfs2
          1 kbd
          1 autofs
          1 dccp
          1 cgroups
          1 devicetree-spec
          1 devicetree-compiler
          1 initramfs
          1 hail-devel
          1 kvm-ia64
          1 linux-8086
          1 kernel-testers
          1 linux-btrace
          1 linux-embedded
          1 linux-hotplug
          1 linux-laptop
          1 linux-sound
          1 trinity
          1 linux-metag
          1 linux-x25
          1 linux-nilfs
          1 linux-oxnas
          1 u-boot-amlogic
          1 acpica-devel
          1 perfbook
          1 smatch
          1 ../../../../../../../wireless-regdb
          1 ../../../../../../../powertop

git clone https://yhbt.net/lore/pub/scm/linux/kernel/git/kdave/btrfs-progs.git