diff mbox

[1/2] proto.md: Clearly set out NBDMAGIC is the actual value

Message ID 1459448124-52318-1-git-send-email-alex@alex.org.uk (mailing list archive)
State New, archived
Headers show

Commit Message

Alex Bligh March 31, 2016, 6:15 p.m. UTC
Clearly set out NBDMAGIC, not the name of a constant equal to
some value. Set out the value in hex as well.

Signed-off-by: Alex Bligh <alex@alex.org.uk>
---
 doc/proto.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Eric Blake March 31, 2016, 7:08 p.m. UTC | #1
On 03/31/2016 12:15 PM, Alex Bligh wrote:
> Clearly set out NBDMAGIC, not the name of a constant equal to
> some value. Set out the value in hex as well.
> 
> Signed-off-by: Alex Bligh <alex@alex.org.uk>
> ---
>  doc/proto.md | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/proto.md b/doc/proto.md
> index c1e05c5..7994076 100644
> --- a/doc/proto.md
> +++ b/doc/proto.md
> @@ -67,7 +67,7 @@ newstyle negotiation.
>  
>  #### Oldstyle negotiation
>  
> -S: 64 bits, `NBDMAGIC` (also known as the `INIT_PASSWD`)  
> +S: 64 bits, `0x4e42444d41474943` (ASCII '`NBDMAGIC`') (also known as the `INIT_PASSWD`)  
>  S: 64 bits, `0x00420281861253` (`cliserv_magic`, a magic number)  
>  S: 64 bits, size of the export in bytes (unsigned)  
>  S: 32 bits, flags  
> @@ -96,7 +96,7 @@ production purposes.
>  
>  The initial few exchanges in newstyle negotiation look as follows:
>  
> -S: 64 bits, `NBDMAGIC` (as in the old style handshake)  
> +S: 64 bits, `0x4e42444d41474943` (ASCII '`NBDMAGIC`') (as in the old style handshake)  

Markdown doesn't care, but the rest of this file is less than 80
columns, making this a long line.  You can wrap it (see how I wrapped
the line regarding 124 bytes of zeroes in response to NBD_OPT_EXPORT_NAME).

>  S: 64 bits, `0x49484156454F5054` (note different magic number)  

As long as we are spelling out ASCII counterpart, is it worth mentioning
that this is (ASCII `'IHAVEOPT'`)?
diff mbox

Patch

diff --git a/doc/proto.md b/doc/proto.md
index c1e05c5..7994076 100644
--- a/doc/proto.md
+++ b/doc/proto.md
@@ -67,7 +67,7 @@  newstyle negotiation.
 
 #### Oldstyle negotiation
 
-S: 64 bits, `NBDMAGIC` (also known as the `INIT_PASSWD`)  
+S: 64 bits, `0x4e42444d41474943` (ASCII '`NBDMAGIC`') (also known as the `INIT_PASSWD`)  
 S: 64 bits, `0x00420281861253` (`cliserv_magic`, a magic number)  
 S: 64 bits, size of the export in bytes (unsigned)  
 S: 32 bits, flags  
@@ -96,7 +96,7 @@  production purposes.
 
 The initial few exchanges in newstyle negotiation look as follows:
 
-S: 64 bits, `NBDMAGIC` (as in the old style handshake)  
+S: 64 bits, `0x4e42444d41474943` (ASCII '`NBDMAGIC`') (as in the old style handshake)  
 S: 64 bits, `0x49484156454F5054` (note different magic number)  
 S: 16 bits, handshake flags  
 C: 32 bits, flags