linux-kernel - Re: [PATCH v4 12/19] docs: pci: endpoint/function/binding/pci-test.txt convert to ReST

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20200501171011.GA116051@bjorn-Precision-5520>
Date:   Fri, 1 May 2020 12:10:11 -0500
From:   Bjorn Helgaas <helgaas@...nel.org>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        Bjorn Helgaas <bhelgaas@...gle.com>, linux-pci@...r.kernel.org
Subject: Re: [PATCH v4 12/19] docs: pci:
 endpoint/function/binding/pci-test.txt convert to ReST

On Thu, Apr 30, 2020 at 06:18:26PM +0200, Mauro Carvalho Chehab wrote:
> Convert this file to ReST by adding a proper title to it and
> use the right markups for a table.
> 
> While here, add a SPDX header.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>

Acked-by: Bjorn Helgaas <bhelgaas@...gle.com>

> ---
>  .../endpoint/function/binding/pci-test.rst    | 26 +++++++++++++++++++
>  .../endpoint/function/binding/pci-test.txt    | 19 --------------
>  Documentation/PCI/endpoint/index.rst          |  2 ++
>  .../misc-devices/pci-endpoint-test.rst        |  2 +-
>  4 files changed, 29 insertions(+), 20 deletions(-)
>  create mode 100644 Documentation/PCI/endpoint/function/binding/pci-test.rst
>  delete mode 100644 Documentation/PCI/endpoint/function/binding/pci-test.txt
> 
> diff --git a/Documentation/PCI/endpoint/function/binding/pci-test.rst b/Documentation/PCI/endpoint/function/binding/pci-test.rst
> new file mode 100644
> index 000000000000..57ee866fb165
> --- /dev/null
> +++ b/Documentation/PCI/endpoint/function/binding/pci-test.rst
> @@ -0,0 +1,26 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +==========================
> +PCI Test Endpoint Function
> +==========================
> +
> +name: Should be "pci_epf_test" to bind to the pci_epf_test driver.
> +
> +Configurable Fields:
> +
> +================   ===========================================================
> +vendorid	   should be 0x104c
> +deviceid	   should be 0xb500 for DRA74x and 0xb501 for DRA72x
> +revid		   don't care
> +progif_code	   don't care
> +subclass_code	   don't care
> +baseclass_code	   should be 0xff
> +cache_line_size	   don't care
> +subsys_vendor_id   don't care
> +subsys_id	   don't care
> +interrupt_pin	   Should be 1 - INTA, 2 - INTB, 3 - INTC, 4 -INTD
> +msi_interrupts	   Should be 1 to 32 depending on the number of MSI interrupts
> +		   to test
> +msix_interrupts	   Should be 1 to 2048 depending on the number of MSI-X
> +		   interrupts to test
> +================   ===========================================================
> diff --git a/Documentation/PCI/endpoint/function/binding/pci-test.txt b/Documentation/PCI/endpoint/function/binding/pci-test.txt
> deleted file mode 100644
> index cd76ba47394b..000000000000
> --- a/Documentation/PCI/endpoint/function/binding/pci-test.txt
> +++ /dev/null
> @@ -1,19 +0,0 @@
> -PCI TEST ENDPOINT FUNCTION
> -
> -name: Should be "pci_epf_test" to bind to the pci_epf_test driver.
> -
> -Configurable Fields:
> -vendorid	 : should be 0x104c
> -deviceid	 : should be 0xb500 for DRA74x and 0xb501 for DRA72x
> -revid		 : don't care
> -progif_code	 : don't care
> -subclass_code	 : don't care
> -baseclass_code	 : should be 0xff
> -cache_line_size	 : don't care
> -subsys_vendor_id : don't care
> -subsys_id	 : don't care
> -interrupt_pin	 : Should be 1 - INTA, 2 - INTB, 3 - INTC, 4 -INTD
> -msi_interrupts	 : Should be 1 to 32 depending on the number of MSI interrupts
> -		   to test
> -msix_interrupts	 : Should be 1 to 2048 depending on the number of MSI-X
> -		   interrupts to test
> diff --git a/Documentation/PCI/endpoint/index.rst b/Documentation/PCI/endpoint/index.rst
> index d114ea74b444..4ca7439fbfc9 100644
> --- a/Documentation/PCI/endpoint/index.rst
> +++ b/Documentation/PCI/endpoint/index.rst
> @@ -11,3 +11,5 @@ PCI Endpoint Framework
>     pci-endpoint-cfs
>     pci-test-function
>     pci-test-howto
> +
> +   function/binding/pci-test
> diff --git a/Documentation/misc-devices/pci-endpoint-test.rst b/Documentation/misc-devices/pci-endpoint-test.rst
> index 26e5d9ba146b..4cf3f4433be7 100644
> --- a/Documentation/misc-devices/pci-endpoint-test.rst
> +++ b/Documentation/misc-devices/pci-endpoint-test.rst
> @@ -53,4 +53,4 @@ ioctl
>  	      Perform read tests. The size of the buffer should be passed
>  	      as argument.
>  
> -.. [1] Documentation/PCI/endpoint/function/binding/pci-test.txt
> +.. [1] Documentation/PCI/endpoint/function/binding/pci-test.rst
> -- 
> 2.25.4
>