[PATCH 01/10] docs: xlexample.hvm: Mention this isn't useful for other guests

[PATCH 01/10] docs: xlexample.hvm: Mention this isn't useful for other guests

[Elliott Mitchell]

I dislike the implication this default is valuable for all guests, need
some mention of trade-off.

Signed-off-by: Elliott Mitchell <ehem+xen@m5p.com>
---
 tools/examples/xlexample.hvm | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tools/examples/xlexample.hvm b/tools/examples/xlexample.hvm
index df9fe07653..c2db4f237a 100644
--- a/tools/examples/xlexample.hvm
+++ b/tools/examples/xlexample.hvm
@@ -18,7 +18,7 @@ name = "example.hvm"
 
 # Enable Microsoft Hyper-V compatibile paravirtualisation /
 # enlightenment interfaces. Turning this on can improve Windows guest
-# performance and is therefore recommended
+# performance and is therefore recommended for Windows guests
 #viridian = 1
 
 # Initial memory allocation (MB)
-- 
2.30.2

[PATCH 02/10] docs: xlexample.*: Use consistent vCPU count

[Elliott Mitchell]

Make all examples use the same number of vCPUs.  Hopefully this avoids
confusing attempts at benchmarking during installation.

Signed-off-by: Elliott Mitchell <ehem+xen@m5p.com>
---
 tools/examples/xlexample.hvm      | 2 +-
 tools/examples/xlexample.pvhlinux | 2 +-
 tools/examples/xlexample.pvlinux  | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/tools/examples/xlexample.hvm b/tools/examples/xlexample.hvm
index c2db4f237a..ed821fea87 100644
--- a/tools/examples/xlexample.hvm
+++ b/tools/examples/xlexample.hvm
@@ -30,7 +30,7 @@ memory = 128
 #maxmem = 512
 
 # Number of VCPUS
-vcpus = 2
+vcpus = 3
 
 # Network devices
 # A list of 'vifspec' entries as described in
diff --git a/tools/examples/xlexample.pvhlinux b/tools/examples/xlexample.pvhlinux
index 18305b80af..49961e4687 100644
--- a/tools/examples/xlexample.pvhlinux
+++ b/tools/examples/xlexample.pvhlinux
@@ -29,7 +29,7 @@ extra = "root=/dev/xvda1"
 memory = 512
 
 # Number of VCPUS
-vcpus = 4
+vcpus = 3
 
 # Network devices
 # A list of 'vifspec' entries as described in
diff --git a/tools/examples/xlexample.pvlinux b/tools/examples/xlexample.pvlinux
index bb5996b29f..0c7a535f39 100644
--- a/tools/examples/xlexample.pvlinux
+++ b/tools/examples/xlexample.pvlinux
@@ -31,7 +31,7 @@ memory = 128
 #maxmem = 512
 
 # Number of VCPUS
-vcpus = 2
+vcpus = 3
 
 # Network devices
 # A list of 'vifspec' entries as described in
-- 
2.30.2

[PATCH 03/10] docs: xlexample.*: Use consistent initial memory

[Elliott Mitchell]

Avoid confusing benchmarking during initial installation by using
consistent amounts of memory for examples.

Signed-off-by: Elliott Mitchell <ehem+xen@m5p.com>
---
 tools/examples/xlexample.hvm      | 2 +-
 tools/examples/xlexample.pvhlinux | 2 +-
 tools/examples/xlexample.pvlinux  | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/tools/examples/xlexample.hvm b/tools/examples/xlexample.hvm
index ed821fea87..26ae1c2fb4 100644
--- a/tools/examples/xlexample.hvm
+++ b/tools/examples/xlexample.hvm
@@ -22,7 +22,7 @@ name = "example.hvm"
 #viridian = 1
 
 # Initial memory allocation (MB)
-memory = 128
+memory = 384
 
 # Maximum memory (MB)
 # If this is greater than `memory' then the slack will start ballooned
diff --git a/tools/examples/xlexample.pvhlinux b/tools/examples/xlexample.pvhlinux
index 49961e4687..1e9bcb9de5 100644
--- a/tools/examples/xlexample.pvhlinux
+++ b/tools/examples/xlexample.pvhlinux
@@ -26,7 +26,7 @@ kernel = "/boot/vmlinuz"
 extra = "root=/dev/xvda1"
 
 # Initial memory allocation (MB)
