xen-devel.lists.xenproject.org archive mirror
 help / color / mirror / Atom feed
From: Andrew Cooper <andrew.cooper3@citrix.com>
To: Xen-devel <xen-devel@lists.xen.org>
Cc: Stefano Stabellini <sstabellini@kernel.org>,
	Wei Liu <wei.liu2@citrix.com>,
	George Dunlap <George.Dunlap@eu.citrix.com>,
	Andrew Cooper <andrew.cooper3@citrix.com>,
	Ian Jackson <ian.jackson@eu.citrix.com>, Tim Deegan <tim@xen.org>,
	Jan Beulich <JBeulich@suse.com>
Subject: [PATCH] docs: Fix the markdown for the com{1, 2} keyword command line documentation
Date: Mon, 17 Jul 2017 14:58:22 +0100	[thread overview]
Message-ID: <1500299902-15180-1-git-send-email-andrew.cooper3@citrix.com> (raw)

No change in content.

Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
---
CC: George Dunlap <George.Dunlap@eu.citrix.com>
CC: Ian Jackson <ian.jackson@eu.citrix.com>
CC: Jan Beulich <JBeulich@suse.com>
CC: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
CC: Stefano Stabellini <sstabellini@kernel.org>
CC: Tim Deegan <tim@xen.org>
CC: Wei Liu <wei.liu2@citrix.com>
---
 docs/misc/xen-command-line.markdown | 48 +++++++++++++++++++------------------
 1 file changed, 25 insertions(+), 23 deletions(-)

diff --git a/docs/misc/xen-command-line.markdown b/docs/misc/xen-command-line.markdown
index 6eb5cfc..3f90c3b 100644
--- a/docs/misc/xen-command-line.markdown
+++ b/docs/misc/xen-command-line.markdown
@@ -336,31 +336,33 @@ will be considered a positional parameter.
 The syntax consists of
 com1=(comma-separated positional parameters),(comma separated name-value pairs)
 
-The accepted name keywords for name=value pairs are
- * `baud` - accepts integer baud rate (eg. 115200) or `auto`
- * `bridge`- Similar to bridge-bdf in positional parameters.
-             Used to determine the PCI bridge to access the UART device.
-             Notation is xx:xx.xx <bus>:<device>.<function>
- * `clock-hz`- accepts large integers to setup UART clock frequencies.
-               Do note - these values are multiplied by 16.
- * `data-bits` - integer between 5 and 8
- * `dev` - accepted values are `pci` OR `amt`. If this option
-           is used to specify if the serial device is pci-based. The io_base
-           cannot be specified when `dev=pci` or `dev=amt` is used.
- * `io-base` - accepts integer which specified IO base port for UART registers
- * `irq` - IRQ number to use
- * `parity` - accepted values are same as positional parameters
- * `port` - Used to specify which port the PCI serial device is located on
-            Notation is xx:xx.xx <bus>:<device>.<function>
- * `reg-shift` - register shifts required to set UART registers
- * `reg-width` - register width required to set UART registers
-                 (only accepts 1 and 4)
- * `stop-bits` - only accepts 1 or 2 for the number of stop bits
+The accepted name keywords for name=value pairs are:
+
+* `baud` - accepts integer baud rate (eg. 115200) or `auto`
+* `bridge`- Similar to bridge-bdf in positional parameters.
+            Used to determine the PCI bridge to access the UART device.
+            Notation is xx:xx.x `<bus>:<device>.<function>`
+* `clock-hz`- accepts large integers to setup UART clock frequencies.
+              Do note - these values are multiplied by 16.
+* `data-bits` - integer between 5 and 8
+* `dev` - accepted values are `pci` OR `amt`. If this option
+          is used to specify if the serial device is pci-based. The io_base
+          cannot be specified when `dev=pci` or `dev=amt` is used.
+* `io-base` - accepts integer which specified IO base port for UART registers
+* `irq` - IRQ number to use
+* `parity` - accepted values are same as positional parameters
+* `port` - Used to specify which port the PCI serial device is located on
+           Notation is xx:xx.x `<bus>:<device>.<function>`
+* `reg-shift` - register shifts required to set UART registers
+* `reg-width` - register width required to set UART registers
+                (only accepts 1 and 4)
+* `stop-bits` - only accepts 1 or 2 for the number of stop bits
 
 The following are examples of correct specifications:
-`com1=115200,8n1,0x3f8,4`
-`com1=115200,8n1,0x3f8,4,reg_width=4,reg_shift=2`
-`com1=baud=115200,parity=n,stop_bits=1,io_base=0x3f8,reg_width=4`
+
+    com1=115200,8n1,0x3f8,4
+    com1=115200,8n1,0x3f8,4,reg_width=4,reg_shift=2
+    com1=baud=115200,parity=n,stop_bits=1,io_base=0x3f8,reg_width=4
 
 ### conring\_size
 > `= <size>`
-- 
2.1.4


_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xen.org
https://lists.xen.org/xen-devel

             reply	other threads:[~2017-07-17 13:58 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-07-17 13:58 Andrew Cooper [this message]
2017-07-17 15:12 ` [PATCH] docs: Fix the markdown for the com{1, 2} keyword command line documentation Wei Liu

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1500299902-15180-1-git-send-email-andrew.cooper3@citrix.com \
    --to=andrew.cooper3@citrix.com \
    --cc=George.Dunlap@eu.citrix.com \
    --cc=JBeulich@suse.com \
    --cc=ian.jackson@eu.citrix.com \
    --cc=sstabellini@kernel.org \
    --cc=tim@xen.org \
    --cc=wei.liu2@citrix.com \
    --cc=xen-devel@lists.xen.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).