From b2c2b662385a10eae02022254719adc5b8e5bba6 Mon Sep 17 00:00:00 2001 From: David Disseldorp Date: Mon, 23 Jun 2025 12:23:08 +1000 Subject: [PATCH 1/2] docs: lkl: move lkl documentation into subdirectory In preparation for adding more arch specific documentation. Add an additional F: Documentation/lkl entry to MAINTAINERS. Signed-off-by: David Disseldorp --- Documentation/{ => lkl}/lkl.txt | 0 MAINTAINERS | 1 + README.md | 2 +- 3 files changed, 2 insertions(+), 1 deletion(-) rename Documentation/{ => lkl}/lkl.txt (100%) diff --git a/Documentation/lkl.txt b/Documentation/lkl/lkl.txt similarity index 100% rename from Documentation/lkl.txt rename to Documentation/lkl/lkl.txt diff --git a/MAINTAINERS b/MAINTAINERS index c3d1e044d481..2f0623f0675e 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -12158,6 +12158,7 @@ M: Octavian Purdila M: Hajime Tazaki L: linux-kernel-library@freelists.org S: Maintained +F: Documentation/lkl/ F: arch/lkl/ F: tools/lkl/ diff --git a/README.md b/README.md index 35c47a921f67..e4af93db81e9 120000 --- a/README.md +++ b/README.md @@ -1 +1 @@ -Documentation/lkl.txt \ No newline at end of file +Documentation/lkl/lkl.txt \ No newline at end of file From af206917444e44a7e0f12c05c2810978f4153bc4 Mon Sep 17 00:00:00 2001 From: David Disseldorp Date: Mon, 23 Jun 2025 22:40:30 +1000 Subject: [PATCH 2/2] docs: lkl: add basic lklfuse documentation Can be converted to a man page via rst2man. The empty lines in the OPTIONS section aren't ideal, but it's the simplest way to get the rst2man output on separate lines. Signed-off-by: David Disseldorp --- Documentation/lkl/lklfuse.rst | 46 +++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 Documentation/lkl/lklfuse.rst diff --git a/Documentation/lkl/lklfuse.rst b/Documentation/lkl/lklfuse.rst new file mode 100644 index 000000000000..f3ac736473de --- /dev/null +++ b/Documentation/lkl/lklfuse.rst @@ -0,0 +1,46 @@ +.. SPDX-License-Identifier: GPL-2.0 + +========= + lklfuse +========= + +----------------------------------------- +access LKL mounted block devices via FUSE +----------------------------------------- + +:Date: 2025-06-23 +:Manual section: 8 + +SYNOPSIS +======== + +lklfuse block-device mountpoint [options] + +DESCRIPTION +=========== + +lklfuse uses the Linux Kernel Library (LKL) to mount a block-device or +filesystem image, and provides access to the host system via FUSE. +lklfuse can run as an unprivileged user-space process, while reusing entire +Linux kernel filesystem driver implementations. + +Udev rules and systemd service files are available for automatically mounting +USB storage devices via an unprivileged lklfuse sandbox; see 61-lklfuse.rules +and lklfuse-mount@.service. + +OPTIONS +======= + +-o log= log to . + +-o type=fstype mount with filesystem type . + +-o mb=memory allocate in MB for LKL (default: 64). + +-o part=parition mount . + +-o ro open file read-only. + +-o opts=options Linux kernel mount (use \\ to escape , and =). + +See `lklfuse --help` for additional FUSE specific options.