diff options
| author | Markus Pargmann <mpa@pengutronix.de> | 2015-04-02 04:11:33 -0400 |
|---|---|---|
| committer | Jens Axboe <axboe@fb.com> | 2015-04-02 14:39:13 -0400 |
| commit | ef8d9e7db285ea3d26b13dfeb6762346c95dc0d1 (patch) | |
| tree | e949a0b7f978c0add84ea7c4d84da9efa7354664 | |
| parent | d31af0a325ca4ff8e57b8616ab2228913df369ad (diff) | |
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>
| -rw-r--r-- | Documentation/blockdev/nbd.txt | 34 |
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 @@ | |||
| 1 | Network Block Device (TCP version) | 1 | Network Block Device (TCP version) |
| 2 | 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. | ||
| 10 | 3 | ||
| 11 | For more information, or to download the nbd-client and nbd-server | 4 | 1) Overview |
| 12 | tools, go to http://nbd.sf.net/. | 5 | ----------- |
| 13 | 6 | ||
| 14 | The nbd kernel module need only be installed on the client | 7 | What is it: With this compiled in the kernel (or as a module), Linux |
| 15 | system, as the nbd-server is completely in userspace. In fact, | 8 | can use a remote server as one of its block devices. So every time |
| 16 | the nbd-server has been successfully ported to other operating | 9 | the client computer wants to read, e.g., /dev/nb0, it sends a |
| 17 | systems, including Windows. | 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. | ||