-memory = 512
+memory = 384
 
 # Number of VCPUS
 vcpus = 3
diff --git a/tools/examples/xlexample.pvlinux b/tools/examples/xlexample.pvlinux
index 0c7a535f39..be6931549a 100644
--- a/tools/examples/xlexample.pvlinux
+++ b/tools/examples/xlexample.pvlinux
@@ -23,7 +23,7 @@ kernel = "/boot/vmlinuz"
 extra = "root=/dev/xvda1"
 
 # Initial memory allocation (MB)
-memory = 128
+memory = 384
 
 # Maximum memory (MB)
 # If this is greater than `memory' then the slack will start ballooned
-- 
2.30.2

[PATCH 04/10] docs: xlexample.pvhlinux: Add commented maxmem setting

[Elliott Mitchell]

Avoid confusion caused by differing example configuration files.

Signed-off-by: Elliott Mitchell <ehem+xen@m5p.com>
---
 tools/examples/xlexample.pvhlinux | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/tools/examples/xlexample.pvhlinux b/tools/examples/xlexample.pvhlinux
index 1e9bcb9de5..e1bf845093 100644
--- a/tools/examples/xlexample.pvhlinux
+++ b/tools/examples/xlexample.pvhlinux
@@ -28,6 +28,11 @@ extra = "root=/dev/xvda1"
 # Initial memory allocation (MB)
 memory = 384
 
+# Maximum memory (MB)
+# If this is greater than `memory' then the slack will start ballooned
+# (this assumes guest kernel support for ballooning)
+#maxmem = 512
+
 # Number of VCPUS
 vcpus = 3
 
-- 
2.30.2

[PATCH 06/10] docs: xlexample.hvm: Add reference to nographic option

[Elliott Mitchell]

Running without any display device is a completely legal configuration.

Signed-off-by: Elliott Mitchell <ehem+xen@m5p.com>
---
 tools/examples/xlexample.hvm | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/tools/examples/xlexample.hvm b/tools/examples/xlexample.hvm
index a6cafcbf9f..7afb7c731d 100644
--- a/tools/examples/xlexample.hvm
+++ b/tools/examples/xlexample.hvm
@@ -42,6 +42,7 @@ vif = [ '' ]
 # docs/misc/xl-disk-configuration.txt
 disk = [ '/dev/vg/guest-volume,raw,xvda,rw' ]
 
-# Guest VGA console configuration, either SDL or VNC
+# Guest VGA console configuration, SDL, VNC, or none
 sdl = 1
 #vnc = 1
+#nographic = 1
-- 
2.30.2

[PATCH 07/10] docs: xlexample.pvhlinux: Make disk setting consistent with other examples

[Elliott Mitchell]

While storing images on ZFS is now quite common, such isn't required
at all.  As such the example should be as generic as possible and
consistent with other examples.

Signed-off-by: Elliott Mitchell <ehem+xen@m5p.com>
---
 tools/examples/xlexample.pvhlinux | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tools/examples/xlexample.pvhlinux b/tools/examples/xlexample.pvhlinux
index e1bf845093..a6a52c336c 100644
--- a/tools/examples/xlexample.pvhlinux
+++ b/tools/examples/xlexample.pvhlinux
@@ -44,4 +44,4 @@ vif = [ '' ]
 # Disk Devices
 # A list of `diskspec' entries as described in
 # docs/misc/xl-disk-configuration.txt
-disk = [ '/dev/zvol/tank/guest-volume,raw,xvda,rw' ]
+disk = [ '/dev/vg/guest-volume,raw,xvda,rw' ]
-- 
2.30.2

[PATCH 08/10] docs: xlexample.hvm: Fix grammmer

[Elliott Mitchell]

This is correct and makes comparing the files with `diff` easier.

Signed-off-by: Elliott Mitchell <ehem+xen@m5p.com>
---
 tools/examples/xlexample.hvm | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/tools/examples/xlexample.hvm b/tools/examples/xlexample.hvm
index 7afb7c731d..df82280531 100644
--- a/tools/examples/xlexample.hvm
+++ b/tools/examples/xlexample.hvm
@@ -2,10 +2,10 @@
 # Example HVM guest configuration
 # =====================================================================
 #
-# This is a fairly minimal example of what is required for an
+# This is a fairly minimal example of what is required for a
 # HVM guest. For a more complete guide see xl.cfg(5)
 
-# This configures an HVM rather than PV guest
+# This configures a HVM guest instead of PV or PVH
 type = "hvm"
 
 # Guest name
