summaryrefslogtreecommitdiff
path: root/Documentation/blockdev/nbd.txt
diff options
context:
space:
mode:
authorMarkus Pargmann <mpa@pengutronix.de>2015-04-02 10:11:33 +0200
committerJens Axboe <axboe@fb.com>2015-04-02 12:39:13 -0600
commitef8d9e7db285ea3d26b13dfeb6762346c95dc0d1 (patch)
treee949a0b7f978c0add84ea7c4d84da9efa7354664 /Documentation/blockdev/nbd.txt
parentd31af0a325ca4ff8e57b8616ab2228913df369ad (diff)
downloadlwn-ef8d9e7db285ea3d26b13dfeb6762346c95dc0d1.tar.gz
lwn-ef8d9e7db285ea3d26b13dfeb6762346c95dc0d1.zip
Documentation: nbd: Reformat to allow more documentation
Reformat the existing documentation to have more structure. This allows for more documentation seperated from the existing paragraphs. Signed-off-by: Markus Pargmann <mpa@pengutronix.de> Signed-off-by: Jens Axboe <axboe@fb.com>
Diffstat (limited to 'Documentation/blockdev/nbd.txt')
-rw-r--r--Documentation/blockdev/nbd.txt34
1 files changed, 19 insertions, 15 deletions
diff --git a/Documentation/blockdev/nbd.txt b/Documentation/blockdev/nbd.txt
index 271e607304da..337946bd460e 100644
--- a/Documentation/blockdev/nbd.txt
+++ b/Documentation/blockdev/nbd.txt
@@ -1,17 +1,21 @@
- Network Block Device (TCP version)
-
- What is it: With this compiled in the kernel (or as a module), Linux
- can use a remote server as one of its block devices. So every time
- the client computer wants to read, e.g., /dev/nb0, it sends a
- request over TCP to the server, which will reply with the data read.
- This can be used for stations with low disk space (or even diskless)
- to borrow disk space from another computer.
- Unlike NFS, it is possible to put any filesystem on it, etc.
+Network Block Device (TCP version)
+==================================
- For more information, or to download the nbd-client and nbd-server
- tools, go to http://nbd.sf.net/.
+1) Overview
+-----------
- The nbd kernel module need only be installed on the client
- system, as the nbd-server is completely in userspace. In fact,
- the nbd-server has been successfully ported to other operating
- systems, including Windows.
+What is it: With this compiled in the kernel (or as a module), Linux
+can use a remote server as one of its block devices. So every time
+the client computer wants to read, e.g., /dev/nb0, it sends a
+request over TCP to the server, which will reply with the data read.
+This can be used for stations with low disk space (or even diskless)
+to borrow disk space from another computer.
+Unlike NFS, it is possible to put any filesystem on it, etc.
+
+For more information, or to download the nbd-client and nbd-server
+tools, go to http://nbd.sf.net/.
+
+The nbd kernel module need only be installed on the client
+system, as the nbd-server is completely in userspace. In fact,
+the nbd-server has been successfully ported to other operating
+systems, including Windows.