| Message ID | 20200503214926.23748-1-bryce.steven.willey@gmail.com |
|---|---|
| State | New |
| Headers | show |
| Series | Documentation: PCI: gave unique labels to sections | expand |
s/gave/Give/ (in subject) On Sun, May 03, 2020 at 05:49:26PM -0400, Bryce Willey wrote: > From: Bryce Willey <Bryce.Steven.Willey@gmail.com> > > Made subsection label more specific to avoid sphinx warnings s/Made/Make/ s/label/labels/ s/warnings/warnings./ > Exact warning: > Documentation/PCI/endpoint/pci-endpoint.rst:208: WARNING: duplicate label > pci/endpoint/pci-endpoint:other apis, other instance in Documentation/PCI/endpoint/pci-endpoint.rst > > Signed-off-by: Bryce Willey <Bryce.Steven.Willey@gmail.com> I assume Lorenzo will pick this up, since he's merged most of the recent Documentation/PCI/endpoint changes, and he'll likely fix the nits above. FWIW, Acked-by: Bjorn Helgaas <bhelgaas@google.com> > --- > Documentation/PCI/endpoint/pci-endpoint.rst | 16 ++++++++-------- > 1 file changed, 8 insertions(+), 8 deletions(-) > > diff --git a/Documentation/PCI/endpoint/pci-endpoint.rst b/Documentation/PCI/endpoint/pci-endpoint.rst > index 0e2311b5617b..7536be445db8 100644 > --- a/Documentation/PCI/endpoint/pci-endpoint.rst > +++ b/Documentation/PCI/endpoint/pci-endpoint.rst > @@ -78,8 +78,8 @@ by the PCI controller driver. > Cleanup the pci_epc_mem structure allocated during pci_epc_mem_init(). > > > -APIs for the PCI Endpoint Function Driver > -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > +EPC APIs for the PCI Endpoint Function Driver > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > > This section lists the APIs that the PCI Endpoint core provides to be used > by the PCI endpoint function driver. > @@ -117,8 +117,8 @@ by the PCI endpoint function driver. > The PCI endpoint function driver should use pci_epc_mem_free_addr() to > free the memory space allocated using pci_epc_mem_alloc_addr(). > > -Other APIs > -~~~~~~~~~~ > +Other EPC APIs > +~~~~~~~~~~~~~~ > > There are other APIs provided by the EPC library. These are used for binding > the EPF device with EPC device. pci-ep-cfs.c can be used as reference for > @@ -160,8 +160,8 @@ PCI Endpoint Function(EPF) Library > The EPF library provides APIs to be used by the function driver and the EPC > library to provide endpoint mode functionality. > > -APIs for the PCI Endpoint Function Driver > -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > +EPF APIs for the PCI Endpoint Function Driver > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > > This section lists the APIs that the PCI Endpoint core provides to be used > by the PCI endpoint function driver. > @@ -204,8 +204,8 @@ by the PCI endpoint controller library. > The PCI endpoint controller library invokes pci_epf_linkup() when the > EPC device has established the connection to the host. > > -Other APIs > -~~~~~~~~~~ > +Other EPF APIs > +~~~~~~~~~~~~~~ > > There are other APIs provided by the EPF library. These are used to notify > the function driver when the EPF device is bound to the EPC device. > -- > 2.17.1 >
On Sun, 3 May 2020 17:49:26 -0400, Bryce Willey wrote: > From: Bryce Willey <Bryce.Steven.Willey@gmail.com> > > Made subsection label more specific to avoid sphinx warnings > > Exact warning: > Documentation/PCI/endpoint/pci-endpoint.rst:208: WARNING: duplicate label > pci/endpoint/pci-endpoint:other apis, other instance in Documentation/PCI/endpoint/pci-endpoint.rst > > Signed-off-by: Bryce Willey <Bryce.Steven.Willey@gmail.com> > --- > Documentation/PCI/endpoint/pci-endpoint.rst | 16 ++++++++-------- > 1 file changed, 8 insertions(+), 8 deletions(-) > Acked-by: Rob Herring <robh@kernel.org>
On Sun, May 03, 2020 at 05:49:26PM -0400, Bryce Willey wrote: > From: Bryce Willey <Bryce.Steven.Willey@gmail.com> > > Made subsection label more specific to avoid sphinx warnings > > Exact warning: > Documentation/PCI/endpoint/pci-endpoint.rst:208: WARNING: duplicate label > pci/endpoint/pci-endpoint:other apis, other instance in Documentation/PCI/endpoint/pci-endpoint.rst > > Signed-off-by: Bryce Willey <Bryce.Steven.Willey@gmail.com> > --- > Documentation/PCI/endpoint/pci-endpoint.rst | 16 ++++++++-------- > 1 file changed, 8 insertions(+), 8 deletions(-) Applied changes requested and merged in pci/misc, thanks. Lorenzo > diff --git a/Documentation/PCI/endpoint/pci-endpoint.rst b/Documentation/PCI/endpoint/pci-endpoint.rst > index 0e2311b5617b..7536be445db8 100644 > --- a/Documentation/PCI/endpoint/pci-endpoint.rst > +++ b/Documentation/PCI/endpoint/pci-endpoint.rst > @@ -78,8 +78,8 @@ by the PCI controller driver. > Cleanup the pci_epc_mem structure allocated during pci_epc_mem_init(). > > > -APIs for the PCI Endpoint Function Driver > -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > +EPC APIs for the PCI Endpoint Function Driver > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > > This section lists the APIs that the PCI Endpoint core provides to be used > by the PCI endpoint function driver. > @@ -117,8 +117,8 @@ by the PCI endpoint function driver. > The PCI endpoint function driver should use pci_epc_mem_free_addr() to > free the memory space allocated using pci_epc_mem_alloc_addr(). > > -Other APIs > -~~~~~~~~~~ > +Other EPC APIs > +~~~~~~~~~~~~~~ > > There are other APIs provided by the EPC library. These are used for binding > the EPF device with EPC device. pci-ep-cfs.c can be used as reference for > @@ -160,8 +160,8 @@ PCI Endpoint Function(EPF) Library > The EPF library provides APIs to be used by the function driver and the EPC > library to provide endpoint mode functionality. > > -APIs for the PCI Endpoint Function Driver > -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > +EPF APIs for the PCI Endpoint Function Driver > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > > This section lists the APIs that the PCI Endpoint core provides to be used > by the PCI endpoint function driver. > @@ -204,8 +204,8 @@ by the PCI endpoint controller library. > The PCI endpoint controller library invokes pci_epf_linkup() when the > EPC device has established the connection to the host. > > -Other APIs > -~~~~~~~~~~ > +Other EPF APIs > +~~~~~~~~~~~~~~ > > There are other APIs provided by the EPF library. These are used to notify > the function driver when the EPF device is bound to the EPC device. > -- > 2.17.1 >
diff --git a/Documentation/PCI/endpoint/pci-endpoint.rst b/Documentation/PCI/endpoint/pci-endpoint.rst index 0e2311b5617b..7536be445db8 100644 --- a/Documentation/PCI/endpoint/pci-endpoint.rst +++ b/Documentation/PCI/endpoint/pci-endpoint.rst @@ -78,8 +78,8 @@ by the PCI controller driver. Cleanup the pci_epc_mem structure allocated during pci_epc_mem_init(). -APIs for the PCI Endpoint Function Driver -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +EPC APIs for the PCI Endpoint Function Driver +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This section lists the APIs that the PCI Endpoint core provides to be used by the PCI endpoint function driver. @@ -117,8 +117,8 @@ by the PCI endpoint function driver. The PCI endpoint function driver should use pci_epc_mem_free_addr() to free the memory space allocated using pci_epc_mem_alloc_addr(). -Other APIs -~~~~~~~~~~ +Other EPC APIs +~~~~~~~~~~~~~~ There are other APIs provided by the EPC library. These are used for binding the EPF device with EPC device. pci-ep-cfs.c can be used as reference for @@ -160,8 +160,8 @@ PCI Endpoint Function(EPF) Library The EPF library provides APIs to be used by the function driver and the EPC library to provide endpoint mode functionality. -APIs for the PCI Endpoint Function Driver -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +EPF APIs for the PCI Endpoint Function Driver +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This section lists the APIs that the PCI Endpoint core provides to be used by the PCI endpoint function driver. @@ -204,8 +204,8 @@ by the PCI endpoint controller library. The PCI endpoint controller library invokes pci_epf_linkup() when the EPC device has established the connection to the host. -Other APIs -~~~~~~~~~~ +Other EPF APIs +~~~~~~~~~~~~~~ There are other APIs provided by the EPF library. These are used to notify the function driver when the EPF device is bound to the EPC device.