docs: Clarify options that should not have data
commitf8b9f02e85cc3d12ec67a7fa26344d17d3ac5f2c
authorEric Blake <eblake@redhat.com>
Wed, 18 Oct 2017 19:40:12 +0000 (18 14:40 -0500)
committerWouter Verhelst <w@uter.be>
Wed, 18 Oct 2017 20:00:05 +0000 (18 22:00 +0200)
tree9a0625343b9c6d185e760655e97b894e2477dc3e
parent286630e7ddf2bc44d3fad3c55fd1ed7719a1e83a
docs: Clarify options that should not have data

The spec indirectly stated that NBD_OPT_LIST should be sent without
data (by virtue of the fact that NBD_REP_ERR_INVALID mentioned
non-zero data length as a reason for failure), but making zero-length
options explicit in the documentation of each option is nicer.
As an exception, make it clear that NBD_OPT_ABORT should succeed at
ending the connection rather than being ignored with an error due
to non-zero length, even though well-behaved clients won't send such
length.

This mirrors existing practice in many implementations, and is done
in a way that can be copied to NBD_OPT_STRUCTURED_REPLY and other
extension options that do not require data.

Signed-off-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Wouter Verhelst <w@uter.be>
doc/proto.md