GNOME.org
 

[gnome-boxes] help: add properties and snapshot pages

commit 124bd976c5802db9b053906636f4e13d82ea32f1
Author: Michael Hill <mdhill gnome org>
Date:   Sun Sep 14 19:57:19 2014 -0400

    help: add properties and snapshot pages

 help/C/interface.page       |    6 +++---
 help/C/prop-system.page     |   32 ++++++++++++++++++++++++++++++++
 help/C/prop-trouble.page    |   32 ++++++++++++++++++++++++++++++++
 help/C/snapshot-create.page |   36 ++++++++++++++++++++++++++++++++++++
 help/C/snapshot-delete.page |   33 +++++++++++++++++++++++++++++++++
 help/C/snapshot-rename.page |   41 +++++++++++++++++++++++++++++++++++++++++
 help/C/snapshot-revert.page |   36 ++++++++++++++++++++++++++++++++++++
 help/Makefile.am            |    6 ++++++
 8 files changed, 219 insertions(+), 3 deletions(-)
---
diff --git a/help/C/interface.page b/help/C/interface.page
index 5c6293c..ae02baa 100644
--- a/help/C/interface.page
+++ b/help/C/interface.page
@@ -56,7 +56,7 @@
 
   <list>
     <item><p><link xref="delete">Delete</link> a box or boxes.</p></item>
-    <item><p>Mark a box or boxes as favourites.</p></item>
+    <item><p>Mark a box or boxes as favorites.</p></item>
     <item><p>Click the <gui style="button">Properties</gui> button to enter the
     properties view of a box.</p></item>
   </list>
@@ -89,8 +89,8 @@
     resizing of the display.</p></item>
     <item><p><gui>Device</gui> settings: access to system USB or CD/DVD
     devices.</p></item>
-    <item><p><gui>Snapshots</gui>: creating and managing snaphots of the
-    box.</p></item>
+    <item><p><gui>Snapshots</gui>: <link xref="snapshot-create">creating</link>
+    and managing snaphots of the box.</p></item>
   </list>
 
   <p>The properties view can also be accessed using the wizard's
