diff mbox series

[v2] docs: pcie: Spell out machine type needs for PCIe features

Message ID 20180219163131.31153-1-kchamart@redhat.com
State New
Headers show
Series [v2] docs: pcie: Spell out machine type needs for PCIe features | expand

Commit Message

Kashyap Chamarthy Feb. 19, 2018, 4:31 p.m. UTC
PCIe features are available only via the 'q35' machine type for x86 and
the 'virt' machine type for AArch64 architecture.

Mention that explicitly.

Thanks: Daniel Berrangé

Signed-off-by: Kashyap Chamarthy <kchamart@redhat.com>
---
 docs/pcie.txt | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

Comments

Daniel P. Berrangé Feb. 19, 2018, 4:33 p.m. UTC | #1
On Mon, Feb 19, 2018 at 05:31:31PM +0100, Kashyap Chamarthy wrote:
> PCIe features are available only via the 'q35' machine type for x86 and
> the 'virt' machine type for AArch64 architecture.
> 
> Mention that explicitly.
> 
> Thanks: Daniel Berrangé
> 
> Signed-off-by: Kashyap Chamarthy <kchamart@redhat.com>
> ---
>  docs/pcie.txt | 9 +++++++--
>  1 file changed, 7 insertions(+), 2 deletions(-)
> 
> diff --git a/docs/pcie.txt b/docs/pcie.txt
> index 8d3694970e..89e3502075 100644
> --- a/docs/pcie.txt
> +++ b/docs/pcie.txt
> @@ -3,8 +3,13 @@ PCI EXPRESS GUIDELINES
>  
>  1. Introduction
>  ================
> -The doc proposes best practices on how to use PCI Express/PCI device
> -in PCI Express based machines and explains the reasoning behind them.
> +The doc proposes best practices on how to use PCI Express (PCIe) / PCI
> +devices in PCI Express based machines and explains the reasoning behind
> +them.
> +
> +Note that the PCIe features are available only when using the 'q35'
> +machine type on x86 architecture and the 'virt' machine type on AArch64.
> +Other machine types do not use PCIe at this time.
>  
>  The following presentations accompany this document:
>   (1) Q35 overview.

Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>

Regards,
Daniel
Marcel Apfelbaum Feb. 19, 2018, 5:39 p.m. UTC | #2
On 19/02/2018 18:31, Kashyap Chamarthy wrote:
> PCIe features are available only via the 'q35' machine type for x86 and
> the 'virt' machine type for AArch64 architecture.
> 
> Mention that explicitly.

Thanks for the improvement

Reviewed-by: Marcel Apfelbaum <marcel@redhat.com>

Thanks,
Marcel

> 
> Thanks: Daniel Berrangé
> 
> Signed-off-by: Kashyap Chamarthy <kchamart@redhat.com>
> ---
>  docs/pcie.txt | 9 +++++++--
>  1 file changed, 7 insertions(+), 2 deletions(-)
> 
> diff --git a/docs/pcie.txt b/docs/pcie.txt
> index 8d3694970e..89e3502075 100644
> --- a/docs/pcie.txt
> +++ b/docs/pcie.txt
> @@ -3,8 +3,13 @@ PCI EXPRESS GUIDELINES
>  
>  1. Introduction
>  ================
> -The doc proposes best practices on how to use PCI Express/PCI device
> -in PCI Express based machines and explains the reasoning behind them.
> +The doc proposes best practices on how to use PCI Express (PCIe) / PCI
> +devices in PCI Express based machines and explains the reasoning behind
> +them.
> +
> +Note that the PCIe features are available only when using the 'q35'
> +machine type on x86 architecture and the 'virt' machine type on AArch64.
> +Other machine types do not use PCIe at this time.
>  
>  The following presentations accompany this document:
>   (1) Q35 overview.
>
diff mbox series

Patch

diff --git a/docs/pcie.txt b/docs/pcie.txt
index 8d3694970e..89e3502075 100644
--- a/docs/pcie.txt
+++ b/docs/pcie.txt
@@ -3,8 +3,13 @@  PCI EXPRESS GUIDELINES
 
 1. Introduction
 ================
-The doc proposes best practices on how to use PCI Express/PCI device
-in PCI Express based machines and explains the reasoning behind them.
+The doc proposes best practices on how to use PCI Express (PCIe) / PCI
+devices in PCI Express based machines and explains the reasoning behind
+them.
+
+Note that the PCIe features are available only when using the 'q35'
+machine type on x86 architecture and the 'virt' machine type on AArch64.
+Other machine types do not use PCIe at this time.
 
 The following presentations accompany this document:
  (1) Q35 overview.