Commit 63969cf2 authored Jul 01, 2020 by Lee Jones Committed by Greg Kroah-Hartman Jul 01, 2020

misc: ibmasm: event: Demote function headers from kerneldoc

The correct format is not used and no attempt has been made
to document the function arguments. Makes sense to just demote
the header back down to a simple comment.

Fixes the following W=1 warnings:

drivers/misc/ibmasm/event.c:44: warning: Function parameter or member 'sp' not described in 'ibmasm_receive_event'
drivers/misc/ibmasm/event.c:44: warning: Function parameter or member 'data' not described in 'ibmasm_receive_event'
drivers/misc/ibmasm/event.c:44: warning: Function parameter or member 'data_size' not described in 'ibmasm_receive_event'
drivers/misc/ibmasm/event.c:78: warning: Function parameter or member 'sp' not described in 'ibmasm_get_next_event'
drivers/misc/ibmasm/event.c:78: warning: Function parameter or member 'reader' not described in 'ibmasm_get_next_event'

Cc: "Max Asböck" <amax@us.ibm.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20200701083118.45744-6-lee.jones@linaro.org

Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

parent 95ef32cd

drivers/misc/ibmasm/event.c

+2 −2

Original line number	Diff line number	Diff line
		@@ -31,7 +31,7 @@ static void wake_up_event_readers(struct service_processor *sp)
		wake_up_interruptible(&reader->wait);
		}

		/**
		/*
		* receive_event
		* Called by the interrupt handler when a dot command of type sp_event is
		* received.
		@@ -68,7 +68,7 @@ static inline int event_available(struct event_buffer b, struct event_reader r
		return (r->next_serial_number < b->next_serial_number);
		}

		/**
		/*
		* get_next_event
		* Called by event readers (initiated from user space through the file
		* system).