Re: [RFC PATCH v2 1/2] printk-rb: add a new printk ringbuffer implementation

[Peter Zijlstra]

On Fri, Jun 07, 2019 at 06:29:48PM +0206, John Ogness wrote:
> +/**
> + * struct prb_descr - A descriptor representing an entry in the ringbuffer.
> + * @seq: The sequence number of the entry.
> + * @id: The descriptor id.
> + *      The location of the descriptor within the descriptor array can be 
> + *      determined from this value.
> + * @data: The logical position of the data for this entry.
> + *        The location of the beginning of the data within the data array
> + *        can be determined from this value.
> + * @data_next: The logical position of the data next to this entry.
> + *             This is used to determine the length of the data as well as
> + *             identify where the next data begins.
> + * @next: The id of the next (newer) descriptor in the linked list.
> + *        A value of EOL means it is the last descriptor in the list.
> + *

For the entire patch; can you please vertically align those
descriptions? This is unreadable. Also, add some whitespace, to aid with
reading, something like do:

 * struct prb_descr - A descriptor representing an entry in the ringbuffer.
 *
 * @seq:       The sequence number of the entry.
 *
 * @id:        The descriptor id.
 *             The location of the descriptor within the descriptor
 *             array can be determined from this value.
 *
 * @data:      The logical position of the data for this entry.  The
 *             location of the beginning of the data within the data
 *             array can be determined from this value.
 *
 * @data_next: The logical position of the data next to this entry.
 *             This is used to determine the length of the data as well as
 *             identify where the next data begins.
 *
 * @next:      The id of the next (newer) descriptor in the linked list.
 *             A value of EOL means it is the last descriptor in the
 *             list.