linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Suzuki K Poulose <suzuki.poulose@arm.com>
To: gregkh@linuxfoundation.org
Cc: linux-kernel@vger.kernel.org, linux-next@vger.kernel.org,
	sfr@canb.auug.org.au, lkp@intel.com,
	Suzuki K Poulose <suzuki.poulose@arm.com>
Subject: [PATCH 3/3] drivers: Fix htmldocs warnings with bus_find_next_device()
Date: Thu,  1 Aug 2019 11:20:26 +0100	[thread overview]
Message-ID: <20190801102026.27312-3-suzuki.poulose@arm.com> (raw)
In-Reply-To: <20190801102026.27312-1-suzuki.poulose@arm.com>

Document the parameters for bus_find_next_device() to avoid
htmldocs build warnings as reported below :

include/linux/device.h:236: warning: Function parameter or member 'bus' not described in 'bus_find_next_device'
include/linux/device.h:236: warning: Function parameter or member 'cur' not described in 'bus_find_next_device'

Reported-by: kbuild test robot <lkp@intel.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: Suzuki K Poulose <suzuki.poulose@arm.com>
---
 include/linux/device.h | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/include/linux/device.h b/include/linux/device.h
index b17548b94c3e..ea0238c73a9c 100644
--- a/include/linux/device.h
+++ b/include/linux/device.h
@@ -229,6 +229,8 @@ static inline struct device *bus_find_device_by_devt(struct bus_type *bus,
 /**
  * bus_find_next_device - Find the next device after a given device in a
  * given bus.
+ * @bus: bus type
+ * @cur: device to begin the search with.
  */
 static inline struct device *
 bus_find_next_device(struct bus_type *bus,struct device *cur)
-- 
2.21.0


  parent reply	other threads:[~2019-08-01 10:20 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-08-01  5:05 linux-next: build warning after merge of the driver-core tree Stephen Rothwell
2019-08-01  6:10 ` Greg KH
2019-08-01 10:20   ` [PATCH 1/3] i2c: Revert incorrect conversion to use generic helper Suzuki K Poulose
2019-08-01 10:20     ` [PATCH 2/3] drivers: Fix typo in parameter description for driver_find_device_by_acpi_dev Suzuki K Poulose
2019-08-01 10:20     ` Suzuki K Poulose [this message]
2019-08-01 13:54     ` [PATCH 1/3] i2c: Revert incorrect conversion to use generic helper Greg KH
2019-08-01 14:03       ` Suzuki K Poulose
2019-08-01 14:05         ` Greg KH

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=20190801102026.27312-3-suzuki.poulose@arm.com \
    --to=suzuki.poulose@arm.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-next@vger.kernel.org \
    --cc=lkp@intel.com \
    --cc=sfr@canb.auug.org.au \
    /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;
as well as URLs for NNTP newsgroup(s).