Linux Documentation
 help / color / mirror / Atom feed
From: Bjorn Helgaas <helgaas@kernel.org>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	Bjorn Helgaas <bhelgaas@google.com>,
	linux-pci@vger.kernel.org
Subject: Re: [PATCH v4 12/19] docs: pci: endpoint/function/binding/pci-test.txt convert to ReST
Date: Fri, 1 May 2020 12:10:11 -0500	[thread overview]
Message-ID: <20200501171011.GA116051@bjorn-Precision-5520> (raw)
In-Reply-To: <fa73d1a7fb6c4691899a110a732216bcdac75f2b.1588263270.git.mchehab+huawei@kernel.org>

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@kernel.org>

Acked-by: Bjorn Helgaas <bhelgaas@google.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
> 

  reply	other threads:[~2020-05-01 17:10 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-04-30 16:18 [PATCH v4 00/19] Manually convert thermal, crypto and misc devices to ReST Mauro Carvalho Chehab
2020-04-30 16:18 ` [PATCH v4 01/19] docs: thermal: convert cpu-idle-cooling.rst " Mauro Carvalho Chehab
2020-04-30 16:18 ` [PATCH v4 02/19] docs: crypto: convert asymmetric-keys.txt " Mauro Carvalho Chehab
2020-04-30 16:18 ` [PATCH v4 03/19] docs: crypto: convert api-intro.txt to ReST format Mauro Carvalho Chehab
2020-04-30 16:18 ` [PATCH v4 04/19] docs: crypto: convert async-tx-api.txt " Mauro Carvalho Chehab
2020-04-30 16:18 ` [PATCH v4 05/19] docs: crypto: descore-readme.txt: convert " Mauro Carvalho Chehab
2020-04-30 16:18 ` [PATCH v4 06/19] docs: misc-devices/spear-pcie-gadget.txt: convert to ReST Mauro Carvalho Chehab
2020-04-30 16:18 ` [PATCH v4 07/19] docs: misc-devices/pci-endpoint-test.txt: " Mauro Carvalho Chehab
2020-04-30 16:18 ` [PATCH v4 08/19] " Mauro Carvalho Chehab
2020-04-30 16:18 ` [PATCH v4 09/19] docs: misc-devices/c2port.txt: convert to ReST format Mauro Carvalho Chehab
2020-04-30 16:18 ` [PATCH v4 10/19] docs: misc-devices/bh1770glc.txt: convert to ReST Mauro Carvalho Chehab
2020-04-30 16:18 ` [PATCH v4 11/19] docs: misc-devices/apds990x.txt: convert to ReST format Mauro Carvalho Chehab
2020-04-30 16:18 ` [PATCH v4 12/19] docs: pci: endpoint/function/binding/pci-test.txt convert to ReST Mauro Carvalho Chehab
2020-05-01 17:10   ` Bjorn Helgaas [this message]
2020-04-30 16:18 ` [PATCH v4 13/19] docs: arm64: convert perf.txt to ReST format Mauro Carvalho Chehab
2020-04-30 16:18 ` [PATCH v4 14/19] docs: powerpc: convert vcpudispatch_stats.txt to ReST Mauro Carvalho Chehab
2020-04-30 16:18 ` [PATCH v4 15/19] docs: sh: convert new-machine.txt " Mauro Carvalho Chehab
2020-04-30 16:18 ` [PATCH v4 16/19] docs: sh: convert register-banks.txt " Mauro Carvalho Chehab
2020-04-30 16:18 ` [PATCH v4 17/19] docs: trace: ring-buffer-design.txt: convert to ReST format Mauro Carvalho Chehab
2020-04-30 16:18 ` [PATCH v4 18/19] docs: kvm: get read of devices/README Mauro Carvalho Chehab
2020-04-30 16:18 ` [PATCH v4 19/19] docs: misc-devices: add uacce to the index.rst Mauro Carvalho Chehab

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=20200501171011.GA116051@bjorn-Precision-5520 \
    --to=helgaas@kernel.org \
    --cc=bhelgaas@google.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pci@vger.kernel.org \
    --cc=mchehab+huawei@kernel.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