All of lore.kernel.org
 help / color / mirror / Atom feed
From: David Kershner <david.kershner@unisys.com>
To: <corbet@lwn.net>, <tglx@linutronix.de>, <mingo@redhat.com>,
	<hpa@zytor.com>, <david.kershner@unisys.com>,
	<gregkh@linuxfoundation.org>, <erik.arfvidson@unisys.com>,
	<timothy.sell@unisys.com>, <hofrat@osadl.org>,
	<dzickus@redhat.com>, <jes.sorensen@redhat.com>,
	<alexander.curtin@unisys.com>, <janani.rvchndrn@gmail.com>,
	<sudipm.mukherjee@gmail.com>, <prarit@redhat.com>,
	<david.binder@unisys.com>, <nhorman@redhat.com>,
	<dan.j.williams@intel.com>, <linux-kernel@vger.kernel.org>,
	<linux-doc@vger.kernel.org>,
	<driverdev-devel@linuxdriverproject.org>,
	<sparmaintainer@unisys.com>
Subject: [PATCH v4 22/29] staging: unisys: visorbus: rectify kerneldoc comment for struct
Date: Wed, 8 Jun 2016 17:14:16 -0400	[thread overview]
Message-ID: <1465420463-24982-23-git-send-email-david.kershner@unisys.com> (raw)
In-Reply-To: <1465420463-24982-1-git-send-email-david.kershner@unisys.com>

From: David Binder <david.binder@unisys.com>

Fixes the kerneldoc comment for struct visor_device - the struct members
were not listed with the appropriate @ prefix.

Signed-off-by: David Binder <david.binder@unisys.com>
Signed-off-by: David Kershner <david.kershner@unisys.com>
---
 drivers/staging/unisys/include/visorbus.h | 34 +++++++++++++++----------------
 1 file changed, 17 insertions(+), 17 deletions(-)

