From: development@manuel-bentele.de
To: linux-block@vger.kernel.org
Cc: Manuel Bentele <development@manuel-bentele.de>
Subject: [PATCH 2/5] doc: admin-guide: add loop block device documentation
Date: Sat, 24 Aug 2019 00:56:16 +0200 [thread overview]
Message-ID: <20190823225619.15530-3-development@manuel-bentele.de> (raw)
In-Reply-To: <20190823225619.15530-1-development@manuel-bentele.de>
From: Manuel Bentele <development@manuel-bentele.de>
The configuration of the loop block device module with file format support
is documented in the reST kernel documentation format.
Signed-off-by: Manuel Bentele <development@manuel-bentele.de>
---
Documentation/admin-guide/blockdev/index.rst | 1 +
Documentation/admin-guide/blockdev/loop.rst | 74 ++++++++++++++++++++
2 files changed, 75 insertions(+)
create mode 100644 Documentation/admin-guide/blockdev/loop.rst
diff --git a/Documentation/admin-guide/blockdev/index.rst b/Documentation/admin-guide/blockdev/index.rst
index b903cf152091..127e921a0ccc 100644
--- a/Documentation/admin-guide/blockdev/index.rst
+++ b/Documentation/admin-guide/blockdev/index.rst
@@ -8,6 +8,7 @@ The Linux RapidIO Subsystem
:maxdepth: 1
floppy
+ loop
nbd
paride
ramdisk
diff --git a/Documentation/admin-guide/blockdev/loop.rst b/Documentation/admin-guide/blockdev/loop.rst
new file mode 100644
index 000000000000..69d8172c85db
--- /dev/null
+++ b/Documentation/admin-guide/blockdev/loop.rst
@@ -0,0 +1,74 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+Loopback Block Device
+=====================
+
+Overview
+--------
+
+The loopback device driver allows you to use a regular file as a block device.
+You can then create a file system on that block device and mount it just as you
+would mount other block devices such as hard drive partitions, CD-ROM drives or
+floppy drives. The loop devices are block special device files with major
+number 7 and typically called /dev/loop0, /dev/loop1 etc.
+
+To use the loop device, you need the losetup utility, found in the `util-linux
+package <https://www.kernel.org/pub/linux/utils/util-linux/>`_.
+
+.. note::
+ Note that this loop device has nothing to do with the loopback device \
+ used for network connections from the machine to itself.
+
+
+Parameters
+----------
+
+Kernel Command Line Parameters
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ max_loop
+ The number of loop block devices that get unconditionally
+ pre-created at init time. The default number is configured by
+ BLK_DEV_LOOP_MIN_COUNT. Instead of statically allocating a
+ predefined number, loop devices can be requested on-demand
+ with the /dev/loop-control interface.
+
+
+Module parameters
+~~~~~~~~~~~~~~~~~
+
+ max_part
+ Maximum number of partitions per loop device (default: 0).
+
+ If max_part is given, partition scanning is globally enabled
+ for all loop devices.
+
+ max_loop
+ Maximum number of loop devices that should be initialized
+ (default: 8). The default number is configured by
+ BLK_DEV_LOOP_MIN_COUNT.
+
+
+File format drivers
+-------------------
+
+The loopback device driver provides an interface for kernel modules to
+implement custom file formats. By default, an initialized loop device uses the
+**RAW** file format driver.
+
+.. note::
+ If you want to create and set up a new loop device with the losetup \
+ utility make sure that the suitable file format driver is loaded \
+ before.
+
+The following file format drivers are available.
+
+
+RAW
+~~~
+
+The RAW file format driver implements the binary reading and writing of a disk
+image file. It supports discarding, asynchrounous IO, flushing and cryptoloop
+support.
+
+The driver's kernel module is named *loop_file_fmt_raw*.
--
2.23.0
next prev parent reply other threads:[~2019-08-23 23:01 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-08-23 22:56 [PATCH 0/5] block: loop: add file format subsystem and QCOW2 file format driver development
2019-08-23 22:56 ` development [this message]
2019-08-23 22:56 ` [PATCH 3/5] doc: driver-api: add loop file format subsystem API documentation development
2019-08-23 22:56 ` [PATCH 4/5] block: loop: add QCOW2 loop file format driver (read-only) development
2019-08-23 22:56 ` [PATCH 5/5] doc: admin-guide: add QCOW2 file format to loop device documentation development
2019-08-24 3:37 ` [PATCH 0/5] block: loop: add file format subsystem and QCOW2 file format driver Bart Van Assche
2019-08-24 9:14 ` Manuel Bentele
2019-08-24 16:04 ` Bart Van Assche
2019-08-25 12:15 ` Manuel Bentele
2019-09-09 22:12 ` Manuel Bentele
2019-08-24 11:10 ` Manuel Bentele
2019-09-12 2:24 ` Ming Lei
2019-09-13 11:57 ` Manuel Bentele
2019-09-16 2:11 ` Ming Lei
2019-09-18 10:26 ` Simon Rettberg
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190823225619.15530-3-development@manuel-bentele.de \
--to=development@manuel-bentele.de \
--cc=linux-block@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).