Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

slimbus: Fix struct and documentation alignment in stream.c

The placement of the `segdist_codes` array documentation was corrected
to conform with kernel documentation guidelines. The `@segdist_codes`
was placed incorrectly within the struct `segdist_code` documentation
block, which led to a potential misinterpretation of the code structure.

The `segdist_codes` array documentation was moved outside the struct
block, and a separate comment block was provided for it. This change
ensures that clarity and proper alignment with kernel documentation
standards are maintained.

A kernel-doc warning was addressed:
./drivers/slimbus/stream.c:49: warning: Excess struct member 'segdist_codes' description in 'segdist_code'

Signed-off-by: Amit Vadhavana <av2082000@gmail.com>
Reviewed-by: Ricardo B. Marliere <ricardo@marliere.net>
Signed-off-by: Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
Link: https://lore.kernel.org/r/20240705080234.424587-2-srinivas.kandagatla@linaro.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Amit Vadhavana and committed by
Greg Kroah-Hartman
f7e46d45 c66c0e7c

+5 -3
+5 -3
drivers/slimbus/stream.c
··· 18 18 * and the first slot of the next consecutive Segment. 19 19 * @segdist_code: Segment Distribution Code SD[11:0] 20 20 * @seg_offset_mask: Segment offset mask in SD[11:0] 21 - * @segdist_codes: List of all possible Segmet Distribution codes. 22 21 */ 23 - static const struct segdist_code { 22 + struct segdist_code { 24 23 int ratem; 25 24 int seg_interval; 26 25 int segdist_code; 27 26 u32 seg_offset_mask; 28 27 29 - } segdist_codes[] = { 28 + }; 29 + 30 + /* segdist_codes - List of all possible Segment Distribution codes. */ 31 + static const struct segdist_code segdist_codes[] = { 30 32 {1, 1536, 0x200, 0xdff}, 31 33 {2, 768, 0x100, 0xcff}, 32 34 {4, 384, 0x080, 0xc7f},