-- 
2.30.2

[PATCH 09/10] docs: xlexample.pvlinux: Add "type" setting

[Elliott Mitchell]

Some environments will prefer to explicitly include this setting
despite being the default.  This also increases consistency with other
examples.

Signed-off-by: Elliott Mitchell <ehem+xen@m5p.com>
---
 tools/examples/xlexample.pvlinux | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/tools/examples/xlexample.pvlinux b/tools/examples/xlexample.pvlinux
index be6931549a..19dac50fcd 100644
--- a/tools/examples/xlexample.pvlinux
+++ b/tools/examples/xlexample.pvlinux
@@ -5,6 +5,9 @@
 # This is a fairly minimal example of what is required for a
 # Paravirtualised Linux guest. For a more complete guide see xl.cfg(5)
 
+# This configures a PV guest instead of HVM or PVH
+#type = "pv"	# "pv" is default
+
 # Guest name
 name = "example.pvlinux"
 
-- 
2.30.2

[PATCH 10/10] docs: xlexample.pvhlinux: Use similar text to other examples

[Elliott Mitchell]

Simply making the word choice match the other examples.

Signed-off-by: Elliott Mitchell <ehem+xen@m5p.com>
---
 tools/examples/xlexample.pvhlinux | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tools/examples/xlexample.pvhlinux b/tools/examples/xlexample.pvhlinux
index a6a52c336c..7685fb67b6 100644
--- a/tools/examples/xlexample.pvhlinux
+++ b/tools/examples/xlexample.pvhlinux
@@ -5,7 +5,7 @@
 # This is a fairly minimal example of what is required for a
 # PVH Linux guest. For a more complete guide see xl.cfg(5)
 
-# This configures a PVH rather than PV guest
+# This configures a PVH guest instead of HVM or PV
 type = "pvh"
 
 # Guest name
-- 
2.30.2

[PATCH 05/10] docs: xlexample.hvm: Fix maxmem value

[Elliott Mitchell]

HVM doesn't balloon and so it makes no sense to specify maxmem.

Signed-off-by: Elliott Mitchell <ehem+xen@m5p.com>
---
 tools/examples/xlexample.hvm | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/tools/examples/xlexample.hvm b/tools/examples/xlexample.hvm
index 26ae1c2fb4..a6cafcbf9f 100644
--- a/tools/examples/xlexample.hvm
+++ b/tools/examples/xlexample.hvm
@@ -25,9 +25,9 @@ name = "example.hvm"
 memory = 384
 
 # Maximum memory (MB)
-# If this is greater than `memory' then the slack will start ballooned
-# (this assumes guest kernel support for ballooning)
-#maxmem = 512
+# Unlike PV or PVH, HVM cannot balloon memory and hence this should match
+# `memory' or simply be left unset.
+#maxmem =
 
 # Number of VCPUS
 vcpus = 3
-- 
2.30.2

[PATCH 00/10] Increase consistency of domain examples

[Elliott Mitchell]

The "xlexample.*" files have drifted apart rather distinctly.  This may
cause puzzlement at why the distinct choices were made.  Worse, I have an
unpleasant suspicion a naive user could benchmark with these files and
not realize performance differences were due to different settings, not
the domain type.

I chose 3 vCPUs and 384MB of memory.  This is in-between the values
currently in the examples.  I wonder whether I should have used the
values from pvhlinux as those may better reflect typical small VMs now.

Elliott Mitchell (10):
  docs: xlexample.hvm: Mention this isn't useful for other guests
  docs: xlexample.*: Use consistent vCPU count
  docs: xlexample.*: Use consistent initial memory
  docs: xlexample.pvhlinux: Add commented maxmem setting
  docs: xlexample.hvm: Fix maxmem value
  docs: xlexample.hvm: Add reference to nographic option
  docs: xlexample.pvhlinux: Make disk setting consistent with other
    examples
  docs: xlexample.hvm: Fix grammmer
  docs: xlexample.pvlinux: Add "type" setting
  docs: xlexample.pvhlinux: Use similar text to other examples

 tools/examples/xlexample.hvm      | 19 ++++++++++---------
 tools/examples/xlexample.pvhlinux | 13 +++++++++----
 tools/examples/xlexample.pvlinux  |  7 +++++--
 3 files changed, 24 insertions(+), 15 deletions(-)

-- 
2.30.2