diff --git a/help/C/prop-system.page b/help/C/prop-system.page
new file mode 100644
index 0000000..9d1ab7d
--- /dev/null
+++ b/help/C/prop-system.page
@@ -0,0 +1,32 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="prop-system">
+  <info>
+    <revision pkgversion="3.14" date="2014-09-14" status="review"/>
+    <link type="guide" xref="index#properties" group="#first" />
+
+    <credit type="author copyright">
+      <name>Michael Hill</name>
+      <email>mdhill gnome org</email>
+      <years>2014</years>
+    </credit>
+
+    <desc>Specify RAM and maximum disk allocation.</desc>
+  </info>
+
+  <title>Adjust the memory and disk settings of a box</title>
+
+  <p>In <app>Boxes</app>, each virtual machine has its own settings for RAM and
+  maximum allocated disk space.</p>
+
+  <steps>
+    <item><p>Open the <link xref="interface#properties">properties view</link>
+    for the box. If the box is open, click the Properties button in the header
+    bar. The properties view can also be accessed from
+    <link xref="interface#selection">selection mode</link>.</p></item>
+    <item><p>Click <gui>System</gui> in the sidebar.</p></item>
+    <item><p>Adjust the <gui>Memory</gui> and <gui>Maximum disk space</gui>
+    sliders to reflect the desired values.</p></item>
+  </steps>
+
+</page>
diff --git a/help/C/prop-trouble.page b/help/C/prop-trouble.page
new file mode 100644
index 0000000..bb5edd8
--- /dev/null
+++ b/help/C/prop-trouble.page
@@ -0,0 +1,32 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="prop-trouble">
+  <info>
+    <revision pkgversion="3.14" date="2014-09-14" status="review"/>
+    <link type="guide" xref="index#properties"/>
+
+    <credit type="author copyright">
+      <name>Michael Hill</name>
+      <email>mdhill gnome org</email>
+      <years>2014</years>
+    </credit>
+
+    <desc>Diagnose problems with your box using the log file.</desc>
+  </info>
+
+  <title>View the trouble log of a box</title>
+
+  <p>If a box is having a problem starting up or running, clues to help you fix
+  the problem may be found in the trouble log.</p>
+
+  <steps>
+    <item><p>Open the <link xref="interface#properties">properties view</link>
+    for the box. If the box is open, click the Properties button in the header
+    bar. The properties view can also be accessed from
+    <link xref="interface#selection">selection mode</link>.</p></item>
+    <item><p>Click <gui>System</gui> in the sidebar.</p></item>
+    <item><p>Click the <gui style="button">Trouble Log</gui> button to view the
+    log.</p></item>
+  </steps>
+
+</page>
diff --git a/help/C/snapshot-create.page b/help/C/snapshot-create.page
new file mode 100644
index 0000000..51c7a1c
--- /dev/null
+++ b/help/C/snapshot-create.page
@@ -0,0 +1,36 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="snapshot-create">
+  <info>
+    <revision pkgversion="3.14" date="2014-09-14" status="review"/>
+    <link type="guide" xref="index#snapshots" group="#first" />
+
+    <credit type="author copyright">
+      <name>Michael Hill</name>
+      <email>mdhill gnome org</email>
+      <years>2014</years>
+    </credit>
+
+    <desc>Save the state of a box for later use.</desc>
+  </info>
+
+  <title>Create a snapshot</title>
+
+  <p>If your virtual machine is operating perfectly in a desired configuration,
+  you may want to save the setup before it breaks because of a software upgrade
+  or configuration change. Taking a snapshot of the box preserves the current
+  state so you can return to it as often as you want.</p>
+
+  <steps>
+    <item><p>Open the <link xref="interface#properties">properties view</link>
+    for the box. If the box is open, click the Properties button in the header
+    bar. The properties view can also be accessed from
+    <link xref="interface#selection">selection mode</link>.</p></item>
+    <item><p>Click <gui>Snapshots</gui> in the sidebar.</p></item>
+    <item><p>Click <key>+</key> below the <gui>Snapshots</gui> list.</p></item>
+  </steps>
+
+  <p>A snapshot is saved reflecting the current state of your box. It appears
+  in the list.</p>
+
+</page>
diff --git a/help/C/snapshot-delete.page b/help/C/snapshot-delete.page
new file mode 100644
index 0000000..e75b46e
--- /dev/null
+++ b/help/C/snapshot-delete.page
@@ -0,0 +1,33 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="snapshot-delete">
+  <info>
+    <revision pkgversion="3.14" date="2014-09-14" status="review"/>
+    <link type="guide" xref="index#snapshots"/>
+
+    <credit type="author copyright">
+      <name>Michael Hill</name>
+      <email>mdhill gnome org</email>
+      <years>2014</years>
+    </credit>
+
+    <desc>Remove a snapshot that you no longer need.</desc>
+  </info>
+
+  <title>Delete a snapshot</title>
+
+  <p>A snapshot that is no longer needed can be removed from the list.</p>
+
+  <steps>
+    <item><p>Open the <link xref="interface#properties">properties view</link>
+    for the box. If the box is open, click the Properties button in the header
+    bar. The properties view can also be accessed from
+    <link xref="interface#selection">selection mode</link>.</p></item>
+    <item><p>Click <gui>Snapshots</gui> in the sidebar.</p></item>
+    <item><p>Select the snapshot to be deleted from the list.</p></item>
+    <item><p>Click the menu button on the right and select
+    <gui>Delete</gui>.</p></item>
+    <item><p>Confirm to permanently delete the snapshot.</p></item>
+  </steps>
+
+</page>
diff --git a/help/C/snapshot-rename.page b/help/C/snapshot-rename.page
new file mode 100644
index 0000000..d352bf8
--- /dev/null
+++ b/help/C/snapshot-rename.page
@@ -0,0 +1,41 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="snapshot-rename">
+  <info>
+    <revision pkgversion="3.14" date="2014-09-14" status="review"/>
+    <link type="guide" xref="index#snapshots"/>
+
+    <credit type="author copyright">
+      <name>Michael Hill</name>
+      <email>mdhill gnome org</email>
+      <years>2014</years>
+    </credit>
+
+    <desc>Give the snapshot a meaningful name.</desc>
+  </info>
+
+  <title>Rename a snapshot</title>
+
+  <p>By default, a snapshot is given a generic name based on the timestamp,
+  like:</p>
+
+    <p><file>09/14/2014, 11:54:36 AM</file></p>
+
+  <p>You may want to change the name to something more meaningful, such as:</p>
+
+    <p><file>Fedora_22_with_jhbuild</file> or
+    <file>Windows 7 plus GTK+ 3.6.4</file>.</p>
+
+  <steps>
+    <item><p>Open the <link xref="interface#properties">properties view</link>
+    for the box. If the box is open, click the Properties button in the header
+    bar. The properties view can also be accessed from
+    <link xref="interface#selection">selection mode</link>.</p></item>
+    <item><p>Click <gui>Snapshots</gui> in the sidebar.</p></item>
+    <item><p>Select the snapshot to be renamed from the list.</p></item>
+    <item><p>Click the menu button on the right and select
+    <gui>Rename</gui>.</p></item>
+    <item><p>Type the desired name and press <key>Enter</key>.</p></item>
+  </steps>
+
+</page>
diff --git a/help/C/snapshot-revert.page b/help/C/snapshot-revert.page
new file mode 100644
index 0000000..79fd92d
--- /dev/null
+++ b/help/C/snapshot-revert.page
@@ -0,0 +1,36 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="snapshot-revert">
+  <info>
+    <revision pkgversion="3.14" date="2014-09-14" status="review"/>
+    <link type="guide" xref="index#snapshots"/>
+
+    <credit type="author copyright">
+      <name>Michael Hill</name>
+      <email>mdhill gnome org</email>
+      <years>2014</years>
+    </credit>
+
+    <desc>Change back to the state of a saved snapshot.</desc>
+  </info>
+
+  <title>Revert the state of a box</title>
+
+  <p><em>Reverting</em> to a snapshot restores the state of the virtual machine
+  saved in that snapshot.</p>
+
+  <steps>
+    <item><p>Open the <link xref="interface#properties">properties view</link>
+    for the box. If the box is open, click the Properties button in the header
+    bar. The properties view can also be accessed from
+    <link xref="interface#selection">selection mode</link>.</p></item>
+    <item><p>Click <gui>Snapshots</gui> in the sidebar.</p></item>
+    <item><p>Select the snapshot from the list to which to revert.</p></item>
+    <item><p>Click the menu button on the right and select
+    <gui>Revert to this state</gui>.</p></item>
+  </steps>
+
+  <p>Changes made to the virtual machine since the snapshot was saved are
+  discarded.</p>
+
+</page>
diff --git a/help/Makefile.am b/help/Makefile.am
index 41edbb7..ed38757 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -13,9 +13,15 @@ HELP_FILES = index.page                      \
        disk-images.page                \
        interface.page                  \
        legal.xml                       \
+       prop-system.page                \
+       prop-trouble.page               \
        search.page                     \
        shortcuts.page                  \
        shutdown.page                   \
+       snapshot-create.page            \
+       snapshot-delete.page            \
+       snapshot-rename.page            \
+       snapshot-revert.page            \
        supported-protocols.page        \
        system-requirements.page        \
        usb-redirection.page            \
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]