[Nbd] [PATCH 1/9] Documentation: nbd: Reformat to allow more documentation
- To: Jens Axboe <axboe@...161...>
- Cc: nbd-general@lists.sourceforge.net, linux-kernel@...25..., kernel@...1897...
- Subject: [Nbd] [PATCH 1/9] Documentation: nbd: Reformat to allow more documentation
- From: Markus Pargmann <mpa@...1897...>
- Date: Thu, 2 Apr 2015 10:11:33 +0200
- Message-id: <1427962301-17085-2-git-send-email-mpa@...1897...>
- In-reply-to: <1427962301-17085-1-git-send-email-mpa@...1897...>
- References: <1427962301-17085-1-git-send-email-mpa@...1897...>
Reformat the existing documentation to have more structure. This allows
for more documentation seperated from the existing paragraphs.
Signed-off-by: Markus Pargmann <mpa@...1897...>
---
Documentation/blockdev/nbd.txt | 34 +++++++++++++++++++---------------
1 file 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.
--
2.1.4
Reply to: