btrfs-progs: send-stream: use proper type for read return value
[platform/upstream/btrfs-progs.git] / README.md
1 Btrfs-progs [![build status](https://travis-ci.org/kdave/btrfs-progs.svg?branch=devel)](https://travis-ci.org/kdave/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** — 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))
16
17 See INSTALL for build instructions.
18
19 Release cycle
20 -------------
21
22 The major version releases are time-based and follow the cycle of the linux
23 kernel releases. The cycle usually takes 2 months. A minor version releases may
24 happen in the meantime if there are queued bug fixes or minor useful
25 improvements.
26
27 Development
28 -----------
29
30 The patch submissions, development or general discussions take place at
31 *linux-btrfs@vger.kernel.org* mailinglist, subsciption not required.
32
33 References
34 ----------
35
36 * [Wiki with more information](https://btrfs.wiki.kernel.org)
37 * [Btrfs-progs changelogs](https://btrfs.wiki.kernel.org/index.php/Changelog#By_version_.28btrfs-progs.29)
38 * [wiki/FAQ](https://btrfs.wiki.kernel.org/index.php/FAQ)
39 * [wiki/Getting started](https://btrfs.wiki.kernel.org/index.php/Getting_started)
40 * [wiki/TODO](https://btrfs.wiki.kernel.org/index.php/Project_ideas#Userspace_tools_projects)
41 * [wiki/Developer's FAQ](https://btrfs.wiki.kernel.org/index.php/Developer's_FAQ)