From: peter@bikeshed.quignogs.org.uk
To: linux-doc@vger.kernel.org, netdev@vger.kernel.org
Cc: Russell King <linux@armlinux.org.uk>,
Andrew Lunn <andrew@lunn.ch>,
Florian Fainelli <f.fainelli@gmail.com>,
Heiner Kallweit <hkallweit1@gmail.com>,
Jonathan Corbet <corbet@lwn.net>,
linux-kernel@vger.kernel.org,
Peter Lister <peter@bikeshed.quignogs.org.uk>
Subject: [PATCH 1/1] Reformat return value descriptions as ReST lists.
Date: Wed, 11 Mar 2020 19:28:23 +0000 [thread overview]
Message-ID: <20200311192823.16213-2-peter@bikeshed.quignogs.org.uk> (raw)
In-Reply-To: <20200311192823.16213-1-peter@bikeshed.quignogs.org.uk>
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
next prev parent reply other threads:[~2020-03-11 19:34 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-03-11 19:28 [PATCH 0/1] Convert text to ReST list and remove doc build warnings peter
2020-03-11 19:28 ` peter [this message]
2020-03-11 20:38 ` [PATCH 1/1] Reformat return value descriptions as ReST lists Russell King - ARM Linux admin
2020-03-11 22:21 ` Peter Lister
2020-03-11 22:25 ` Russell King - ARM Linux admin
2020-03-12 0:49 ` Matthew Wilcox
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=20200311192823.16213-2-peter@bikeshed.quignogs.org.uk \
--to=peter@bikeshed.quignogs.org.uk \
--cc=andrew@lunn.ch \
--cc=corbet@lwn.net \
--cc=f.fainelli@gmail.com \
--cc=hkallweit1@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@armlinux.org.uk \
--cc=netdev@vger.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
all inboxes | Powered by JetHome®