Add section about partition handling on ublk devices. Document UBLK_F_PARTITIONS and UBLK_F_AUTO_PART_SCAN. Add section for kublk to be used as reference. Update extenal github links - repos have moved to ublk-org and README is renamed to README.rst Signed-off-by: Alexander Atanasov --- Documentation/block/ublk.rst | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/Documentation/block/ublk.rst b/Documentation/block/ublk.rst index 6ad28039663d..168b61098d4a 100644 --- a/Documentation/block/ublk.rst +++ b/Documentation/block/ublk.rst @@ -88,6 +88,14 @@ Below is example of using ``ublksrv`` to provide ublk-based loop device. See usage details in README of ``ublksrv`` [#userspace_readme]_. +Using kublk from ublk test suite +================================ + +ublk selftests contain utility(``kublk``) which can be used for reference +and as a simple server. It is a stripped down version of ublk. + +See ``tools/testing/selftests/ublk/kublk.c`` + Design ====== @@ -238,6 +246,14 @@ be provided in these commands' payload from ublk server. With this way, ublk device becomes container-ware, and device created in one container can be controlled/accessed just inside this container. +Partitions +---------- + +By default partitions are disabled on ublk devices. + +They can be enabled *only on trusted* devices with ``UBLK_F_PARTITIONS`` flag. +Automatic partition scan can be requested with ``UBLK_F_AUTO_PART_SCAN`` flag. + Data plane ---------- @@ -488,10 +504,10 @@ Limitations References ========== -.. [#userspace] https://github.com/ming1/ubdsrv +.. [#userspace] https://github.com/ublk-org/ublksrv -.. [#userspace_lib] https://github.com/ming1/ubdsrv/tree/master/lib +.. [#userspace_lib] https://github.com/ublk-org/ublksrv/tree/master/lib .. [#userspace_nbdublk] https://gitlab.com/rwmjones/libnbd/-/tree/nbdublk -.. [#userspace_readme] https://github.com/ming1/ubdsrv/blob/master/README +.. [#userspace_readme] https://github.com/ublk-org/ublksrv/blob/master/README.rst -- 2.43.0