README.md

   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 ===========
   3
   4 Userspace utilities to manage btrfs filesystems.
   5 License: GPLv2.
   6
   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.
  10
  11
  12 This repository hosts following utilities:
  13
  14 * **btrfs** &mdash; the main administration tool ([manual page](https://btrfs.wiki.kernel.org/index.php/Manpage/btrfs))
  15 * **mkfs.btrfs** &mdash; utility to create the filesystem ([manual page](https://btrfs.wiki.kernel.org/index.php/Manpage/mkfs.btrfs))
  16
  17 See INSTALL for build instructions and [tests/README.md](tests/README.md) for
  18 testing information.
  19
  20 Release cycle
  21 -------------
  22
  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.
  27
  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).
  31
  32 Reporting bugs
  33 --------------
  34
  35 There are several ways, each has its own specifics and audience that can give
  36 feedback or work on a fix.
  37
  38 * [bugzilla.kernel.org](https://bugzilla.kernel.org) -- (requires
  39   registration), set the product to Filesystems and component Btrfs, please put
  40   'btrfs-progs' into the subject so it's clear that it's not a kernel bug
  41   report
  42 * to the mailing list *linux-btrfs@vger.kernel.org* -- (not required to
  43   subscribe), beware that the mail might get overlooked in other traffic
  44 * [github issue tracker](https://github.com/kdave/btrfs-sprogs/issues)
  45 * IRC (irc.freenode.net #btrfs) -- good for discussions eg. if a bug is already
  46   known, but reports could miss developers' attention
  47
  48
  49 Development
  50 -----------
  51
  52 The patch submissions, development or general discussions take place at
  53 *linux-btrfs@vger.kernel.org* mailinglist, subsciption is not required to post.
  54
  55 The GitHub pull requests will not be accepted directly, the preferred way is to
  56 send patches to the mailinglist instead. You can link to a branch in any git
  57 repository if the mails do not make it to the mailinglist or just for
  58 convenience (makes it easier to test).
  59
  60 The development model of btrfs-progs shares a lot with the kernel model. The
  61 github way is different in some ways. We, the upstream community, expect that
  62 the patches meet some criteria (often lacking in github contributions):
  63
  64 * **one logical change per patch**: eg. not mixing bugfixes, cleanups, features
  65   etc., sometimes it's not clear and will be usually pointed out during reviews
  66 * proper **subject line**: eg. prefix with _btrfs-progs: subpart, ..._ ,
  67   descriptive yet not too long, see `git log --oneline` for some inspiration
  68 * proper **changelog**: the changelogs are often missing or lacking explanation _why_
  69   the change was made, or _how_ is something broken, _what_ are user-visible
  70   effects of the bug or the fix, _how_ does an improvement help or the intended
  71   _usecase_
  72 * the **Signed-off-by** line: this documents who authored the change, you can read
  73   more about the _The Developer's Certificate of Origin_ [here (chapter 11)](https://www.kernel.org/doc/Documentation/SubmittingPatches)
  74
  75 Documentation updates
  76 ---------------------
  77
  78 Documentation fixes or updates do not need much explanation so sticking to the
  79 code rules in the previous section is not necessary. Github pull requests are
  80 OK, patches could be sent to me directly and not required to be also in the
  81 mailinglist. Pointing out typos via IRC also works, although might get
  82 accidentally lost in the noise.
  83
  84 References
  85 ----------
  86
  87 * [wiki/Developer's FAQ](https://btrfs.wiki.kernel.org/index.php/Developer's_FAQ)
  88 * [wiki/Getting started](https://btrfs.wiki.kernel.org/index.php/Getting_started)
  89 * [wiki/TODO](https://btrfs.wiki.kernel.org/index.php/Project_ideas#Userspace_tools_projects)
  90 * [Btrfs-progs changelogs](https://btrfs.wiki.kernel.org/index.php/Changelog#By_version_.28btrfs-progs.29)
  91 * [wiki/FAQ](https://btrfs.wiki.kernel.org/index.php/FAQ)
  92 * [Wiki with more information](https://btrfs.wiki.kernel.org)