tools/xenstore: modify feature bit specification in xenstore-ring.txt
authorJuergen Gross <jgross@suse.com>
Tue, 28 Jun 2022 15:06:14 +0000 (17:06 +0200)
committerJan Beulich <jbeulich@suse.com>
Tue, 28 Jun 2022 15:06:14 +0000 (17:06 +0200)
Instead of specifying the feature bits in xenstore-ring.txt as a mask
value use bit numbers. This will make the specification easier to read
when adding more features.

Signed-off-by: Juergen Gross <jgross@suse.com>
Reviewed-by: Julien Grall <jgrall@amazon.com>
docs/misc/xenstore-ring.txt

index f3d6ca42646bd081bde3a5d7c1f506f75daa0f81..2792d1353012df9f293ad37f904f8b3834bf8a3e 100644 (file)
@@ -62,12 +62,13 @@ the server feature bitmap. The server features are offered to the guest;
 it is up to the guest whether to use them or not. The guest should ignore
 any unknown feature bits.
 
-The following features are defined:
+The following features are defined (bit number 0 is equivalent to a mask
+value of 1):
 
-Mask    Description
+Bit     Description
 -----------------------------------------------------------------
-1       Ring reconnection (see the ring reconnection feature below)
-2       Connection error indicator (see connection error feature below)
+0       Ring reconnection (see the ring reconnection feature below)
+1       Connection error indicator (see connection error feature below)
 
 The "Connection state" field is used to request a ring close and reconnect.
 The "Connection state" field only contains valid data if the server has