aboutsummaryrefslogtreecommitdiffstats
path: root/docs/misc
diff options
context:
space:
mode:
authorAndrew Cooper <Andrew.Cooper3@citrix.com>2012-09-03 11:22:00 +0100
committerAndrew Cooper <Andrew.Cooper3@citrix.com>2012-09-03 11:22:00 +0100
commit6328e728f6d6589a10d7e9f97a47f566f63743c2 (patch)
tree00344d32350bf73641ab979c89e79dc9c1e39b61 /docs/misc
parent203fbef2fb5e60fe57347146ca20880aca6e5594 (diff)
downloadxen-6328e728f6d6589a10d7e9f97a47f566f63743c2.tar.gz
xen-6328e728f6d6589a10d7e9f97a47f566f63743c2.tar.bz2
xen-6328e728f6d6589a10d7e9f97a47f566f63743c2.zip
docs/command line: Clarify the behavior with invalid input.
Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com> Acked-by: Jan Beulich <jbeulich@suse.de> Committed-by: Ian Campbell <ian.campbell@citrix.com>
Diffstat (limited to 'docs/misc')
-rw-r--r--docs/misc/xen-command-line.markdown12
1 files changed, 10 insertions, 2 deletions
diff --git a/docs/misc/xen-command-line.markdown b/docs/misc/xen-command-line.markdown
index 5b49096205..659993178b 100644
--- a/docs/misc/xen-command-line.markdown
+++ b/docs/misc/xen-command-line.markdown
@@ -11,7 +11,8 @@ Hypervisor.
## Types of parameter
Most parameters take the form `option=value`. Different options on
-the command line should be space delimited.
+the command line should be space delimited. All options are case
+sensitive, as are all values unless explicitly noted.
### Boolean (`<boolean>`)
@@ -35,6 +36,9 @@ Disable x2apic support (if present)
Enable synchronous console mode
> `sync_console`
+Explicitly specifying any value other than those listed above is
+undefined, as is stacking a `no-` prefix with an explicit value.
+
### Integer (`<integer>`)
An integer parameter will default to decimal and may be prefixed with
@@ -42,6 +46,9 @@ a `-` for negative numbers. Alternatively, a hexadecimal number may be
used by prefixing the number with `0x`, or an octal number may be used
if a leading `0` is present.
+Providing a string which does not validly convert to an integer is
+undefined.
+
### Size (`<size>`)
A size parameter may be any integer, with a size suffix
@@ -51,7 +58,8 @@ A size parameter may be any integer, with a size suffix
* `K` or `k`: KiB (2^10)
* `B` or `b`: Bytes
-Without a size suffix, the default will be kilo.
+Without a size suffix, the default will be kilo. Providing a suffix
+other than those listed above is undefined.
### String