RepoMirrors
/
btrfs-progs
mirror of https://github.com/kdave/btrfs-progs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

btrfs-progs: update README 

- link to readthedocs
- update IRC channel
- other minor updates

Signed-off-by: David Sterba <dsterba@suse.com>
This commit is contained in:
David Sterba 2022-01-11 23:40:48 +01:00
parent f59a229d2c
commit 6e78548b35
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -9,12 +9,13 @@ advanced features while focusing on fault tolerance, repair and easy
administration. administration.
This repository hosts following utilities: This repository hosts following utilities and also documentation:
* **btrfs** &mdash; the main administration tool ([manual page](https://btrfs.wiki.kernel.org/index.php/Manpage/btrfs)) * **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)) * **mkfs.btrfs** &mdash; utility to create the filesystem ([manual page](https://btrfs.wiki.kernel.org/index.php/Manpage/mkfs.btrfs))
* all-in-one binary in the busybox style with mkfs.btrfs, btrfs-image and other tools built-in ([standalone tools](https://github.com/kdave/btrfs-progs/blob/master/Documentation/btrfs.asciidoc#standalone-tools)) * all-in-one binary in the busybox style with mkfs.btrfs, btrfs-image and other tools built-in ([standalone tools](https://github.com/kdave/btrfs-progs/blob/master/Documentation/btrfs.asciidoc#standalone-tools))
* **libbtrfsutil** (LGPL v2.1) &mdash; C and python 3 bindings, see [libbtrfsutil/README.md](libbtrfsutil/README.md) for more * **libbtrfsutil** (LGPL v2.1) &mdash; 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.rtfd.io)
See [INSTALL](INSTALL) for build instructions and [tests/README.md](tests/README.md) for See [INSTALL](INSTALL) for build instructions and [tests/README.md](tests/README.md) for
testing information. testing information.
@ -41,7 +42,7 @@ preference:
* [github issue tracker](https://github.com/kdave/btrfs-progs/issues) * [github issue tracker](https://github.com/kdave/btrfs-progs/issues)
* to the mailing list *linux-btrfs@vger.kernel.org* -- (not required to * to the mailing list *linux-btrfs@vger.kernel.org* -- (not required to
subscribe), beware that the mail might get overlooked in other traffic subscribe), beware that the mail might get overlooked in other traffic
* IRC (irc.freenode.net #btrfs) -- good for discussions eg. if a bug is already * IRC (irc.libera.chat #btrfs) -- good for discussions eg. if a bug is already
known, but reports could miss developers' attention known, but reports could miss developers' attention
* [bugzilla.kernel.org](https://bugzilla.kernel.org) -- (requires * [bugzilla.kernel.org](https://bugzilla.kernel.org) -- (requires
registration), set the product to Filesystems and component Btrfs, please put registration), set the product to Filesystems and component Btrfs, please put
@ -101,6 +102,9 @@ OK, patches could be sent to me directly and not required to be also in the
mailinglist. Pointing out typos via IRC also works, although might get mailinglist. Pointing out typos via IRC also works, although might get
accidentally lost in the noise. accidentally lost in the noise.
Documents are written in [RST](https://en.wikipedia.org/wiki/ReStructuredText)
and built by sphinx.
Third-party sources Third-party sources
------------------- -------------------
@ -116,6 +120,9 @@ implementations.
* SHA256: https://tools.ietf.org/html/rfc4634 * SHA256: https://tools.ietf.org/html/rfc4634
* BLAKE2: https://github.com/BLAKE2/BLAKE2 * BLAKE2: https://github.com/BLAKE2/BLAKE2
Some other code is borrowed from kernel, eg. the raid5 tables or data structure
implementation.
References References
---------- ----------