From a4f030cf10683aa949550e9922c3ea72421cf392 Mon Sep 17 00:00:00 2001
From: Ludovic Beliveau <ludovic.beliveau@windriver.com>
Date: Tue, 10 May 2016 20:01:53 -0400
Subject: [PATCH] Doc: Update PCI configuration options

- Add more explanations of JSON keys.
- pci_alias is used by nova-api not nova-compute.
- device_id is not valid.  Replaced with vendor_id.

Change-Id: I3547f36e9f1bcede433d2ae034086fb0686c781d
---
 nova/conf/pci.py | 31 ++++++++++++++++++++++---------
 1 file changed, 22 insertions(+), 9 deletions(-)

diff --git a/nova/conf/pci.py b/nova/conf/pci.py
index 59c538d28581..b7f0865e8d18 100644
--- a/nova/conf/pci.py
+++ b/nova/conf/pci.py
@@ -42,10 +42,11 @@ Possible Values:
   defines an alias for the Intel QuickAssist card. (multi valued). Valid key
   values are :
 
-  * "name"
-  * "product_id"
-  * "vendor_id"
-  * "device_type"
+  * "name": Name of the PCI alias.
+  * "product_id": Product ID of the device in hexadecimal.
+  * "vendor_id": Vendor ID of the device in hexadecimal.
+  * "device_type": Type of PCI device. Valid values are: "type-PCI",
+    "type-PF" and "type-VF".
 """),
     cfg.MultiStrOpt('pci_passthrough_whitelist',
         default=[],
@@ -57,14 +58,26 @@ Possible values:
 * A JSON dictionary which describe a whitelisted PCI device. It should take
   the following format:
 
-    ["device_id": "<id>",] ["product_id": "<id>",]
+    ["vendor_id": "<id>",] ["product_id": "<id>",]
     ["address": "[[[[<domain>]:]<bus>]:][<slot>][.[<function>]]" |
-     "devname": "PCI Device Name",]
-    {"tag": "<tag_value>",}
+     "devname": "<name>",]
+    {"<tag>": "<tag_value>",}
 
-  where '[' indicates zero or one occurrences, '{' indicates zero or multiple
+  Where '[' indicates zero or one occurrences, '{' indicates zero or multiple
   occurrences, and '|' mutually exclusive options. Note that any missing
-  fields are automatically wildcarded. Valid examples are:
+  fields are automatically wildcarded.
+
+  Valid key values are :
+
+  * "vendor_id": Vendor ID of the device in hexadecimal.
+  * "product_id": Product ID of the device in hexadecimal.
+  * "address": PCI address of the device.
+  * "devname": Device name of the device (for e.g. interface name). Not all
+    PCI devices have a name.
+  * "<tag>": Additional <tag> and <tag_value> used for matching PCI devices.
+    Supported <tag>: "physical_network".
+
+  Valid examples are:
 
     pci_passthrough_whitelist = {"devname":"eth0",
                                  "physical_network":"physnet"}