[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: [OASIS Issue Tracker] (VIRTIO-80) Bad sub-sectioning (23 cases)
[ https://tools.oasis-open.org/issues/browse/VIRTIO-80?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Michael Tsirkin updated VIRTIO-80: ---------------------------------- Affects Version/s: virtio 1.0 csprd01 Description: In order to have a subsection, it is necessary to have at least two subsections. Thus: 1. Title 1.1 sub-title 1.2 sub-title is correct, but, 1. Title 1.1 sub-title 2. Title is incorrect. Just listing the incorrect sub-sections: 2.2.1, 2.4.3.1, 2.4.4.1, 3.1.1, 4.1.1.1, 4.3.2.1.1, 4.3.2.2.1, 5.1.3.1, 5.1.4.1, 5.1.6.2.1, 5.1.6.3.1, 5.2.3.2.1, 5.2.4.1, 5.2.5.1, 5.3.4.1, 5.3.6.1, 5.5.4.1, 5.5.6.1.1, 5.6.4.1, 5.6.6.1.1, 5.6.6.2.1, 5.6.6.3.1, and 6.1. Let's take 6.1 as an easy one to demonstrate. The common problem in most of the improper sub-sections is how to deal with legacy aspects of some part that is being defined. Yes? OK, so we start with: 6. Reserved Feature Bits 6.1 Reserved Feature Bits Defined by [VIRTIO-v1.0] The four reserved feature bits defined by [VIRTIO-v1.0] are: I would do a numbered list, all in the same format. Switching to prose for "bit 30 is used by qemu's (reference?) implementation," is confusing. 6.2 Reserved Feature Bits (Legacy) Neither VIRTIO_F_NOTIFY_ON_EMPTY (24) nor VIRTIO_F_ANY_LAYOUT (27) are defined herein. Please insert reference here to the standard that defines them and put it in the normative references as well. was: In order to have a subsection, it is necessary to have at least two subsections. Thus: 1. Title 1.1 sub-title 1.2 sub-title is correct, but, 1. Title 1.1 sub-title 2. Title is incorrect. Just listing the incorrect sub-sections: 2.2.1, 2.4.3.1, 2.4.4.1, 3.1.1, 4.1.1.1, 4.3.2.1.1, 4.3.2.2.1, 5.1.3.1, 5.1.4.1, 5.1.6.2.1, 5.1.6.3.1, 5.2.3.2.1, 5.2.4.1, 5.2.5.1, 5.3.4.1, 5.3.6.1, 5.5.4.1, 5.5.6.1.1, 5.6.4.1, 5.6.6.1.1, 5.6.6.2.1, 5.6.6.3.1, and 6.1. Let's take 6.1 as an easy one to demonstrate. The common problem in most of the improper sub-sections is how to deal with legacy aspects of some part that is being defined. Yes? OK, so we start with: 6. Reserved Feature Bits 6.1 Reserved Feature Bits Defined by [VIRTIO-v1.0] The four reserved feature bits defined by [VIRTIO-v1.0] are: I would do a numbered list, all in the same format. Switching to prose for "bit 30 is used by qemu's (reference?) implementation," is confusing. 6.2 Reserved Feature Bits (Legacy) Neither VIRTIO_F_NOTIFY_ON_EMPTY (24) nor VIRTIO_F_ANY_LAYOUT (27) are defined herein. Please insert reference here to the standard that defines them and put it in the normative references as well. Proposal: Correct the subsections. Fix the lack of references in 6.1 and update normative references with proper source for both. (Actually, I disagree with solitary subsections as I think we're better for it. But point about feature bit 30 is taken: https://lists.oasis-open.org/archives/virtio-comment/201402/msg00101.html ) was: Correct the subsections. Fix the lack of references in 6.1 and update normative references with proper source for both. (Actually, I disagree with solitary subsections as I think we're better for it. But point about feature bit 30 is taken: https://lists.oasis-open.org/archives/virtio-comment/201402/msg00101.html ) > Bad sub-sectioning (23 cases) > ----------------------------- > > Key: VIRTIO-80 > URL: https://tools.oasis-open.org/issues/browse/VIRTIO-80 > Project: OASIS Virtual I/O Device (VIRTIO) TC > Issue Type: Bug > Affects Versions: virtio 1.0 csprd01 > Environment: Structure > Reporter: Patrick Durusau > Assignee: Rusty Russell > Priority: Minor > Fix For: virtio 1.0 csprd02 > > > In order to have a subsection, it is necessary to have at least two subsections. > Thus: > 1. Title > 1.1 sub-title > 1.2 sub-title > is correct, but, > 1. Title > 1.1 sub-title > 2. Title > is incorrect. > Just listing the incorrect sub-sections: 2.2.1, 2.4.3.1, 2.4.4.1, 3.1.1, 4.1.1.1, 4.3.2.1.1, 4.3.2.2.1, 5.1.3.1, 5.1.4.1, 5.1.6.2.1, 5.1.6.3.1, 5.2.3.2.1, 5.2.4.1, 5.2.5.1, 5.3.4.1, 5.3.6.1, 5.5.4.1, 5.5.6.1.1, 5.6.4.1, 5.6.6.1.1, 5.6.6.2.1, 5.6.6.3.1, and 6.1. > Let's take 6.1 as an easy one to demonstrate. > The common problem in most of the improper sub-sections is how to deal with legacy aspects of some part that is being defined. Yes? > OK, so we start with: > 6. Reserved Feature Bits > 6.1 Reserved Feature Bits Defined by [VIRTIO-v1.0] > The four reserved feature bits defined by [VIRTIO-v1.0] are: > I would do a numbered list, all in the same format. Switching to prose for "bit 30 is used by qemu's (reference?) implementation," is confusing. > 6.2 Reserved Feature Bits (Legacy) > Neither VIRTIO_F_NOTIFY_ON_EMPTY (24) nor VIRTIO_F_ANY_LAYOUT (27) are defined herein. Please insert reference here to the standard that defines them and put it in the normative references as well. -- This message was sent by Atlassian JIRA (v6.1.1#6155)
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]