From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: virtio-return-3534-cohuck=redhat.com@lists.oasis-open.org Sender: List-Post: List-Help: List-Unsubscribe: List-Subscribe: Date: Wed, 17 Mar 2021 09:43:34 +0100 From: Cornelia Huck Message-ID: <20210317094334.38116d2d.cohuck@redhat.com> In-Reply-To: <20210316211311.154117-1-mst@redhat.com> References: <20210316211311.154117-1-mst@redhat.com> MIME-Version: 1.0 Subject: Re: [virtio] [PATCH] introduction: document #define syntax Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit To: "Michael S. Tsirkin" Cc: virtio-comment@lists.oasis-open.org, virtio-dev@lists.oasis-open.org, virtio@lists.oasis-open.org List-ID: On Tue, 16 Mar 2021 17:13:17 -0400 "Michael S. Tsirkin" wrote: > We use the C #define syntax to refer to numeric values. > Let's document that. > > Signed-off-by: Michael S. Tsirkin > --- > introduction.tex | 21 +++++++++++++++++++++ > 1 file changed, 21 insertions(+) > > diff --git a/introduction.tex b/introduction.tex > index cc38e29..4febed2 100644 > --- a/introduction.tex > +++ b/introduction.tex > @@ -210,6 +210,27 @@ \section{Structure Specifications} > \begin{lstlisting} > CPU_TO_BE16(B << 15 | A) > \end{lstlisting} > +\section{Constant Specifications} > + > +In many cases, numberic values used in the interface between the device s/numberic/numeric/ > +and the driver are documented using the C #define and /* */ > +comment syntax. Multiple related values are grouped together with > +a common name as a prefix, using _ as a separator. > +Using _XXX as a suffix refers to all values in a group. > +For example: > + > +\begin{lstlisting} > +/* Value A description */ > +#define VIRTIO_VALUE_A (1 << 0) > +/* Value B description */ > +#define VIRTIO_VALUE_B (1 << 1) > +\end{lstlisting} > +documents two numeric values: 1 meaning Value A and 2 meaning > +Value B. Doesn't that really document that Value A *is* 1? I'm a bit confused by that sentence. > Note that $<<$ refers to the shift-left operation. > + > +Further, in this case VIRTIO_VALUE_A and VIRTIO_VALUE_B > +refer to 1 and 2 respectively. Further, VIRTIO_VALUE_XXX refers to > +either VIRTIO_VALUE_A or VIRTIO_VALUE_B. > > \newpage > --------------------------------------------------------------------- To unsubscribe from this mail list, you must leave the OASIS TC that generates this mail. Follow this link to all your TCs in OASIS at: https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php