[v2,1/4] tools/xenstore: modify feature bit specification in xenstore-ring.txt

Commit Message

Jürgen Groß May 27, 2022, 7:24 a.m. UTC

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 <[e-mail]>
---
V2:
- new patch (triggered by Julien Grall)
---
 docs/misc/xenstore-ring.txt | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

Comments

Julien Grall June 23, 2022, 6:14 p.m. UTC | #1

Hi Juergen,

On 27/05/2022 08:24, Juergen Gross wrote:
> 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 <[e-mail]>

Reviewed-by: Julien Grall <[e-mail]>

Cheers,

Patch

diff --git a/docs/misc/xenstore-ring.txt b/docs/misc/xenstore-ring.txt
index f3d6ca4264..2792d13530 100644
--- a/docs/misc/xenstore-ring.txt
+++ b/docs/misc/xenstore-ring.txt
@@ -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