From: Randy Dunlap <rd.dunlab@gmail.com>
To: linux1394-devel@lists.sourceforge.net
Cc: Stefan Richter <stefanr@s5r6.in-berlin.de>,
Takashi Sakamoto <o-takashi@sakamocchi.jp>,
linux-doc@vger.kernel.org, linux-scsi@vger.kernel.org,
Randy Dunlap <rdunlap@infradead.org>,
Andrew Morton <akpm@linux-foundation.org>,
"James E.J. Bottomley" <jejb@linux.vnet.ibm.com>,
"Martin K. Petersen" <martin.petersen@oracle.com>,
Jonathan Corbet <corbet@lwn.net>
Subject: [PATCH v4 3/5] FireWire: clean up core-transaction.c kernel-doc
Date: Tue, 4 Sep 2018 17:02:23 -0700 [thread overview]
Message-ID: <20180905000225.10733-4-rd.dunlab@gmail.com> (raw)
In-Reply-To: <20180905000225.10733-1-rd.dunlab@gmail.com>
From: Randy Dunlap <rdunlap@infradead.org>
Clean up kernel-doc warnings in <drivers/firewire/core-transaction.c>
so that it can be added to a Firewire/IEEE 1394 driver-api chapter
without adding lots of noisy warnings to the documentation build.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Stefan Richter <stefanr@s5r6.in-berlin.de>
Cc: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Cc: linux-doc@vger.kernel.org
Cc: linux-scsi@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: "James E.J. Bottomley" <jejb@linux.vnet.ibm.com>
Cc: "Martin K. Petersen" <martin.petersen@oracle.com>
Cc: Jonathan Corbet <corbet@lwn.net>
---
drivers/firewire/core-transaction.c | 10 ++++++++++
1 file changed, 10 insertions(+)
--- linux-next-20180904.orig/drivers/firewire/core-transaction.c
+++ linux-next-20180904/drivers/firewire/core-transaction.c
@@ -410,6 +410,14 @@ static void transaction_callback(struct
/**
* fw_run_transaction() - send request and sleep until transaction is completed
+ * @card: card interface for this request
+ * @tcode: transaction code
+ * @destination_id: destination node ID, consisting of bus_ID and phy_ID
+ * @generation: bus generation in which request and response are valid
+ * @speed: transmission speed
+ * @offset: 48bit wide offset into destination's address space
+ * @payload: data payload for the request subaction
+ * @length: length of the payload, in bytes
*
* Returns the RCODE. See fw_send_request() for parameter documentation.
* Unlike fw_send_request(), @data points to the payload of the request or/and
@@ -604,6 +612,7 @@ EXPORT_SYMBOL(fw_core_add_address_handle
/**
* fw_core_remove_address_handler() - unregister an address handler
+ * @handler: callback
*
* To be called in process context.
*
@@ -828,6 +837,7 @@ EXPORT_SYMBOL(fw_send_response);
/**
* fw_get_request_speed() - returns speed at which the @request was received
+ * @request: firewire request data
*/
int fw_get_request_speed(struct fw_request *request)
{
WARNING: multiple messages have this Message-ID (diff)
From: Randy Dunlap <rd.dunlab@gmail.com>
To: linux1394-devel@lists.sourceforge.net
Cc: Jonathan Corbet <corbet@lwn.net>,
"James E.J. Bottomley" <jejb@linux.vnet.ibm.com>,
"Martin K. Petersen" <martin.petersen@oracle.com>,
linux-scsi@vger.kernel.org, linux-doc@vger.kernel.org,
Randy Dunlap <rdunlap@infradead.org>,
Andrew Morton <akpm@linux-foundation.org>
Subject: [PATCH v4 3/5] FireWire: clean up core-transaction.c kernel-doc
Date: Tue, 4 Sep 2018 17:02:23 -0700 [thread overview]
Message-ID: <20180905000225.10733-4-rd.dunlab@gmail.com> (raw)
In-Reply-To: <20180905000225.10733-1-rd.dunlab@gmail.com>
From: Randy Dunlap <rdunlap@infradead.org>
Clean up kernel-doc warnings in <drivers/firewire/core-transaction.c>
so that it can be added to a Firewire/IEEE 1394 driver-api chapter
without adding lots of noisy warnings to the documentation build.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Stefan Richter <stefanr@s5r6.in-berlin.de>
Cc: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Cc: linux-doc@vger.kernel.org
Cc: linux-scsi@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: "James E.J. Bottomley" <jejb@linux.vnet.ibm.com>
Cc: "Martin K. Petersen" <martin.petersen@oracle.com>
Cc: Jonathan Corbet <corbet@lwn.net>
---
drivers/firewire/core-transaction.c | 10 ++++++++++
1 file changed, 10 insertions(+)
--- linux-next-20180904.orig/drivers/firewire/core-transaction.c
+++ linux-next-20180904/drivers/firewire/core-transaction.c
@@ -410,6 +410,14 @@ static void transaction_callback(struct
/**
* fw_run_transaction() - send request and sleep until transaction is completed
+ * @card: card interface for this request
+ * @tcode: transaction code
+ * @destination_id: destination node ID, consisting of bus_ID and phy_ID
+ * @generation: bus generation in which request and response are valid
+ * @speed: transmission speed
+ * @offset: 48bit wide offset into destination's address space
+ * @payload: data payload for the request subaction
+ * @length: length of the payload, in bytes
*
* Returns the RCODE. See fw_send_request() for parameter documentation.
* Unlike fw_send_request(), @data points to the payload of the request or/and
@@ -604,6 +612,7 @@ EXPORT_SYMBOL(fw_core_add_address_handle
/**
* fw_core_remove_address_handler() - unregister an address handler
+ * @handler: callback
*
* To be called in process context.
*
@@ -828,6 +837,7 @@ EXPORT_SYMBOL(fw_send_response);
/**
* fw_get_request_speed() - returns speed at which the @request was received
+ * @request: firewire request data
*/
int fw_get_request_speed(struct fw_request *request)
{
------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
next prev parent reply other threads:[~2018-09-05 0:02 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-09-05 0:02 [PATCH v3 0/5] FireWire: clean up kernel-doc, add Documentation chapter Randy Dunlap
2018-09-05 0:02 ` Randy Dunlap
2018-09-05 0:02 ` [PATCH v4 1/5] FireWire: clean up firewire-cdev.h kernel-doc Randy Dunlap
2018-09-05 0:02 ` Randy Dunlap
2018-09-05 0:02 ` [PATCH v4 2/5] FireWire: clean up core-iso.c kernel-doc Randy Dunlap
2018-09-05 0:02 ` Randy Dunlap
2018-09-05 0:02 ` Randy Dunlap [this message]
2018-09-05 0:02 ` [PATCH v4 3/5] FireWire: clean up core-transaction.c kernel-doc Randy Dunlap
2018-09-05 0:02 ` [PATCH v4 4/5] FireWire: add a Documentation driver-api chapter Randy Dunlap
2018-09-05 0:02 ` Randy Dunlap
2018-09-05 0:02 ` [PATCH v4 5/5] FireWire: add driver-api Introduction section Randy Dunlap
2018-09-05 0:02 ` Randy Dunlap
2018-09-06 15:47 ` [PATCH v3 0/5] FireWire: clean up kernel-doc, add Documentation chapter Jonathan Corbet
2018-09-06 15:47 ` Jonathan Corbet
2018-09-15 14:59 ` Stefan Richter
2018-09-15 14:59 ` Stefan Richter
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=20180905000225.10733-4-rd.dunlab@gmail.com \
--to=rd.dunlab@gmail.com \
--cc=akpm@linux-foundation.org \
--cc=corbet@lwn.net \
--cc=jejb@linux.vnet.ibm.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-scsi@vger.kernel.org \
--cc=linux1394-devel@lists.sourceforge.net \
--cc=martin.petersen@oracle.com \
--cc=o-takashi@sakamocchi.jp \
--cc=rdunlap@infradead.org \
--cc=stefanr@s5r6.in-berlin.de \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.