Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
virtio: standardize Returns documentation style
Remove colons after "Returns" in virtio_map_ops function
documentation - both to avoid triggering an htmldoc warning
and for consistency with virtio_config_ops.
This affects map_page, alloc, need_sync, and max_mapping_size.
Fixes: bee8c7c24b73 ("virtio: introduce map ops in virtio core")
Message-Id: <c262893fa21f4b1265147ef864574a9bd173348f.1763026134.git.mst@redhat.com>
Acked-by: Jason Wang <jasowang@redhat.com>
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
+4
-4
+4
-4
include/linux/virtio_config.h
+4
-4
include/linux/virtio_config.h
···
150
150
* size: the buffer size
151
151
* dir: mapping direction
152
152
* attrs: mapping attributes
153
-
* Returns: the mapped address
153
+
* Returns the mapped address
154
154
* @unmap_page: unmap a buffer from the device
155
155
* map: device specific mapping map
156
156
* map_handle: the mapped address
···
172
172
* size: the size of the buffer
173
173
* map_handle: the mapping address to sync
174
174
* gfp: allocation flag (GFP_XXX)
175
-
* Returns: virtual address of the allocated buffer
175
+
* Returns virtual address of the allocated buffer
176
176
* @free: free a coherent buffer mapping
177
177
* map: metadata for performing mapping
178
178
* size: the size of the buffer
···
182
182
* @need_sync: if the buffer needs synchronization
183
183
* map: metadata for performing mapping
184
184
* map_handle: the mapped address
185
-
* Returns: whether the buffer needs synchronization
185
+
* Returns whether the buffer needs synchronization
186
186
* @mapping_error: if the mapping address is error
187
187
* map: metadata for performing mapping
188
188
* map_handle: the mapped address
189
189
* @max_mapping_size: get the maximum buffer size that can be mapped
190
190
* map: metadata for performing mapping
191
-
* Returns: the maximum buffer size that can be mapped
191
+
* Returns the maximum buffer size that can be mapped
192
192
*/
193
193
struct virtio_map_ops {
194
194
dma_addr_t (*map_page)(union virtio_map map, struct page *page,