diff --git a/drivers/staging/unisys/include/visorbus.h b/drivers/staging/unisys/include/visorbus.h
index 666a04e..c836c8d 100644
--- a/drivers/staging/unisys/include/visorbus.h
+++ b/drivers/staging/unisys/include/visorbus.h
@@ -121,33 +121,33 @@ struct visor_driver {
 /**
  * struct visor_device - A device type for things "plugged" into the visorbus
  * bus
- * visorchannel:		Points to the channel that the device is
+ * @visorchannel:		Points to the channel that the device is
  *				associated with.
- * channel_type_guid:		Identifies the channel type to the bus driver.
- * device:			Device struct meant for use by the bus driver
+ * @channel_type_guid:		Identifies the channel type to the bus driver.
+ * @device:			Device struct meant for use by the bus driver
  *				only.
- * list_all:			Used by the bus driver to enumerate devices.
- * timer:		        Timer fired periodically to do interrupt-type
+ * @list_all:			Used by the bus driver to enumerate devices.
+ * @timer:		        Timer fired periodically to do interrupt-type
  *				activity.
- * being_removed:		Indicates that the device is being removed from
+ * @being_removed:		Indicates that the device is being removed from
  *				the bus. Private bus driver use only.
- * visordriver_callback_lock:	Used by the bus driver to lock when handling
+ * @visordriver_callback_lock:	Used by the bus driver to lock when handling
  *				channel events.
- * pausing:			Indicates that a change towards a paused state.
+ * @pausing:			Indicates that a change towards a paused state.
  *				is in progress. Only modified by the bus driver.
- * resuming:			Indicates that a change towards a running state
+ * @resuming:			Indicates that a change towards a running state
  *				is in progress. Only modified by the bus driver.
- * chipset_bus_no:		Private field used by the bus driver.
- * chipset_dev_no:		Private field used the bus driver.
- * state:			Used to indicate the current state of the
+ * @chipset_bus_no:		Private field used by the bus driver.
+ * @chipset_dev_no:		Private field used the bus driver.
+ * @state:			Used to indicate the current state of the
  *				device.
- * inst:			Unique GUID for this instance of the device.
- * name:			Name of the device.
- * pending_msg_hdr:		For private use by bus driver to respond to
+ * @inst:			Unique GUID for this instance of the device.
+ * @name:			Name of the device.
+ * @pending_msg_hdr:		For private use by bus driver to respond to
  *				hypervisor requests.
- * vbus_hdr_info:		A pointer to header info. Private use by bus
+ * @vbus_hdr_info:		A pointer to header info. Private use by bus
  *				driver.
- * partition_uuid:		Indicates client partion id. This should be the
+ * @partition_uuid:		Indicates client partion id. This should be the
  *				same across all visor_devices in the current
  *				guest. Private use by bus driver only.
  */
-- 
1.9.1

WARNING: multiple messages have this Message-ID (diff)
From: David Kershner <david.kershner@unisys.com>
To: corbet@lwn.net, tglx@linutronix.de, mingo@redhat.com,
	hpa@zytor.com, david.kershner@unisys.com,
	gregkh@linuxfoundation.org, erik.arfvidson@unisys.com,
	timothy.sell@unisys.com, hofrat@osadl.org, dzickus@redhat.com,
	jes.sorensen@redhat.com, alexander.curtin@unisys.com,
	janani.rvchndrn@gmail.com, sudipm.mukherjee@gmail.com,
	prarit@redhat.com, david.binder@unisys.com, nhorman@redhat.com,
	dan.j.williams@intel.com, linux-kernel@vger.kernel.org,
	linux-doc@vger.kernel.org,
	driverdev-devel@linuxdriverproject.org,
	sparmaintainer@unisys.com
Subject: [PATCH v4 22/29] staging: unisys: visorbus: rectify kerneldoc comment for struct
Date: Wed, 8 Jun 2016 17:14:16 -0400	[thread overview]
Message-ID: <1465420463-24982-23-git-send-email-david.kershner@unisys.com> (raw)
In-Reply-To: <1465420463-24982-1-git-send-email-david.kershner@unisys.com>

From: David Binder <david.binder@unisys.com>

Fixes the kerneldoc comment for struct visor_device - the struct members
were not listed with the appropriate @ prefix.

Signed-off-by: David Binder <david.binder@unisys.com>
Signed-off-by: David Kershner <david.kershner@unisys.com>
---
 drivers/staging/unisys/include/visorbus.h | 34 +++++++++++++++----------------
 1 file changed, 17 insertions(+), 17 deletions(-)

diff --git a/drivers/staging/unisys/include/visorbus.h b/drivers/staging/unisys/include/visorbus.h
index 666a04e..c836c8d 100644
--- a/drivers/staging/unisys/include/visorbus.h
+++ b/drivers/staging/unisys/include/visorbus.h
@@ -121,33 +121,33 @@ struct visor_driver {
 /**
  * struct visor_device - A device type for things "plugged" into the visorbus
  * bus
- * visorchannel:		Points to the channel that the device is
+ * @visorchannel:		Points to the channel that the device is
  *				associated with.
- * channel_type_guid:		Identifies the channel type to the bus driver.
- * device:			Device struct meant for use by the bus driver
+ * @channel_type_guid:		Identifies the channel type to the bus driver.
+ * @device:			Device struct meant for use by the bus driver
  *				only.
- * list_all:			Used by the bus driver to enumerate devices.
- * timer:		        Timer fired periodically to do interrupt-type
+ * @list_all:			Used by the bus driver to enumerate devices.
+ * @timer:		        Timer fired periodically to do interrupt-type
  *				activity.
- * being_removed:		Indicates that the device is being removed from
+ * @being_removed:		Indicates that the device is being removed from
  *				the bus. Private bus driver use only.
- * visordriver_callback_lock:	Used by the bus driver to lock when handling
+ * @visordriver_callback_lock:	Used by the bus driver to lock when handling
  *				channel events.
- * pausing:			Indicates that a change towards a paused state.
+ * @pausing:			Indicates that a change towards a paused state.
  *				is in progress. Only modified by the bus driver.
- * resuming:			Indicates that a change towards a running state
+ * @resuming:			Indicates that a change towards a running state
  *				is in progress. Only modified by the bus driver.
- * chipset_bus_no:		Private field used by the bus driver.
- * chipset_dev_no:		Private field used the bus driver.
- * state:			Used to indicate the current state of the
+ * @chipset_bus_no:		Private field used by the bus driver.
+ * @chipset_dev_no:		Private field used the bus driver.
+ * @state:			Used to indicate the current state of the
  *				device.
- * inst:			Unique GUID for this instance of the device.
- * name:			Name of the device.
- * pending_msg_hdr:		For private use by bus driver to respond to
+ * @inst:			Unique GUID for this instance of the device.
+ * @name:			Name of the device.
+ * @pending_msg_hdr:		For private use by bus driver to respond to
  *				hypervisor requests.
- * vbus_hdr_info:		A pointer to header info. Private use by bus
+ * @vbus_hdr_info:		A pointer to header info. Private use by bus
  *				driver.
- * partition_uuid:		Indicates client partion id. This should be the
+ * @partition_uuid:		Indicates client partion id. This should be the
  *				same across all visor_devices in the current
  *				guest. Private use by bus driver only.
  */
-- 
1.9.1

  parent reply	other threads:[~2016-06-08 21:16 UTC|newest]

Thread overview: 70+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-06-08 21:13 [PATCH v4 00/29] Fixed issues raised by tglx, then move visorbus to drivers/virt David Kershner
2016-06-08 21:13 ` David Kershner
2016-06-08 21:13 ` [PATCH v4 01/29] staging: unisys: visorbus: remove return values for write_vbus functions David Kershner
2016-06-08 21:13   ` David Kershner
2016-06-08 21:13 ` [PATCH v4 02/29] staging: unisys: visorbus: check parahotplug_request_complete_result David Kershner
2016-06-08 21:13   ` David Kershner
2016-06-08 21:13 ` [PATCH v4 03/29] staging: unisys: visorbus: remove unused module parameters David Kershner
2016-06-08 21:13   ` David Kershner
2016-06-08 21:13 ` [PATCH v4 04/29] staging: unisys: visorbus: remove unused struct David Kershner
2016-06-08 21:13   ` David Kershner
2016-06-08 21:13 ` [PATCH v4 05/29] staging: unisys: visorbus: modify format string to match argument David Kershner
2016-06-08 21:13   ` David Kershner
2016-06-08 21:14 ` [PATCH v4 06/29] staging: unisys: visornic: Correct comment spelling mistake David Kershner
2016-06-08 21:14   ` David Kershner
2016-06-08 21:14 ` [PATCH v4 07/29] staging: unisys: include: Remove thread-related enum members David Kershner
2016-06-08 21:14   ` David Kershner
2016-06-08 21:14 ` [PATCH v4 08/29] staging: unisys: visorbus: removed unused periodic_test_workqueue David Kershner
2016-06-08 21:14   ` David Kershner
2016-06-08 21:14 ` [PATCH v4 09/29] staging: unisys: visorinput: remove unnecessary locking David Kershner
2016-06-08 21:14   ` David Kershner
2016-06-09  9:01   ` Thomas Gleixner
2016-06-09  9:01     ` Thomas Gleixner
2016-06-09 12:03     ` Sell, Timothy C
2016-06-09 12:03       ` Sell, Timothy C
2016-06-09 19:55       ` Thomas Gleixner
2016-06-09 19:55         ` Thomas Gleixner
2016-06-09 20:30         ` Sell, Timothy C
2016-06-09 20:30           ` Sell, Timothy C
2016-06-11  3:34         ` Sell, Timothy C
2016-06-11  3:34           ` Sell, Timothy C
2016-06-08 21:14 ` [PATCH v4 10/29] staging: unisys: visorbus: use kernel timer instead of workqueue David Kershner
2016-06-08 21:14   ` David Kershner
2016-06-08 21:14 ` [PATCH v4 11/29] staging: unisys: visorbus: remove periodic_work.h/.c David Kershner
2016-06-08 21:14   ` David Kershner
2016-06-08 21:14 ` [PATCH v4 12/29] staging: unisys: visorbus: Make visordriver_callback_lock a mutex David Kershner
2016-06-08 21:14   ` David Kershner
2016-06-08 21:14 ` [PATCH v4 13/29] staging: unisys: visorbus: Remove unnecessary EXPORT_SYMBOL statements David Kershner
2016-06-08 21:14   ` David Kershner
2016-06-08 21:14 ` [PATCH v4 14/29] staging: unisys: visorbus: Remove unused functions David Kershner
2016-06-08 21:14   ` David Kershner
2016-06-08 21:14 ` [PATCH v4 15/29] staging: unisys: Remove reference to unused STANDALONE_CLIENT David Kershner
2016-06-08 21:14   ` David Kershner
2016-06-08 21:14 ` [PATCH v4 16/29] staging: unisys: visorbus: remove unused parameter from function David Kershner
2016-06-08 21:14   ` David Kershner
2016-06-08 21:14 ` [PATCH v4 17/29] staging: unisys: visorbus: fix commenting in vbusdevinfo.h David Kershner
2016-06-08 21:14   ` David Kershner
2016-06-08 21:14 ` [PATCH v4 18/29] staging: unisys: visorbus: fix commenting in visorbus_main.c David Kershner
2016-06-08 21:14   ` David Kershner
2016-06-08 21:14 ` [PATCH v4 19/29] staging: unisys: visorbus: fix visorchannel.c comments David Kershner
2016-06-08 21:14   ` David Kershner
2016-06-08 21:14 ` [PATCH v4 20/29] staging: unisys: visorbus: Rectify commenting in visorchipset.c David Kershner
2016-06-08 21:14   ` David Kershner
2016-06-08 21:14 ` [PATCH v4 21/29] staging: unisys: visorbus: Move visorbus-unique functions to private header David Kershner
2016-06-08 21:14   ` David Kershner
2016-06-08 21:14 ` David Kershner [this message]
2016-06-08 21:14   ` [PATCH v4 22/29] staging: unisys: visorbus: rectify kerneldoc comment for struct David Kershner
2016-06-08 21:14 ` [PATCH v4 23/29] staging: unisys: visorbus: Remove notifier-related code from visorbus David Kershner
2016-06-08 21:14   ` David Kershner
2016-06-08 21:14 ` [PATCH v4 24/29] staging: unisys: visorbus: Rename function to follow existing convention David Kershner
2016-06-08 21:14   ` David Kershner
2016-06-08 21:14 ` [PATCH v4 25/29] staging: unisys: visorbus: fix visorbus_private.h comments David Kershner
2016-06-08 21:14   ` David Kershner
2016-06-08 21:14 ` [PATCH v4 26/29] staging: unisys: Move vbushelper.h to visorbus directory David Kershner
2016-06-08 21:14   ` David Kershner
2016-06-08 21:14 ` [PATCH v4 27/29] include: linux: visorbus: Add visorbus to include/linux directory David Kershner
2016-06-08 21:14   ` David Kershner
2016-06-08 21:14 ` [PATCH v4 28/29] Documentation: Move visorbus documentation from staging to Documentation/ David Kershner
2016-06-08 21:14   ` David Kershner
2016-06-08 21:14 ` [PATCH v4 29/29] drivers: Add visorbus to the drivers/virt directory David Kershner
2016-06-08 21:14   ` David Kershner

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=1465420463-24982-23-git-send-email-david.kershner@unisys.com \
    --to=david.kershner@unisys.com \
    --cc=alexander.curtin@unisys.com \
    --cc=corbet@lwn.net \
    --cc=dan.j.williams@intel.com \
    --cc=david.binder@unisys.com \
    --cc=driverdev-devel@linuxdriverproject.org \
    --cc=dzickus@redhat.com \
    --cc=erik.arfvidson@unisys.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=hofrat@osadl.org \
    --cc=hpa@zytor.com \
    --cc=janani.rvchndrn@gmail.com \
    --cc=jes.sorensen@redhat.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mingo@redhat.com \
    --cc=nhorman@redhat.com \
    --cc=prarit@redhat.com \
    --cc=sparmaintainer@unisys.com \
    --cc=sudipm.mukherjee@gmail.com \
    --cc=tglx@linutronix.de \
    --cc=timothy.sell@unisys.com \
    /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.