[libvirt] [PATCH 01/11] docs: Tweak PCI controller model documentation
John Ferlan
jferlan at redhat.com
Tue Apr 3 23:11:24 UTC 2018
On 03/28/2018 10:06 AM, Andrea Bolognani wrote:
> Instead of first listing the models on their own, and then
> listing them again grouped by the libvirt release they were
> introduced in, have a single list.
>
> Signed-off-by: Andrea Bolognani <abologna at redhat.com>
> ---
> docs/formatdomain.html.in | 20 ++++++++------------
> 1 file changed, 8 insertions(+), 12 deletions(-)
>
Personally I don't find it any easier to read ;-) - it's all a mash of
letters and dashes... Of course true of other parts on formatdomain too.
Still, how about something like this:
<table class="top_table">
<tr>
<th> Value </th>
<th> Since </th>
</tr>
<tr>
<td> pci-root </td>
<td> <span class="since">since 1.0.5</span> </td>
</tr>
<tr>
<td> pci-bridge </td>
<td> <span class="since">since 1.0.5</span> </td>
</tr>
<tr>
<td> pcie-root </td>
<td> <span class="since">since 1.1.2</span> </td>
</tr>
<tr>
<td> dmi-to-pci-bridge </td>
<td> <span class="since">since 1.1.2</span> </td>
</tr>
<tr>
<td> pcie-root-port </td>
<td> <span class="since">since 1.2.19</span> </td>
</tr>
<tr>
<td> pcie-switch-upstream-port </td>
<td> <span class="since">since 1.2.19</span> </td>
</tr>
<tr>
<td> pcie-switch-downstream-port </td>
<td> <span class="since">since 1.2.19</span> </td>
</tr>
<tr>
<td> pci-expander-bus </td>
<td> <span class="since">since 1.3.4</span> </td>
</tr>
<tr>
<td> pcie-expander-bus </td>
<td> <span class="since">since 1.3.4</span> </td>
</tr>
</table>
</p>
<p>
You could choose different labels if you desired... Also consider the
possibilities for expansion w/r/t providing even a *little* bit more
"Description" details about what each of these things are and
when/how/why they'd be used (far beyond the scope of this patch though).
I would think some of that could be drawn from the descriptions that
exist "just above" the "Device leases" section. IOW: a relationship
matrix...
With at least the table,
Reviewed-by: John Ferlan <jferlan at redhat.com>
John
> diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
> index 08dc74b6b9..299d7b9d42 100644
> --- a/docs/formatdomain.html.in
> +++ b/docs/formatdomain.html.in
> @@ -3936,18 +3936,14 @@
>
> <p>
> PCI controllers have an optional <code>model</code> attribute with
> - possible values <code>pci-root</code>, <code>pcie-root</code>,
> - <code>pcie-root-port</code>, <code>pci-bridge</code>,
> - <code>dmi-to-pci-bridge</code>, <code>pcie-switch-upstream-port</code>,
> - <code>pcie-switch-downstream-port</code>, <code>pci-expander-bus</code>,
> - or <code>pcie-expander-bus</code>. (pci-root and
> - pci-bridge <span class="since">since 1.0.5</span>, pcie-root and
> - dmi-to-pci-bridge <span class="since">since 1.1.2</span>,
> - pcie-root-port, pcie-switch-upstream-port,
> - pcie-switch-downstream-port <span class="since">since
> - 1.2.19</span>, and pci-expander-bus and
> - pcie-expander-bus <span class="since">since 1.3.4</span>) The
> - root controllers (<code>pci-root</code>
> + possible values <code>pci-root</code> and <code>pci-bridge</code>
> + (<span class="since">since 1.0.5</span>), <code>pcie-root</code> and
> + <code>dmi-to-pci-bridge</code> (<span class="since">since 1.1.2</span>),
> + <code>pcie-root-port</code>, <code>pcie-switch-upstream-port</code> and
> + <code>pcie-switch-downstream-port</code> (<span class="since">since
> + 1.2.19</span>), <code>pci-expander-bus</code> and
> + <code>pcie-expander-bus</code> (<span class="since">since 1.3.4</span>).
> + The root controllers (<code>pci-root</code>
> and <code>pcie-root</code>) have an
> optional <code>pcihole64</code> element specifying how big (in
> kilobytes, or in the unit specified by <code>pcihole64</code>'s
>
More information about the libvir-list
mailing list