Re: [PATCH] latexify document more.

[Rusty Russell <rusty@au1.ibm.com>]

Cornelia Huck <cornelia.huck@de.ibm.com> writes:
> On Mon, 02 Dec 2013 16:56:16 +1030
> Rusty Russell <rusty@au1.ibm.com> wrote:
>
>> This change:
>> - Turns formatted lists into real lists (itemize, etc).
>> - Turns ascii tables into real tables.
>> - Use \ldots for ...
>> - Moves \footnote to immediately after what it refers to, otherwise we
>>   get awkward whitespace before the superscript.
>> - List of stats for balloon contains values in () to match other lists.
>> - Puts lstlisting around CCW code example
>> 
>> No actual contents changed, but I haven't committed it yet to avoid
>> stepping on MST's toes if he has outstanding commits.
>
> Looks very similar to what I started doing in my github tree :)
>
> Some more comments below...
>
>> 
>> Signed-off-by: Rusty Russell <rusty@au.ibm.com>
>> 
>
>> @@ -988,16 +986,15 @@ If you turn it off again, they move back!
>>  Immediately following these general headers, there may be
>>  device-specific headers:
>>  
>> -\begin{verbatim}
>> -+------------++--------------------+
>> -| Bits       || Device Specific    |
>> -+------------++--------------------+
>> -| Read/Write || Device Specific    |
>> -+------------++--------------------+
>> -| Purpose    || Device Specific... |
>> -|            ||                    |
>> -+------------++--------------------+
>> -\end{verbatim}
>> +\begin{tabular}{ |l||l| }
>> +\hline
>> +Bits       & Device Specific \\
>> +\hline
>> +Read/Write & Device Specific \\
>> +\hline
>> +Purpose    & Device Specific... \\
>> +\hline
>> +\end{tabular}
>
> For this table, I'd prefer my version:
>
> \begin{tabular}{|l||l|l|}
> \hline
> Bits & Device Specific & \multirow{3}{*}{...} \\
> \cline{1-2}
> Read / Write & Device Specific & \\
> \cline{1-2}
> Purpose & Device Specific & \\
> \hline
> \end{tabular}

Sure, I'll apply this if MST hasn't beaten me to it.

>>  
>>  Note that only Feature Bits 0 to 31 are accessible through the
>>  Legacy Interface. When used through the Legacy Interface,
>
>> @@ -1970,11 +1984,11 @@ and align the alignment.
>>  The virtqueue is physically contiguous, with padded added to make the
>>  used ring meet the align value:
>>  
>> -\begin{verbatim}
>> -+-------------------+-----------------------------------+-----------+
>> -| Descriptor Table  |   Available Ring     (padding)    | Used Ring |
>> -+-------------------+-----------------------------------+-----------+
>> -\end{verbatim}
>> +\begin{tabular}{|l|l|l|}
>> +\hline
>> +Descriptor Table & Available Ring (\ldots padding\ldots) & Used Ring \\
>> +\hline
>> +\end{tabular}
>>  
>>  The calculation for total size is as follows:
>>  
>
> Just noted: This seems to be a duplicate paragraph, no? We already
> described the layout earlier, no need to repeat it in the virtio-ccw
> section.

Yes, we describe it once in the legacy section earlier.  The
duplication is deliberate, so that each section stands alone, because
we were originally going to put legacy in a separate document.  Even
if we don't, making non-legacy depend on legacy feels wrong; I think
this is the lesser evil?

But I don't really mind.  If you dislike it, please directly edit
before meeting :)

Cheers,
Rusty.