Message-ID: <0ece317b-74ae-4f15-bc28-d85972ef18b7@gmail.com>
Date: Thu, 11 Jul 2024 23:17:21 +0200
From: Mirsad Todorovac <mtodorovac69@...il.com>
To: Guenter Roeck <linux@...ck-us.net>,
 Linux Kernel Mailing List <linux-kernel@...r.kernel.org>
Cc: Jean Delvare <jdelvare@...e.com>, linux-hwmon@...r.kernel.org,
 "Johannes Cornelis Draaijer (datdenkikniet)" <jcdra1@...il.com>
Subject: Re: [PROBLEM linux-next] drivers/hwmon/aht10.c:224: warning: Function
 parameter or struct member 'data' not described in 'aht10_interval_write'



On 7/11/24 19:11, Guenter Roeck wrote:
> On 7/11/24 09:57, Mirsad Todorovac wrote:
>> Hi all,
>>
>> On the linux-next vanilla tree next-20240709, there is a lot of complaining about
>> code like these, which is not an error, but it seems like documentation lags behind
>> the [dynamic] source development.
>>
>> If you  are interested in reporting these to the respective maintainers and developers,
>> give me a ping.
>>
>> drivers/hwmon/aht10.c:224: warning: Function parameter or struct member 'data' not described in 'aht10_interval_write'
>> drivers/hwmon/aht10.c:224: warning: Function parameter or struct member 'val' not described in 'aht10_interval_write'
>> drivers/hwmon/aht10.c:235: warning: Function parameter or struct member 'data' not described in 'aht10_interval_read'
>> drivers/hwmon/aht10.c:235: warning: Function parameter or struct member 'val' not described in 'aht10_interval_read'
>> drivers/hwmon/aht10.c:244: warning: Function parameter or struct member 'data' not described in 'aht10_temperature1_read'
>> drivers/hwmon/aht10.c:244: warning: Function parameter or struct member 'val' not described in 'aht10_temperature1_read'
>> drivers/hwmon/aht10.c:259: warning: Function parameter or struct member 'data' not described in 'aht10_humidity1_read'
>> drivers/hwmon/aht10.c:259: warning: Function parameter or struct member 'val' not described in 'aht10_humidity1_read'
>>
> 
> I'll be happy to accept patches, but plain reports like this are just noise.
> 
> Guenter
> 

Hi, Mr. Guenter,

Thank you kindly for your reply.

I agree with you that it adds a lot traffic to the channel with little "signal" when compared to the "noise".

However, there is about a 100 such warnings from 26 modules, and I do not feel competent and equipped to
analyse all of these:

      1 arch/x86/entry/common.c
      1 arch/x86/kernel/apic/apic.c
      4 arch/x86/kernel/cpu/mtrr/amd.c
      1 arch/x86/kernel/cpu/mtrr/centaur.c
      1 arch/x86/mm/pat/memtype.c
     13 arch/x86/mm/pgtable.c
      1 block/blk-merge.c
      1 drivers/firmware/efi/libstub/efi-stub-helper.c
      8 drivers/hwmon/aht10.c
      2 drivers/hwtracing/intel_th/core.c
     10 drivers/hwtracing/intel_th/msu.c
     17 drivers/memstick/core/memstick.c
      2 drivers/pinctrl/pinctrl-aw9523.c
      2 drivers/tty/n_hdlc.c
      1 fs/bcachefs/io_write.c
      1 fs/gfs2/glock.c
      2 fs/gfs2/super.c
      6 fs/nilfs2/btnode.c
      7 fs/nilfs2/ioctl.c
      3 fs/nilfs2/super.c
      4 fs/ufs/inode.c
      2 kernel/reboot.c
      2 kernel/time/tick-broadcast.c
      5 lib/842/842_compress.c
      4 lib/842/842_decompress.c
      1 mm/page_counter.c

In particular, those are expanded as:

