[libvirt] [PATCH v1 13/14] docs: Document user aliases

Signed-off-by: Michal Privoznik <mprivozn(a)redhat.com&gt; --- docs/formatdomain.html.in | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index b7e145e0f..57dd46dc5 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -2249,6 +2249,29 @@ </dd> </dl> + <p> + To help users identifying devices they care about, every + device can have direct child <code>alias</code> element + which then has <code>name</code> attribute where users can + store identifier for the device. The identifier has to have + "ua-" prefix and must be unique within the domain. Additionally, the + identifier must consist only of the following characters: + <code>[a-zA-Z0-9_-]</code>. + <span class="since">Since 3.9.0</span> + </p> + +<pre> +&lt;devices&gt; + &lt;disk type='file'&gt; + &lt;alias name='ua-myDisk'/&gt; + &lt;/disk&gt; + &lt;interface type='network' trustGuestRxFilters='yes'&gt; + &lt;alias name='ua-myNIC'/&gt; + &lt;/interface&gt; + ... +&lt;/devices&gt; +</pre> + <h4><a id="elementsDisks">Hard drives, floppy disks, CDROMs</a></h4> <p> -- 2.13.6