[OASIS Issue Tracker] (VIRTIO-89) VIRTIO Spec feedback #7 From: Arun Subbarao

[OASIS Issues Tracker <workgroup_mailer@lists.oasis-open.org>]

Michael Tsirkin created VIRTIO-89:
-------------------------------------

             Summary: VIRTIO Spec feedback  #7 From: Arun Subbarao
                 Key: VIRTIO-89
                 URL: https://tools.oasis-open.org/issues/browse/VIRTIO-89
             Project: OASIS Virtual I/O Device (VIRTIO) TC
          Issue Type: Bug
            Reporter: Michael Tsirkin


Link to Mail: https://lists.oasis-open.org/archives/virtio-comment/201401/msg00058.html
Commenter name: Arun Subbarao <asubbarao@lnxw.com>

(PARTIAL: there is more feedback)

The lack of any kind of distinguishing emphasis used consistently with field names in this document makes it hard to read. For example, here, is it literally the next field or the field called "next"? Because there is a field called "next" defined by this spec. This made me scroll back to the used ring definition to refresh the meaning of field "next" in my head, only to realize there is no such field in that particular structure. You are not kind to the reader.

If you search for the field name "avail_event", you will see that sometimes it is emphasized with quotes and sometimes it isn't. Probably better to use a monospace font instead.





--
This message was sent by Atlassian JIRA
(v6.1.1#6155)