[gnome-boxes/add-edit-xml-docs: 2/2] help: Add instructions to edit libvirt domain XML of a box
- From: Felipe Borges <felipeborges src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-boxes/add-edit-xml-docs: 2/2] help: Add instructions to edit libvirt domain XML of a box
- Date: Wed, 10 Mar 2021 15:34:06 +0000 (UTC)
commit 33498fafa970e86d07ebf6d33bd1f7875e5e73c9
Author: Felipe Borges <felipeborges gnome org>
Date: Wed Mar 10 10:57:46 2021 +0100
help: Add instructions to edit libvirt domain XML of a box
See https://gitlab.gnome.org/GNOME/gnome-boxes/-/merge_requests/350
See also https://libvirt.org/format.html
Fixes #611
help/C/edit-domain.page | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
help/meson.build | 1 +
2 files changed, 50 insertions(+)
---
diff --git a/help/C/edit-domain.page b/help/C/edit-domain.page
new file mode 100644
index 00000000..34dfad22
--- /dev/null
+++ b/help/C/edit-domain.page
@@ -0,0 +1,49 @@
+<page xmlns="http://projectmallard.org/1.0/"
+ xmlns:its="http://www.w3.org/2005/11/its"
+ type="topic" style="task"
+ id="edit-domain">
+ <info>
+ <revision pkgversion="40.rc" date="2021-03-10" status="review"/>
+ <link type="guide" xref="index#properties"/>
+
+ <credit type="author copyright">
+ <name>Felipe Borges</name>
+ <email>felipeborges gnome org</email>
+ <years>2021</years>
+ </credit>
+
+ <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+ <desc>Edit advanced configurations of your box.</desc>
+ </info>
+
+ <title>Edit the Libvirt domain XML configuration of a box</title>
+
+ <comment>
+ <cite date="2021-02-10" href="mailto:felipeborges gnome org">Felipe Borges</cite>
+ <p>This assumes the reader has a basic understanding of libvirt domains and virtualization
+ concepts such as virtual devices. See https://libvirt.org/format.html
+ By the end of this page, the reader will be able to configure their virtual machine beyond
+ what GNOME Boxes exposes in its user interface.</p>
+ </comment>
+
+ <p>Boxes now gives you the ability to manually edit the <sys>Libvirt</sys> XML configuration of
+ your virtual machines. This should allow you to achieve specific setups which are not exposed
+ in the GNOME Boxes interface and neither supported by the GNOME Boxes developers.</p>
+
+ <steps>
+ <title>To edit the Libvirt XML configuration of a box:</title>
+ <item><p>Right-click on the box in the collection view and select
+ <gui>Properties</gui>, or click the menu
+ (<media type="image" src="figures/open-menu-symbolic.svg" its:translate="no"><span
its:translate="yes">settings</span></media>)
+ button in the header bar and select <gui>Properties</gui>.</p></item>
+ <item><p>Click the <gui>System</gui> tab.</p></item>
+ <item><p>Click the <gui style="button">Edit XML</gui> button to open the configuration
+ editor.</p></item>
+ <item><p>Edit the XML configuration and click <gui style="button">Save</gui>. Boxes will attempt
+ to create a snapshot prior to your changes getting applied, allowing you to revert your
+ configuration in case of a mistake.</p></item>
+ <item><p>If the virtual machine which has been edited is already running, Boxes will show a
+ notification asking to restart the running virtual machine.</p></item>
+ </steps>
+</page>
diff --git a/help/meson.build b/help/meson.build
index a5d7bbc1..6ed28285 100644
--- a/help/meson.build
+++ b/help/meson.build
@@ -4,6 +4,7 @@ help_files = [
'create.page',
'delete.page',
'disk-images.page',
+ 'edit-domain.page',
'index.page',
'interface.page',
'keystrokes.page',
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]