Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Markus Pargmann and committed by
Jens Axboe
ef8d9e7d d31af0a3

+19 -15
+19 -15
Documentation/blockdev/nbd.txt
··· 1 - Network Block Device (TCP version) 2 - 3 - What is it: With this compiled in the kernel (or as a module), Linux 4 - can use a remote server as one of its block devices. So every time 5 - the client computer wants to read, e.g., /dev/nb0, it sends a 6 - request over TCP to the server, which will reply with the data read. 7 - This can be used for stations with low disk space (or even diskless) 8 - to borrow disk space from another computer. 9 - Unlike NFS, it is possible to put any filesystem on it, etc. 1 + Network Block Device (TCP version) 2 + ================================== 10 3 11 - For more information, or to download the nbd-client and nbd-server 12 - tools, go to http://nbd.sf.net/. 4 + 1) Overview 5 + ----------- 13 6 14 - The nbd kernel module need only be installed on the client 15 - system, as the nbd-server is completely in userspace. In fact, 16 - the nbd-server has been successfully ported to other operating 17 - systems, including Windows. 7 + What is it: With this compiled in the kernel (or as a module), Linux 8 + can use a remote server as one of its block devices. So every time 9 + the client computer wants to read, e.g., /dev/nb0, it sends a 10 + request over TCP to the server, which will reply with the data read. 11 + This can be used for stations with low disk space (or even diskless) 12 + to borrow disk space from another computer. 13 + Unlike NFS, it is possible to put any filesystem on it, etc. 14 + 15 + For more information, or to download the nbd-client and nbd-server 16 + tools, go to http://nbd.sf.net/. 17 + 18 + The nbd kernel module need only be installed on the client 19 + system, as the nbd-server is completely in userspace. In fact, 20 + the nbd-server has been successfully ported to other operating 21 + systems, including Windows.