lkml.org 
[lkml]   [2020]   [Mar]   [11]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
From
Subject[PATCH 1/1] Reformat return value descriptions as ReST lists.
Date
From: Peter Lister <peter@bikeshed.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@bikeshed.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
\
 
 \ /
  Last update: 2020-03-11 20:34    [W:0.077 / U:0.464 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site