Re: [virtio-dev] Re: [PATCH v3 1/6] notifications: unify notifications wording in core

[Halil Pasic <pasic@linux.ibm.com>]

On 06/25/2018 04:45 PM, Cornelia Huck wrote:
> On Mon, 25 Jun 2018 14:21:27 +0200
> Halil Pasic <pasic@linux.ibm.com> wrote:
>
> > Let us unify the wording when talking about notifications. This change
> > establishes the terms available buffer notification for what was usually

[..]

> >   Device reports the number of bytes it has written to memory for
> >   each buffer it uses. This is referred to as ``used length''.
>
> Unrelated: Device and driver are missing the definite article in some
> places. Might be an idea for an additional patch :)

Yes, there are definitively other things that could be improved. For example
the capitalization in listing:

\begin{itemize}
\item Device status field
\item Feature bits
\item Notifications
\item Device Configuration space

Capital C in *C*onfiguration is most likely wrong.

\item One or more virtqueues
\end{itemize}

Regarding bullet points and capitalization, if the bullet
point is not a sentence but a fragment there seems to be multiple
viable styles. But I'm afraid we aren't consequent across the spec.

Another question is capitalization of 'virtio terms' like Available Ring.
On some occasions we write 'Available Ring' on others 'available ring'.

It would be nice to have a polished document. But for now I will try
to target fragments where the semantics suffers too. (I had another
series that I already presented as RFC but decided to not push in
parallel with this one).


> Reviewed-by: Cornelia Huck <cohuck@redhat.com>

Thanks!

Regards,
Halil