[Libguestfs] [PATCH nbdkit 1/9] nbd: Rework the documentation.

[Richard W.M. Jones]

On Mon, Jul 06, 2020 at 02:27:58PM -0500, Eric Blake wrote:
> On 7/1/20 2:17 AM, Richard W.M. Jones wrote:
> >* Change the title so it's informative and searchable.
> >
> >* Remove references to the non-libnbd plugin.
> >
> >* Headings for examples.
> >
> >* Correct reference to qemu-nbd(8) man page.
> >
> >* General copy-editing to improve readability.
> >
> >* Change style in places so it matches other manual pages.
> >---
> >  plugins/nbd/nbdkit-nbd-plugin.pod | 192 +++++++++++++++++-------------
> >  1 file changed, 109 insertions(+), 83 deletions(-)
> >
> 
> >+
> >+=item [B<uri=>]URI
> >+
> >+When C<uri> is supplied, decode C<URI> to determine the address to
> >+connect to.  A URI can specify a TCP connection (such as
> >+C<nbd://localhost:10809/export>) or a Unix socket (such as
> >+C<nbd+unix:///export?socket=/path/to/sock>).  Remember you may need to
> >+quote the parameter to protect it from the shell.
> >+
> >+C<uri=> is a magic config key and may be omitted in most
> >+cases.  See L<nbdkit(1)/Magic parameters>.
> 
> Missing mention that URI support requires a capable libnbd (contrast
> to how TLS support also requires a capable libnbd...
> 
> >-The B<tls> parameter is only available when the plugin was compiled
> >+The C<tls> parameter is only available when the plugin was compiled
> >  against libnbd with TLS support; C<nbdkit --dump-plugin nbd> will
> >  contain C<libnbd_tls=1> if this is the case.  Note the difference
> >  between C<--tls=...> controlling what nbdkit serves, and C<tls=...>
> 
> ...here.

Fixed now, thanks.

Rich.

-- 
Richard Jones, Virtualization Group, Red Hat http://people.redhat.com/~rjones
Read my programming and virtualization blog: http://rwmj.wordpress.com
virt-top is 'top' for virtual machines.  Tiny program with many
powerful monitoring features, net stats, disk stats, logging, etc.
http://people.redhat.com/~rjones/virt-top