summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDavid Sterba <dsterba@suse.com>2016-11-10 18:31:53 +0100
committerDavid Sterba <dsterba@suse.com>2016-11-23 11:07:05 +0100
commitd8f93ce802c31dde2b936d0626b636dc070e118b (patch)
treeea9b151c434a5646c5487fbb4ad7e55e312acf09 /README.md
parent776cd164b73092ec559a47080ff44aa22bad97a1 (diff)
btrfs-progs: Update README and other docs
Signed-off-by: David Sterba <dsterba@suse.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md63
1 files changed, 54 insertions, 9 deletions
diff --git a/README.md b/README.md
index 13a2c83..e5e3f29 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-Btrfs-progs [![build status](https://travis-ci.org/kdave/btrfs-progs.svg?branch=devel)](https://travis-ci.org/kdave/btrfs-progs)
+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)
===========
Userspace utilities to manage btrfs filesystems.
@@ -14,28 +14,73 @@ This repository hosts following utilities:
* **btrfs** &mdash; the main administration tool ([manual page](https://btrfs.wiki.kernel.org/index.php/Manpage/btrfs))
* **mkfs.btrfs** &mdash; utility to create the filesystem ([manual page](https://btrfs.wiki.kernel.org/index.php/Manpage/mkfs.btrfs))
-See INSTALL for build instructions.
+See INSTALL for build instructions and [tests/README.md](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 queued bug fixes or minor useful
-improvements.
+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 wiki](https://btrfs.wiki.kernel.org/index.php/Changelog#By_version_.28btrfs-progs.29).
+
+Reporting bugs
+--------------
+
+There are several ways, each has its own specifics and audience that can give
+feedback or work on a fix.
+
+* [bugzilla.kernel.org](https://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
+* to the mailing list *linux-btrfs@vger.kernel.org* -- (not required to
+ subscribe), beware that the mail might get overlooked in other traffic
+* [github issue tracker](https://github.com/kdave/btrfs-sprogs/issues)
+* IRC (irc.freenode.net #btrfs) -- good for discussions eg. if a bug is already
+ known, but reports could miss developers' attention
+
Development
-----------
The patch submissions, development or general discussions take place at
-*linux-btrfs@vger.kernel.org* mailinglist, subsciption not required.
+*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_ [here (chapter 11)](https://www.kernel.org/doc/Documentation/SubmittingPatches)
+
+**Exceptions**: documentation fixes or updates do not need much explanation so
+sticking to the above rules is not necessary. Github pull requests are OK.
References
----------
-* [Wiki with more information](https://btrfs.wiki.kernel.org)
-* [Btrfs-progs changelogs](https://btrfs.wiki.kernel.org/index.php/Changelog#By_version_.28btrfs-progs.29)
-* [wiki/FAQ](https://btrfs.wiki.kernel.org/index.php/FAQ)
+* [wiki/Developer's FAQ](https://btrfs.wiki.kernel.org/index.php/Developer's_FAQ)
* [wiki/Getting started](https://btrfs.wiki.kernel.org/index.php/Getting_started)
* [wiki/TODO](https://btrfs.wiki.kernel.org/index.php/Project_ideas#Userspace_tools_projects)
-* [wiki/Developer's FAQ](https://btrfs.wiki.kernel.org/index.php/Developer's_FAQ)
+* [Btrfs-progs changelogs](https://btrfs.wiki.kernel.org/index.php/Changelog#By_version_.28btrfs-progs.29)
+* [wiki/FAQ](https://btrfs.wiki.kernel.org/index.php/FAQ)
+* [Wiki with more information](https://btrfs.wiki.kernel.org)