Netdev Archive on lore.kernel.org
 help / Atom feed
* [PATCH] Documentation: fix some freescale dpio-driver.rst warnings
@ 2019-02-11  6:32 Randy Dunlap
  2019-02-12  5:29 ` David Miller
  0 siblings, 1 reply; 2+ messages in thread
From: Randy Dunlap @ 2019-02-11  6:32 UTC (permalink / raw)
  To: netdev
  Cc: Stuart Yoder, Laurentiu Tudor, Ioana Radulescu, Madalin Bucur,
	David Miller, linux-doc

From: Randy Dunlap <rdunlap@infradead.org>

Fix markup warnings for one list by using correct list syntax.
Fix markup warnings for another list by using blank lines before the
list.

Documentation/networking/device_drivers/freescale/dpaa2/dpio-driver.rst:30: WARNING: Unexpected indentation.
Documentation/networking/device_drivers/freescale/dpaa2/dpio-driver.rst:143: WARNING: Unexpected indentation.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Stuart Yoder <stuyoder@gmail.com>
Cc: Laurentiu Tudor <laurentiu.tudor@nxp.com>
Cc: Ioana Radulescu <ruxandra.radulescu@nxp.com>
Cc: netdev@vger.kernel.org
Cc: Madalin Bucur <madalin.bucur@nxp.com>
---
This still leaves 2 other warnings that I don't yet see how to fix.

 Documentation/networking/device_drivers/freescale/dpaa2/dpio-driver.rst |   14 +++++-----
 1 file changed, 7 insertions(+), 7 deletions(-)

--- lnx-50-rc6.orig/Documentation/networking/device_drivers/freescale/dpaa2/dpio-driver.rst
+++ lnx-50-rc6/Documentation/networking/device_drivers/freescale/dpaa2/dpio-driver.rst
@@ -27,11 +27,12 @@ Driver Overview
 
 The DPIO driver is bound to DPIO objects discovered on the fsl-mc bus and
 provides services that:
-  A) allow other drivers, such as the Ethernet driver, to enqueue and dequeue
+
+  A. allow other drivers, such as the Ethernet driver, to enqueue and dequeue
      frames for their respective objects
-  B) allow drivers to register callbacks for data availability notifications
+  B. allow drivers to register callbacks for data availability notifications
      when data becomes available on a queue or channel
-  C) allow drivers to manage hardware buffer pools
+  C. allow drivers to manage hardware buffer pools
 
 The Linux DPIO driver consists of 3 primary components--
    DPIO object driver-- fsl-mc driver that manages the DPIO object
@@ -140,11 +141,10 @@ QBman portal interface (qbman-portal.c)
 
    The qbman-portal component provides APIs to do the low level hardware
    bit twiddling for operations such as:
-      -initializing Qman software portals
-
-      -building and sending portal commands
 
-      -portal interrupt configuration and processing
+      - initializing Qman software portals
+      - building and sending portal commands
+      - portal interrupt configuration and processing
 
    The qbman-portal APIs are not public to other drivers, and are
    only used by dpio-service.



^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] Documentation: fix some freescale dpio-driver.rst warnings
  2019-02-11  6:32 [PATCH] Documentation: fix some freescale dpio-driver.rst warnings Randy Dunlap
@ 2019-02-12  5:29 ` David Miller
  0 siblings, 0 replies; 2+ messages in thread
From: David Miller @ 2019-02-12  5:29 UTC (permalink / raw)
  To: rdunlap
  Cc: netdev, stuyoder, laurentiu.tudor, ruxandra.radulescu,
	madalin.bucur, linux-doc

From: Randy Dunlap <rdunlap@infradead.org>
Date: Sun, 10 Feb 2019 22:32:42 -0800

> From: Randy Dunlap <rdunlap@infradead.org>
> 
> Fix markup warnings for one list by using correct list syntax.
> Fix markup warnings for another list by using blank lines before the
> list.
> 
> Documentation/networking/device_drivers/freescale/dpaa2/dpio-driver.rst:30: WARNING: Unexpected indentation.
> Documentation/networking/device_drivers/freescale/dpaa2/dpio-driver.rst:143: WARNING: Unexpected indentation.
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Applied, thanks.

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, back to index

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-02-11  6:32 [PATCH] Documentation: fix some freescale dpio-driver.rst warnings Randy Dunlap
2019-02-12  5:29 ` David Miller

Netdev Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/netdev/0 netdev/git/0.git
	git clone --mirror https://lore.kernel.org/netdev/1 netdev/git/1.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 netdev netdev/ https://lore.kernel.org/netdev \
		netdev@vger.kernel.org netdev@archiver.kernel.org
	public-inbox-index netdev


Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.netdev


AGPL code for this site: git clone https://public-inbox.org/ public-inbox