From 6e78548b355f19f4f17603c83824473929799c59 Mon Sep 17 00:00:00 2001 From: David Sterba Date: Tue, 11 Jan 2022 23:40:48 +0100 Subject: [PATCH] btrfs-progs: update README - link to readthedocs - update IRC channel - other minor updates Signed-off-by: David Sterba --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f516ec29..d3bae184 100644 --- a/README.md +++ b/README.md @@ -9,12 +9,13 @@ advanced features while focusing on fault tolerance, repair and easy administration. -This repository hosts following utilities: +This repository hosts following utilities and also documentation: * **btrfs** — the main administration tool ([manual page](https://btrfs.wiki.kernel.org/index.php/Manpage/btrfs)) * **mkfs.btrfs** — 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)) * **libbtrfsutil** (LGPL v2.1) — 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 testing information. @@ -41,7 +42,7 @@ preference: * [github issue tracker](https://github.com/kdave/btrfs-progs/issues) * to the mailing list *linux-btrfs@vger.kernel.org* -- (not required to 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 * [bugzilla.kernel.org](https://bugzilla.kernel.org) -- (requires 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 accidentally lost in the noise. +Documents are written in [RST](https://en.wikipedia.org/wiki/ReStructuredText) +and built by sphinx. + Third-party sources ------------------- @@ -116,6 +120,9 @@ implementations. * SHA256: https://tools.ietf.org/html/rfc4634 * BLAKE2: https://github.com/BLAKE2/BLAKE2 +Some other code is borrowed from kernel, eg. the raid5 tables or data structure +implementation. + References ----------