Remove redundant description, ensuring the documentation
accurately reflects the structure's members.
Signed-off-by: Abhishek Tamboli <[email protected]>
---
The documentation for struct segdist_code contained an
excess description for the member 'segdist_codes',
which is not a member of the struct but rather
an array of segdist_code structs.
drivers/slimbus/stream.c | 1 -
1 file changed, 1 deletion(-)
diff --git a/drivers/slimbus/stream.c b/drivers/slimbus/stream.c
index 1d6b38657917..9e7983507f19 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;
--
2.25.1
Hi Abhishek,
kernel test robot noticed the following build warnings:
[auto build test WARNING on linus/master]
[also build test WARNING on v6.9 next-20240517]
[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/Abhishek-Tamboli/Remove-redundant-description-in-struct-segdist_code/20240519-010020
base: linus/master
patch link: https://lore.kernel.org/r/20240518165840.29415-1-abhishektamboli9%40gmail.com
patch subject: [PATCH] Remove redundant description in struct segdist_code
config: i386-randconfig-141-20240519 (https://download.01.org/0day-ci/archive/20240519/[email protected]/config)
compiler: clang version 18.1.5 (https://github.com/llvm/llvm-project 617a15a9eac96088ae5e9134248d8236e34b91b1)
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20240519/[email protected]/reproduce)
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 <[email protected]>
| Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/
All warnings (new ones prefixed by >>):
>> drivers/slimbus/stream.c:48: warning: Function parameter or struct member 'segdist_codes' not described in 'segdist_code'
vim +48 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
abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 28 } segdist_codes[] = {
abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 29 {1, 1536, 0x200, 0xdff},
abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 30 {2, 768, 0x100, 0xcff},
abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 31 {4, 384, 0x080, 0xc7f},
abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 32 {8, 192, 0x040, 0xc3f},
abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 33 {16, 96, 0x020, 0xc1f},
abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 34 {32, 48, 0x010, 0xc0f},
abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 35 {64, 24, 0x008, 0xc07},
abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 36 {128, 12, 0x004, 0xc03},
abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 37 {256, 6, 0x002, 0xc01},
abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 38 {512, 3, 0x001, 0xc00},
abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 39 {3, 512, 0xe00, 0x1ff},
abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 40 {6, 256, 0xd00, 0x0ff},
abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 41 {12, 128, 0xc80, 0x07f},
abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 42 {24, 64, 0xc40, 0x03f},
abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 43 {48, 32, 0xc20, 0x01f},
abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 44 {96, 16, 0xc10, 0x00f},
abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 45 {192, 8, 0xc08, 0x007},
abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 46 {364, 4, 0xc04, 0x003},
abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 47 {768, 2, 0xc02, 0x001},
abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 @48 };
abb9c9b8b51ba5 Srinivas Kandagatla 2018-07-05 49
--
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki