]> Git Repo - J-linux.git/commitdiff
slimbus: Fix struct and documentation alignment in stream.c
authorAmit Vadhavana <[email protected]>
Fri, 5 Jul 2024 08:02:34 +0000 (09:02 +0100)
committerGreg Kroah-Hartman <[email protected]>
Fri, 5 Jul 2024 08:13:04 +0000 (10:13 +0200)
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 <[email protected]>
Reviewed-by: Ricardo B. Marliere <[email protected]>
Signed-off-by: Srinivas Kandagatla <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Greg Kroah-Hartman <[email protected]>
drivers/slimbus/stream.c

index 1d6b38657917380d878a4c956bbaf4b9634fa6bc..863ab3075d7eb1fcaa93327f8e3c3eeeec6a256c 100644 (file)
  *             and the first slot of the next  consecutive Segment.
  * @segdist_code: Segment Distribution Code SD[11:0]
  * @seg_offset_mask: Segment offset mask in SD[11:0]
- * @segdist_codes: List of all possible Segmet Distribution codes.
  */
-static const struct segdist_code {
+struct segdist_code {
        int ratem;
        int seg_interval;
        int segdist_code;
        u32 seg_offset_mask;
 
-} segdist_codes[] = {
+};
+
+/* segdist_codes - List of all possible Segment Distribution codes. */
+static const struct segdist_code segdist_codes[] = {
        {1,     1536,   0x200,   0xdff},
        {2,     768,    0x100,   0xcff},
        {4,     384,    0x080,   0xc7f},
This page took 0.050335 seconds and 4 git commands to generate.