RepoMirrors/btrfs-progs
1
0
Fork 0
mirror of https://github.com/kdave/btrfs-progs synced 2025-01-24 06:22:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

btrfs-progs: document the new all-in-one binary

Browse Source 
Signed-off-by: David Sterba <dsterba@suse.com>
This commit is contained in:
David Sterba 2019-07-02 18:33:24 +02:00
parent bd4a386ec5
commit 4c70b84aba
3 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Documentation/btrfs.asciidoc
View File

@ -126,6 +126,11 @@ source distribution.
removed. removed.
*btrfs-zero-log*:: moved to *btrfs rescue zero-log*, standalone removed. *btrfs-zero-log*:: moved to *btrfs rescue zero-log*, standalone removed.
For space-constrained environments, it's possible to build a single binary with
functionality of several standalone tools. This is following the concept of
busybox where the file name selects the functionality. This works for symlinks
or hardlinks. The full list can be obtained by *btrfs help --box*.
EXIT STATUS EXIT STATUS
----------- -----------
*btrfs* returns a zero exit status if it succeeds. Non zero is returned in *btrfs* returns a zero exit status if it succeeds. Non zero is returned in

17
INSTALL
View File

@ -82,5 +82,22 @@ The resulting binaries have the '.static' suffix, the intermediate object
files do not conflict with the normal (dynamic) build. files do not conflict with the normal (dynamic) build.
All-in-one binary (busybox style)
---------------------------------
Since version 5.2 it's possible to build a single binary that can act as other
standalone tools, based on the file name:
$ make btrfs.box
$ mv btrfs.box btrfs
$ ln -s btrfs mkfs.btrfs
The list of built-ins can be obtained by
$ btrfs help --box
The basic set will always contain: mkfs.btrfs, btrfs-image, btrfs-convert.
References: References:
* https://btrfs.wiki.kernel.org * https://btrfs.wiki.kernel.org

1
README.md
View File

@ -13,6 +13,7 @@ This repository hosts following utilities:
* **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))
The C and python 3 bindings are provided by a LGPL library **libbtrfsutil** see The C and python 3 bindings are provided by a LGPL library **libbtrfsutil** see
[libbtrfsutil/README.md](libbtrfsutil/README.md) for more. [libbtrfsutil/README.md](libbtrfsutil/README.md) for more.