LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Markus Pargmann <mpa@pengutronix.de>
To: Jens Axboe <axboe@kernel.dk>
Cc: linux-kernel@vger.kernel.org, nbd-general@lists.sourceforge.net,
	kernel@pengutronix.de, Markus Pargmann <mpa@pengutronix.de>
Subject: [PATCH 1/9] Documentation: nbd: Reformat to allow more documentation
Date: Thu,  2 Apr 2015 10:11:33 +0200	[thread overview]
Message-ID: <1427962301-17085-2-git-send-email-mpa@pengutronix.de> (raw)
In-Reply-To: <1427962301-17085-1-git-send-email-mpa@pengutronix.de>

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>
---
 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	other threads:[~2015-04-02  8:12 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-04-02  8:11 [PULL] NBD patches for 4.1 Markus Pargmann
2015-04-02  8:11 ` Markus Pargmann [this message]
2015-04-02  8:11 ` [PATCH 2/9] Documentation: nbd: Add list of module parameters Markus Pargmann
2015-04-02  8:11 ` [PATCH 3/9] nbd: Remove kernel internal header Markus Pargmann
2015-04-02  8:11 ` [PATCH 4/9] nbd: Replace kthread_create with kthread_run Markus Pargmann
2015-04-02  8:11 ` [PATCH 5/9] nbd: Fix device bytesize type Markus Pargmann
2015-04-02  8:11 ` [PATCH 6/9] nbd: Restructure debugging prints Markus Pargmann
2015-04-02  8:11 ` [PATCH 7/9] nbd: Remove fixme that was already fixed Markus Pargmann
2015-04-02  9:05   ` Christoph Hellwig
2015-04-02  9:36     ` Markus Pargmann
2015-04-02  8:11 ` [PATCH 8/9] nbd: Return error code directly Markus Pargmann
2015-04-02  8:11 ` [PATCH 9/9] nbd: Return error pointer directly Markus Pargmann
2015-04-02 18:40 ` [PULL] NBD patches for 4.1 Jens Axboe
  -- strict thread matches above, loose matches on Subject: below --
2015-02-12 20:57 [PATCH 0/9] nbd: cleanups Markus Pargmann
2015-02-12 20:57 ` [PATCH 1/9] Documentation: nbd: Reformat to allow more documentation Markus Pargmann

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=1427962301-17085-2-git-send-email-mpa@pengutronix.de \
    --to=mpa@pengutronix.de \
    --cc=axboe@kernel.dk \
    --cc=kernel@pengutronix.de \
    --cc=linux-kernel@vger.kernel.org \
    --cc=nbd-general@lists.sourceforge.net \
    --subject='Re: [PATCH 1/9] Documentation: nbd: Reformat to allow more documentation' \
    /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

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).