linux-kernel - [PATCH 1/1] Reformat return value descriptions as ReST lists.

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] [thread-next>] [day] [month] [year] [list]

Date:   Wed, 11 Mar 2020 19:28:23 +0000
From:   peter@...eshed.quignogs.org.uk
To:     linux-doc@...r.kernel.org, netdev@...r.kernel.org
Cc:     Russell King <linux@...linux.org.uk>, Andrew Lunn <andrew@...n.ch>,
        Florian Fainelli <f.fainelli@...il.com>,
        Heiner Kallweit <hkallweit1@...il.com>,
        Jonathan Corbet <corbet@....net>, linux-kernel@...r.kernel.org,
        Peter Lister <peter@...eshed.quignogs.org.uk>
Subject: [PATCH 1/1] Reformat return value descriptions as ReST lists.

From: Peter Lister <peter@...eshed.quignogs.org.uk>

Added line breaks and blank lines to separate list items and escaped end-of-line
colons.

This removes these warnings from doc build...

./drivers/net/phy/sfp-bus.c:579: WARNING: Unexpected indentation.
./drivers/net/phy/sfp-bus.c:619: WARNING: Unexpected indentation.

Signed-off-by: Peter Lister <peter@...eshed.quignogs.org.uk>
---
 drivers/net/phy/sfp-bus.c | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/drivers/net/phy/sfp-bus.c b/drivers/net/phy/sfp-bus.c
index d949ea7b4f8c..df1c66df830f 100644
--- a/drivers/net/phy/sfp-bus.c
+++ b/drivers/net/phy/sfp-bus.c
@@ -572,12 +572,18 @@ static void sfp_upstream_clear(struct sfp_bus *bus)
  * the sfp_bus structure, incrementing its reference count.  This must
  * be put via sfp_bus_put() when done.
  *
- * Returns: on success, a pointer to the sfp_bus structure,
+ * Returns\:
+ *
+ *          on success, a pointer to the sfp_bus structure,
  *	    %NULL if no SFP is specified,
+ *
  * 	    on failure, an error pointer value:
+ *
  * 		corresponding to the errors detailed for
  * 		fwnode_property_get_reference_args().
+ *
  * 	        %-ENOMEM if we failed to allocate the bus.
+ *
  *		an error from the upstream's connect_phy() method.
  */
 struct sfp_bus *sfp_bus_find_fwnode(struct fwnode_handle *fwnode)
@@ -612,12 +618,18 @@ EXPORT_SYMBOL_GPL(sfp_bus_find_fwnode);
  * the SFP bus using sfp_register_upstream().  This takes a reference on the
  * bus, so it is safe to put the bus after this call.
  *
- * Returns: on success, a pointer to the sfp_bus structure,
+ * Returns\:
+ *
+ *          on success, a pointer to the sfp_bus structure,
  *	    %NULL if no SFP is specified,
+ *
  * 	    on failure, an error pointer value:
+ *
  * 		corresponding to the errors detailed for
  * 		fwnode_property_get_reference_args().
+ *
  * 	        %-ENOMEM if we failed to allocate the bus.
+ *
  *		an error from the upstream's connect_phy() method.
  */
 int sfp_bus_add_upstream(struct sfp_bus *bus, void *upstream,
-- 
2.24.1