[PATCH] 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 --- drivers/slimbus/stream.c | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/drivers/slimbus/stream.c b/drivers/slimbus/stream.c index 1d6b38657917..62661211a409 100644 --- a/drivers/slimbus/stream.c +++ b/drivers/slimbus/stream.c @@ -18,7 +18,6 @@ * 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 { int ratem; @@ -26,7 +25,10 @@ static const struct segdist_code { 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},
Hi Amit,
kernel test robot noticed the following build warnings:
[auto build test WARNING on linus/master] [also build test WARNING on v6.10-rc3 next-20240613] [If your patch is applied to the wrong git tree, kindly drop us a note. And when submitting patch, we suggest to use '--base' as documented in https://git-scm.com/docs/git-format-patch#_base_tree_information]
url: https://github.com/intel-lab-lkp/linux/commits/Amit-Vadhavana/slimbus-Fix-st... base: linus/master patch link: https://lore.kernel.org/r/20240616154531.38232-1-av2082000%40gmail.com patch subject: [PATCH] slimbus: Fix struct and documentation alignment in stream.c config: arc-randconfig-002-20240617 (https://download.01.org/0day-ci/archive/20240617/202406170228.1TcJ2eGD-lkp@i...) compiler: arceb-elf-gcc (GCC) 13.2.0 reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20240617/202406170228.1TcJ2eGD-lkp@i...)
If you fix the issue in a separate patch/commit (i.e. not just a new version of the same patch/commit), kindly add following tags | Reported-by: kernel test robot lkp@intel.com | Closes: https://lore.kernel.org/oe-kbuild-all/202406170228.1TcJ2eGD-lkp@intel.com/
All warnings (new ones prefixed by >>):
drivers/slimbus/stream.c:28:1: warning: useless storage class specifier in empty declaration
28 | }; | ^
vim +28 drivers/slimbus/stream.c
11 12 /** 13 * struct segdist_code - Segment Distributions code from 14 * Table 20 of SLIMbus Specs Version 2.0 15 * 16 * @ratem: Channel Rate Multipler(Segments per Superframe) 17 * @seg_interval: Number of slots between the first Slot of Segment 18 * and the first slot of the next consecutive Segment. 19 * @segdist_code: Segment Distribution Code SD[11:0] 20 * @seg_offset_mask: Segment offset mask in SD[11:0] 21 */ 22 static const struct segdist_code { 23 int ratem; 24 int seg_interval; 25 int segdist_code; 26 u32 seg_offset_mask; 27
28 };
29
Hi Amit,
kernel test robot noticed the following build warnings:
[auto build test WARNING on linus/master] [also build test WARNING on v6.10-rc3 next-20240612] [If your patch is applied to the wrong git tree, kindly drop us a note. And when submitting patch, we suggest to use '--base' as documented in https://git-scm.com/docs/git-format-patch#_base_tree_information]
url: https://github.com/intel-lab-lkp/linux/commits/Amit-Vadhavana/slimbus-Fix-st... base: linus/master patch link: https://lore.kernel.org/r/20240616154531.38232-1-av2082000%40gmail.com patch subject: [PATCH] slimbus: Fix struct and documentation alignment in stream.c config: arm-randconfig-002-20240617 (https://download.01.org/0day-ci/archive/20240617/202406170201.Zh53W56G-lkp@i...) compiler: clang version 19.0.0git (https://github.com/llvm/llvm-project 78ee473784e5ef6f0b19ce4cb111fb6e4d23c6b2) reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20240617/202406170201.Zh53W56G-lkp@i...)
If you fix the issue in a separate patch/commit (i.e. not just a new version of the same patch/commit), kindly add following tags | Reported-by: kernel test robot lkp@intel.com | Closes: https://lore.kernel.org/oe-kbuild-all/202406170201.Zh53W56G-lkp@intel.com/
All warnings (new ones prefixed by >>):
drivers/slimbus/stream.c:22:1: warning: 'static' ignored on this declaration [-Wmissing-declarations]
22 | static const struct segdist_code { | ^
drivers/slimbus/stream.c:22:8: warning: 'const' ignored on this declaration [-Wmissing-declarations]
22 | static const struct segdist_code { | ^ 2 warnings generated.
vim +/static +22 drivers/slimbus/stream.c
abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 11 abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 12 /** abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 13 * struct segdist_code - Segment Distributions code from abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 14 * Table 20 of SLIMbus Specs Version 2.0 abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 15 * abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 16 * @ratem: Channel Rate Multipler(Segments per Superframe) abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 17 * @seg_interval: Number of slots between the first Slot of Segment abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 18 * and the first slot of the next consecutive Segment. abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 19 * @segdist_code: Segment Distribution Code SD[11:0] abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 20 * @seg_offset_mask: Segment offset mask in SD[11:0] abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 21 */ abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 @22 static const struct segdist_code { abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 23 int ratem; abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 24 int seg_interval; abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 25 int segdist_code; abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 26 u32 seg_offset_mask; abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 27
participants (1)
-
Amit Vadhavana -
kernel test robot