OSDN Git Service

net: phy: sfp-bus.c: get rid of docs warnings
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Tue, 17 Mar 2020 14:54:19 +0000 (15:54 +0100)
committerDavid S. Miller <davem@davemloft.net>
Wed, 18 Mar 2020 06:39:29 +0000 (23:39 -0700)
The indentation for the returned values are weird, causing those
warnings:

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

Use a list and change the identation for it to be properly
parsed by the documentation toolchain.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: David S. Miller <davem@davemloft.net>
drivers/net/phy/sfp-bus.c

index d949ea7..6900c68 100644 (file)
@@ -572,13 +572,15 @@ 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,
- *         %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.
+ * 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,13 +614,15 @@ 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,
- *         %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.
+ * 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,
                         const struct sfp_upstream_ops *ops)