arch/x86/mm/pat/memtype.c:708: warning: Function parameter or struct member 'pfn' not described in 'pat_pfn_immune_to_uc_mtrr'
arch/x86/mm/pgtable.c:652: warning: Function parameter or struct member 'reserve' not described in 'reserve_top_address'
arch/x86/mm/pgtable.c:701: warning: Function parameter or struct member 'p4d' not described in 'p4d_set_huge'
arch/x86/mm/pgtable.c:701: warning: Function parameter or struct member 'addr' not described in 'p4d_set_huge'
arch/x86/mm/pgtable.c:701: warning: Function parameter or struct member 'prot' not described in 'p4d_set_huge'
arch/x86/mm/pgtable.c:711: warning: Function parameter or struct member 'p4d' not described in 'p4d_clear_huge'
arch/x86/mm/pgtable.c:728: warning: Function parameter or struct member 'pud' not described in 'pud_set_huge'
arch/x86/mm/pgtable.c:728: warning: Function parameter or struct member 'addr' not described in 'pud_set_huge'
arch/x86/mm/pgtable.c:728: warning: Function parameter or struct member 'prot' not described in 'pud_set_huge'
arch/x86/mm/pgtable.c:754: warning: Function parameter or struct member 'pmd' not described in 'pmd_set_huge'
arch/x86/mm/pgtable.c:754: warning: Function parameter or struct member 'addr' not described in 'pmd_set_huge'
arch/x86/mm/pgtable.c:754: warning: Function parameter or struct member 'prot' not described in 'pmd_set_huge'
arch/x86/mm/pgtable.c:781: warning: Function parameter or struct member 'pud' not described in 'pud_clear_huge'
arch/x86/mm/pgtable.c:796: warning: Function parameter or struct member 'pmd' not described in 'pmd_clear_huge'
arch/x86/entry/common.c:211: warning: Function parameter or struct member 'regs' not described in 'do_int80_emulation'
block/blk-merge.c:220: warning: Function parameter or struct member 'len' not described in 'get_max_segment_size'
lib/842/842_compress.c:479: warning: Function parameter or struct member 'in' not described in 'sw842_compress'
lib/842/842_compress.c:479: warning: Function parameter or struct member 'ilen' not described in 'sw842_compress'
lib/842/842_compress.c:479: warning: Function parameter or struct member 'out' not described in 'sw842_compress'
lib/842/842_compress.c:479: warning: Function parameter or struct member 'olen' not described in 'sw842_compress'
lib/842/842_compress.c:479: warning: Function parameter or struct member 'wmem' not described in 'sw842_compress'
lib/842/842_decompress.c:279: warning: Function parameter or struct member 'in' not described in 'sw842_decompress'
lib/842/842_decompress.c:279: warning: Function parameter or struct member 'ilen' not described in 'sw842_decompress'
lib/842/842_decompress.c:279: warning: Function parameter or struct member 'out' not described in 'sw842_decompress'
lib/842/842_decompress.c:279: warning: Function parameter or struct member 'olen' not described in 'sw842_decompress'
arch/x86/kernel/cpu/mtrr/amd.c:61: warning: Function parameter or struct member 'reg' not described in 'amd_set_mtrr'
arch/x86/kernel/cpu/mtrr/amd.c:61: warning: Function parameter or struct member 'base' not described in 'amd_set_mtrr'
arch/x86/kernel/cpu/mtrr/amd.c:61: warning: Function parameter or struct member 'size' not described in 'amd_set_mtrr'
arch/x86/kernel/cpu/mtrr/amd.c:61: warning: Function parameter or struct member 'type' not described in 'amd_set_mtrr'
arch/x86/kernel/cpu/mtrr/centaur.c:28: warning: Function parameter or struct member 'replace_reg' not described in 'centaur_get_free_region'
mm/page_counter.c:400: warning: Function parameter or struct member 'counter' not described in 'page_counter_calculate_protection'
drivers/pinctrl/pinctrl-aw9523.c:562: warning: Function parameter or struct member 'awi' not described in '_aw9523_gpio_get_multiple'
drivers/pinctrl/pinctrl-aw9523.c:562: warning: Function parameter or struct member 'mask' not described in '_aw9523_gpio_get_multiple'
arch/x86/kernel/apic/apic.c:2138: warning: Function parameter or struct member 'spurious_interrupt' not described in 'DEFINE_IDTENTRY_IRQ'
kernel/reboot.c:234: warning: Function parameter or struct member 'cmd' not described in 'do_kernel_restart'
kernel/reboot.c:965: warning: Function parameter or struct member 'poweroff_delay_ms' not described in 'hw_failure_emergency_poweroff'
kernel/time/tick-broadcast.c:1026: warning: Function parameter or struct member 'bc' not described in 'tick_broadcast_setup_oneshot'
kernel/time/tick-broadcast.c:1026: warning: Function parameter or struct member 'from_periodic' not described in 'tick_broadcast_setup_oneshot'
fs/ufs/inode.c:398: warning: Function parameter or struct member 'inode' not described in 'ufs_getfrag_block'
fs/ufs/inode.c:398: warning: Function parameter or struct member 'fragment' not described in 'ufs_getfrag_block'
fs/ufs/inode.c:398: warning: Function parameter or struct member 'bh_result' not described in 'ufs_getfrag_block'
fs/ufs/inode.c:398: warning: Function parameter or struct member 'create' not described in 'ufs_getfrag_block'
fs/nilfs2/btnode.c:175: warning: Function parameter or struct member 'btnc' not described in 'nilfs_btnode_prepare_change_key'
fs/nilfs2/btnode.c:175: warning: Function parameter or struct member 'ctxt' not described in 'nilfs_btnode_prepare_change_key'
fs/nilfs2/btnode.c:238: warning: Function parameter or struct member 'btnc' not described in 'nilfs_btnode_commit_change_key'
fs/nilfs2/btnode.c:238: warning: Function parameter or struct member 'ctxt' not described in 'nilfs_btnode_commit_change_key'
fs/nilfs2/btnode.c:278: warning: Function parameter or struct member 'btnc' not described in 'nilfs_btnode_abort_change_key'
fs/nilfs2/btnode.c:278: warning: Function parameter or struct member 'ctxt' not described in 'nilfs_btnode_abort_change_key'
fs/nilfs2/super.c:121: warning: Function parameter or struct member 'sb' not described in '__nilfs_error'
fs/nilfs2/super.c:121: warning: Function parameter or struct member 'function' not described in '__nilfs_error'
fs/nilfs2/super.c:121: warning: Function parameter or struct member 'fmt' not described in '__nilfs_error'
fs/nilfs2/ioctl.c:120: warning: Function parameter or struct member 'dentry' not described in 'nilfs_fileattr_get'
fs/nilfs2/ioctl.c:120: warning: Function parameter or struct member 'fa' not described in 'nilfs_fileattr_get'
fs/nilfs2/ioctl.c:133: warning: Function parameter or struct member 'idmap' not described in 'nilfs_fileattr_set'
fs/nilfs2/ioctl.c:133: warning: Function parameter or struct member 'dentry' not described in 'nilfs_fileattr_set'
fs/nilfs2/ioctl.c:133: warning: Function parameter or struct member 'fa' not described in 'nilfs_fileattr_set'
fs/nilfs2/ioctl.c:164: warning: Function parameter or struct member 'inode' not described in 'nilfs_ioctl_getversion'
fs/nilfs2/ioctl.c:164: warning: Function parameter or struct member 'argp' not described in 'nilfs_ioctl_getversion'
fs/gfs2/glock.c:1277: warning: Function parameter or struct member 'ip' not described in '__gfs2_holder_init'
fs/bcachefs/io_write.c:1584: warning: Function parameter or struct member 'bch2_write' not described in 'CLOSURE_CALLBACK'
fs/gfs2/super.c:735: warning: Function parameter or struct member 'who' not described in 'gfs2_freeze_super'
fs/gfs2/super.c:803: warning: Function parameter or struct member 'who' not described in 'gfs2_thaw_super'
drivers/tty/n_hdlc.c:140: warning: Function parameter or struct member 'write_work' not described in 'n_hdlc'
drivers/tty/n_hdlc.c:140: warning: Function parameter or struct member 'tty_for_write_work' not described in 'n_hdlc'
drivers/memstick/core/memstick.c:206: warning: Function parameter or struct member 'host' not described in 'memstick_detect_change'
drivers/memstick/core/memstick.c:222: warning: Function parameter or struct member 'host' not described in 'memstick_next_req'
drivers/memstick/core/memstick.c:222: warning: Function parameter or struct member 'mrq' not described in 'memstick_next_req'
drivers/memstick/core/memstick.c:248: warning: Function parameter or struct member 'host' not described in 'memstick_new_req'
drivers/memstick/core/memstick.c:265: warning: Function parameter or struct member 'mrq' not described in 'memstick_init_req_sg'
drivers/memstick/core/memstick.c:265: warning: Function parameter or struct member 'tpc' not described in 'memstick_init_req_sg'
drivers/memstick/core/memstick.c:265: warning: Function parameter or struct member 'sg' not described in 'memstick_init_req_sg'
drivers/memstick/core/memstick.c:295: warning: Function parameter or struct member 'mrq' not described in 'memstick_init_req'
drivers/memstick/core/memstick.c:295: warning: Function parameter or struct member 'tpc' not described in 'memstick_init_req'
drivers/memstick/core/memstick.c:295: warning: Function parameter or struct member 'buf' not described in 'memstick_init_req'
drivers/memstick/core/memstick.c:295: warning: Function parameter or struct member 'length' not described in 'memstick_init_req'
drivers/memstick/core/memstick.c:366: warning: Function parameter or struct member 'card' not described in 'memstick_set_rw_addr'
drivers/memstick/core/memstick.c:513: warning: Function parameter or struct member 'host' not described in 'memstick_add_host'
drivers/memstick/core/memstick.c:549: warning: Function parameter or struct member 'host' not described in 'memstick_remove_host'
drivers/memstick/core/memstick.c:571: warning: Function parameter or struct member 'host' not described in 'memstick_free_host'
drivers/memstick/core/memstick.c:582: warning: Function parameter or struct member 'host' not described in 'memstick_suspend_host'
drivers/memstick/core/memstick.c:594: warning: Function parameter or struct member 'host' not described in 'memstick_resume_host'
drivers/firmware/efi/libstub/efi-stub-helper.c:613: warning: Function parameter or struct member 'out' not described in 'efi_load_initrd'
drivers/hwtracing/intel_th/core.c:866: warning: Function parameter or struct member 'drvdata' not described in 'intel_th_alloc'
drivers/hwtracing/intel_th/core.c:866: warning: Function parameter or struct member 'ndevres' not described in 'intel_th_alloc'
drivers/hwtracing/intel_th/msu.c:168: warning: Function parameter or struct member 'msu_base' not described in 'msc'
drivers/hwtracing/intel_th/msu.c:168: warning: Function parameter or struct member 'mbuf_priv' not described in 'msc'
drivers/hwtracing/intel_th/msu.c:168: warning: Function parameter or struct member 'work' not described in 'msc'
drivers/hwtracing/intel_th/msu.c:168: warning: Function parameter or struct member 'switch_on_unlock' not described in 'msc'
drivers/hwtracing/intel_th/msu.c:168: warning: Function parameter or struct member 'orig_addr' not described in 'msc'
drivers/hwtracing/intel_th/msu.c:168: warning: Function parameter or struct member 'orig_sz' not described in 'msc'
drivers/hwtracing/intel_th/msu.c:168: warning: Function parameter or struct member 'iter_list' not described in 'msc'
drivers/hwtracing/intel_th/msu.c:168: warning: Function parameter or struct member 'stop_on_full' not described in 'msc'
drivers/hwtracing/intel_th/msu.c:168: warning: Function parameter or struct member 'do_irq' not described in 'msc'
drivers/hwtracing/intel_th/msu.c:168: warning: Function parameter or struct member 'multi_is_broken' not described in 'msc'
drivers/hwmon/aht10.c:224: warning: Function parameter or struct member 'data' not described in 'aht10_interval_write'
drivers/hwmon/aht10.c:224: warning: Function parameter or struct member 'val' not described in 'aht10_interval_write'
drivers/hwmon/aht10.c:235: warning: Function parameter or struct member 'data' not described in 'aht10_interval_read'
drivers/hwmon/aht10.c:235: warning: Function parameter or struct member 'val' not described in 'aht10_interval_read'
drivers/hwmon/aht10.c:244: warning: Function parameter or struct member 'data' not described in 'aht10_temperature1_read'
drivers/hwmon/aht10.c:244: warning: Function parameter or struct member 'val' not described in 'aht10_temperature1_read'
drivers/hwmon/aht10.c:259: warning: Function parameter or struct member 'data' not described in 'aht10_humidity1_read'
drivers/hwmon/aht10.c:259: warning: Function parameter or struct member 'val' not described in 'aht10_humidity1_read'

These do not break builds, so maybe there are higher priorities, but I will trust your judgment
as if a senior developer's ...

Best regards,
Mirsad Todorovac

Powered by blists - more mailing lists