Btrfs progs v4.17.1
[btrfs-progs-unstable/devel.git] / README.md
blob7534ccb5d659dbed803d16a50e3e4e522f0d4380
1 Btrfs-progs [![build status](https://travis-ci.org/kdave/btrfs-progs.svg?branch=devel)](https://travis-ci.org/kdave/btrfs-progs) [![coverity status](https://scan.coverity.com/projects/617/badge.svg)](https://scan.coverity.com/projects/btrfs-progs)
2 ===========
4 Userspace utilities to manage btrfs filesystems.
5 License: GPLv2.
7 Btrfs is a copy on write (COW) filesystem for Linux aimed at implementing
8 advanced features while focusing on fault tolerance, repair and easy
9 administration.
12 This repository hosts following utilities:
14 * **btrfs** — the main administration tool ([manual page](https://btrfs.wiki.kernel.org/index.php/Manpage/btrfs))
15 * **mkfs.btrfs** — utility to create the filesystem ([manual page](https://btrfs.wiki.kernel.org/index.php/Manpage/mkfs.btrfs))
17 See INSTALL for build instructions and [tests/README.md](tests/README.md) for
18 testing information.
20 Release cycle
21 -------------
23 The major version releases are time-based and follow the cycle of the linux
24 kernel releases. The cycle usually takes 2 months. A minor version releases may
25 happen in the meantime if there are bug fixes or minor useful improvements
26 queued.
28 The release tags are signed with a GPG key ID `F2B4 1200 C54E FB30 380C  1756 C565 D5F9 D76D 583B`,
29 release tarballs are hosted at [kernel.org](https://www.kernel.org/pub/linux/kernel/people/kdave/btrfs-progs/).
30 See file [CHANGES](CHANGES) or [changelogs on wiki](https://btrfs.wiki.kernel.org/index.php/Changelog#By_version_.28btrfs-progs.29).
32 Reporting bugs
33 --------------
35 There are several ways, each has its own specifics and audience that can give
36 feedback or work on a fix. The following list is sorted in the order of
37 preference:
39 * [github issue tracker](https://github.com/kdave/btrfs-progs/issues)
40 * to the mailing list *linux-btrfs@vger.kernel.org* -- (not required to
41   subscribe), beware that the mail might get overlooked in other traffic
42 * IRC (irc.freenode.net #btrfs) -- good for discussions eg. if a bug is already
43   known, but reports could miss developers' attention
44 * [bugzilla.kernel.org](https://bugzilla.kernel.org) -- (requires
45   registration), set the product to Filesystems and component Btrfs, please put
46   'btrfs-progs' into the subject so it's clear that it's not a kernel bug
47   report
50 Development
51 -----------
53 The patch submissions, development or general discussions take place at
54 *linux-btrfs@vger.kernel.org* mailinglist, subsciption is not required to post.
56 The GitHub pull requests will not be accepted directly, the preferred way is to
57 send patches to the mailinglist instead. You can link to a branch in any git
58 repository if the mails do not make it to the mailinglist or just for
59 convenience (makes it easier to test).
61 The development model of btrfs-progs shares a lot with the kernel model. The
62 github way is different in some ways. We, the upstream community, expect that
63 the patches meet some criteria (often lacking in github contributions):
65 * **one logical change per patch**: eg. not mixing bugfixes, cleanups, features
66   etc., sometimes it's not clear and will be usually pointed out during reviews
67 * proper **subject line**: eg. prefix with _btrfs-progs: subpart, ..._ ,
68   descriptive yet not too long, see `git log --oneline` for some inspiration
69 * proper **changelog**: the changelogs are often missing or lacking explanation _why_
70   the change was made, or _how_ is something broken, _what_ are user-visible
71   effects of the bug or the fix, _how_ does an improvement help or the intended
72   _usecase_
73 * the **Signed-off-by** line: this documents who authored the change, you can read
74   more about the
75   [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)
76   * if you are not used to the signed-off style, your contributions won't be
77     rejected just because of it's missing, the _Author:_ tag will be added as a
78     substitute in order to allow contributions without much bothering with
79     formalities
81 Documentation updates
82 ---------------------
84 Documentation fixes or updates do not need much explanation so sticking to the
85 code rules in the previous section is not necessary. Github pull requests are
86 OK, patches could be sent to me directly and not required to be also in the
87 mailinglist. Pointing out typos via IRC also works, although might get
88 accidentally lost in the noise.
90 References
91 ----------
93 * [wiki/Developer's FAQ](https://btrfs.wiki.kernel.org/index.php/Developer's_FAQ)
94 * [wiki/Getting started](https://btrfs.wiki.kernel.org/index.php/Getting_started)
95 * [wiki/TODO](https://btrfs.wiki.kernel.org/index.php/Project_ideas#Userspace_tools_projects)
96 * [Btrfs-progs changelogs](https://btrfs.wiki.kernel.org/index.php/Changelog#By_version_.28btrfs-progs.29)
97 * [wiki/FAQ](https://btrfs.wiki.kernel.org/index.php/FAQ)
98 * [Wiki with more information](https://btrfs.wiki.kernel.org)