Re: [PATCH v4 30/63] Documentation: PCI: convert acpi-info.txt to reST

[Mauro Carvalho Chehab]

Em Wed, 24 Apr 2019 00:28:59 +0800
Changbin Du <changbin.du@xxxxxxxxx> escreveu:

> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
> 
> Signed-off-by: Changbin Du <changbin.du@xxxxxxxxx>
> Acked-by: Bjorn Helgaas <bhelgaas@xxxxxxxxxx>
> ---
>  Documentation/PCI/{acpi-info.txt => acpi-info.rst} | 11 ++++++++---
>  Documentation/PCI/index.rst                        |  1 +
>  2 files changed, 9 insertions(+), 3 deletions(-)
>  rename Documentation/PCI/{acpi-info.txt => acpi-info.rst} (97%)
> 
> diff --git a/Documentation/PCI/acpi-info.txt b/Documentation/PCI/acpi-info.rst
> similarity index 97%
> rename from Documentation/PCI/acpi-info.txt
> rename to Documentation/PCI/acpi-info.rst
> index 3ffa3b03970e..f7dabb7ca255 100644
> --- a/Documentation/PCI/acpi-info.txt
> +++ b/Documentation/PCI/acpi-info.rst
> @@ -1,4 +1,8 @@
> -		ACPI considerations for PCI host bridges
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +========================================
> +ACPI considerations for PCI host bridges
> +========================================
>  
>  The general rule is that the ACPI namespace should describe everything the
>  OS might use unless there's another way for the OS to find it [1, 2].
> @@ -135,8 +139,9 @@ address always corresponds to bus 0, even if the bus range below the bridge
>  
>      Extended Address Space Descriptor (.4)
>      General Flags: Bit [0] Consumer/Producer:
> -	1âThis device consumes this resource
> -	0âThis device produces and consumes this resource
> +
> +        * 1 â This device consumes this resource
> +        * 0 â This device produces and consumes this resource

Hmm.. I think that you would need to add some extra blank lines before
the above, e. g., something like:

	[4] ACPI 6.2, sec 6.4.3.5.1, 2, 3, 4:
	    QWord/DWord/Word Address Space Descriptor (.1, .2, .3)
	      General Flags: Bit [0] Ignored
	
	    Extended Address Space Descriptor (.4)
	      General Flags: Bit [0] Consumer/Producer:

		* 1 â This device consumes this resource
		* 0 â This device produces and consumes this resource

>  
>  [5] ACPI 6.2, sec 19.6.43:
>      ResourceUsage specifies whether the Memory range is consumed by
> diff --git a/Documentation/PCI/index.rst b/Documentation/PCI/index.rst
> index 1b25bcc1edca..c877a369481d 100644
> --- a/Documentation/PCI/index.rst
> +++ b/Documentation/PCI/index.rst
> @@ -12,3 +12,4 @@ Linux PCI Bus Subsystem
>     PCIEBUS-HOWTO
>     pci-iov-howto
>     MSI-HOWTO
> +   acpi-info



Thanks,
Mauro