As we're currently discussing about making kernel-doc issues fatal when CONFIG_WERROR is enable, let's fix all 60 kernel-doc warnings inside linux-next:
arch/x86/include/uapi/asm/sgx.h:19: warning: Enum value 'SGX_PAGE_MEASURE' not described in enum 'sgx_page_flags' arch/x86/include/uapi/asm/sgx.h:97: warning: Function parameter or member 'rdi' not described in 'sgx_enclave_user_handler_t' arch/x86/include/uapi/asm/sgx.h:97: warning: Function parameter or member 'rsi' not described in 'sgx_enclave_user_handler_t' arch/x86/include/uapi/asm/sgx.h:97: warning: Function parameter or member 'rdx' not described in 'sgx_enclave_user_handler_t' arch/x86/include/uapi/asm/sgx.h:97: warning: Function parameter or member 'rsp' not described in 'sgx_enclave_user_handler_t' arch/x86/include/uapi/asm/sgx.h:97: warning: Function parameter or member 'r8' not described in 'sgx_enclave_user_handler_t' arch/x86/include/uapi/asm/sgx.h:97: warning: Function parameter or member 'r9' not described in 'sgx_enclave_user_handler_t' arch/x86/include/uapi/asm/sgx.h:124: warning: Function parameter or member 'reserved' not described in 'sgx_enclave_run' drivers/devfreq/devfreq.c:707: warning: Function parameter or member 'val' not described in 'qos_min_notifier_call' drivers/devfreq/devfreq.c:707: warning: Function parameter or member 'ptr' not described in 'qos_min_notifier_call' drivers/devfreq/devfreq.c:717: warning: Function parameter or member 'val' not described in 'qos_max_notifier_call' drivers/devfreq/devfreq.c:717: warning: Function parameter or member 'ptr' not described in 'qos_max_notifier_call' drivers/gpu/drm/amd/amdgpu/amdgpu_device.c:5095: warning: expecting prototype for amdgpu_device_gpu_recover_imp(). Prototype was for amdgpu_device_gpu_recover() instead drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:544: warning: Function parameter or member 'dmub_outbox_params' not described in 'amdgpu_display_manager' drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:544: warning: Function parameter or member 'num_of_edps' not described in 'amdgpu_display_manager' drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:544: warning: Function parameter or member 'disable_hpd_irq' not described in 'amdgpu_display_manager' drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:544: warning: Function parameter or member 'dmub_aux_transfer_done' not described in 'amdgpu_display_manager' drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:544: warning: Function parameter or member 'delayed_hpd_wq' not described in 'amdgpu_display_manager' drivers/gpu/drm/amd/include/amd_shared.h:224: warning: Enum value 'PP_GFX_DCS_MASK' not described in enum 'PP_FEATURE_MASK' drivers/gpu/drm/scheduler/sched_main.c:999: warning: Function parameter or member 'dev' not described in 'drm_sched_init' drivers/usb/dwc3/core.h:1328: warning: Function parameter or member 'async_callbacks' not described in 'dwc3' drivers/usb/dwc3/gadget.c:675: warning: Function parameter or member 'mult' not described in 'dwc3_gadget_calc_tx_fifo_size' fs/attr.c:36: warning: Function parameter or member 'ia_vfsuid' not described in 'chown_ok' fs/attr.c:36: warning: Excess function parameter 'uid' description in 'chown_ok' fs/attr.c:63: warning: Function parameter or member 'ia_vfsgid' not described in 'chgrp_ok' fs/attr.c:63: warning: Excess function parameter 'gid' description in 'chgrp_ok' fs/namei.c:649: warning: Function parameter or member 'mnt' not described in 'path_connected' fs/namei.c:649: warning: Function parameter or member 'dentry' not described in 'path_connected' fs/namei.c:1089: warning: Function parameter or member 'inode' not described in 'may_follow_link' include/drm/gpu_scheduler.h:463: warning: Function parameter or member 'dev' not described in 'drm_gpu_scheduler' include/linux/dcache.h:309: warning: expecting prototype for dget, dget_dlock(). Prototype was for dget_dlock() instead include/linux/fscache.h:270: warning: Function parameter or member 'cookie' not described in 'fscache_use_cookie' include/linux/fscache.h:270: warning: Excess function parameter 'object' description in 'fscache_use_cookie' include/linux/fscache.h:287: warning: Function parameter or member 'cookie' not described in 'fscache_unuse_cookie' include/linux/fscache.h:287: warning: Excess function parameter 'object' description in 'fscache_unuse_cookie' include/linux/genalloc.h:54: warning: Function parameter or member 'start_addr' not described in 'genpool_algo_t' include/linux/kfence.h:221: warning: Function parameter or member 'slab' not described in '__kfence_obj_info' include/linux/regulator/driver.h:434: warning: Function parameter or member 'n_ramp_values' not described in 'regulator_desc' include/linux/textsearch.h:51: warning: Function parameter or member 'list' not described in 'ts_ops' include/linux/usb/typec_altmode.h:132: warning: Function parameter or member 'altmode' not described in 'typec_altmode_get_orientation' include/net/cfg80211.h:391: warning: Function parameter or member 'bw' not described in 'ieee80211_eht_mcs_nss_supp' include/net/cfg80211.h:437: warning: Function parameter or member 'eht_cap' not described in 'ieee80211_sband_iftype_data' include/net/cfg80211.h:507: warning: Function parameter or member 's1g' not described in 'ieee80211_sta_s1g_cap' include/net/cfg80211.h:1390: warning: Function parameter or member 'counter_offset_beacon' not described in 'cfg80211_color_change_settings' include/net/cfg80211.h:1390: warning: Function parameter or member 'counter_offset_presp' not described in 'cfg80211_color_change_settings' include/net/cfg80211.h:1430: warning: Enum value 'STATION_PARAM_APPLY_STA_TXPOWER' not described in enum 'station_parameters_apply_mask' include/net/cfg80211.h:2195: warning: Function parameter or member 'dot11MeshConnectedToAuthServer' not described in 'mesh_config' include/net/cfg80211.h:2341: warning: Function parameter or member 'short_ssid' not described in 'cfg80211_scan_6ghz_params' include/net/cfg80211.h:3328: warning: Function parameter or member 'kck_len' not described in 'cfg80211_gtk_rekey_data' include/net/cfg80211.h:3698: warning: Function parameter or member 'ftm' not described in 'cfg80211_pmsr_result' include/net/cfg80211.h:3828: warning: Function parameter or member 'global_mcast_stypes' not described in 'mgmt_frame_regs' include/net/cfg80211.h:4977: warning: Function parameter or member 'ftm' not described in 'cfg80211_pmsr_capabilities' include/net/cfg80211.h:5742: warning: Function parameter or member 'u' not described in 'wireless_dev' include/net/cfg80211.h:5742: warning: Function parameter or member 'links' not described in 'wireless_dev' include/net/cfg80211.h:5742: warning: Function parameter or member 'valid_links' not described in 'wireless_dev' include/net/cfg80211.h:6076: warning: Function parameter or member 'is_amsdu' not described in 'ieee80211_data_to_8023_exthdr' include/net/cfg80211.h:6949: warning: Function parameter or member 'sig_dbm' not described in 'cfg80211_notify_new_peer_candidate' include/net/mac80211.h:6250: warning: Function parameter or member 'vif' not described in 'ieee80211_channel_switch_disconnect' mm/memory.c:1729: warning: Function parameter or member 'mt' not described in 'unmap_vmas' net/mac80211/sta_info.h:569: warning: Function parameter or member 'cur_max_bandwidth' not described in 'link_sta_info'
Mauro Carvalho Chehab (22): net: cfg80211: fix kernel-doc warnings all over the file net: mac80211: add a missing comma at kernel-doc markup net: mac80211: sta_info: fix a missing kernel-doc struct element x86/sgx: fix kernel-doc markups fscache: fix kernel-doc documentation fs: attr: update vfs uid/gid parameters at kernel-doc fs: namei: address some kernel-doc issues devfreq: shut up kernel-doc warnings drm: amdgpu: amdgpu_dm: fix kernel-doc markups drm: amdgpu: amdgpu_device.c: fix a kernel-doc markup drm: amd: amd_shared.h: Add missing doc for PP_GFX_DCS_MASK drm: gpu_scheduler: fix a kernel-doc warning drm: scheduler: add a missing kernel-doc parameter kfence: fix a kernel-doc parameter mm: document maple tree pointer at unmap_vmas() at memory.c genalloc: add a description for start_addr parameter textsearch: document list inside struct ts_ops regulator: fix a kernel-doc warning dcache: fix a kernel-doc warning usb: typec_altmode: add a missing "@" at a kernel-doc parameter usb: dwc3: document async_callbacks field usb: dwc3: gadget: fix a kernel-doc warning
arch/x86/include/uapi/asm/sgx.h | 10 +++++-- drivers/devfreq/devfreq.c | 4 +++ drivers/gpu/drm/amd/amdgpu/amdgpu_device.c | 2 +- .../gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 7 +++++ drivers/gpu/drm/amd/include/amd_shared.h | 1 + drivers/gpu/drm/scheduler/sched_main.c | 1 + drivers/usb/dwc3/core.h | 2 ++ drivers/usb/dwc3/gadget.c | 1 + fs/attr.c | 4 +-- fs/namei.c | 3 ++ include/drm/gpu_scheduler.h | 1 + include/linux/dcache.h | 2 +- include/linux/fscache.h | 4 +-- include/linux/genalloc.h | 1 + include/linux/kfence.h | 1 + include/linux/regulator/driver.h | 1 + include/linux/textsearch.h | 1 + include/linux/usb/typec_altmode.h | 2 +- include/net/cfg80211.h | 28 ++++++++++++++----- include/net/mac80211.h | 2 +- mm/memory.c | 2 ++ net/mac80211/sta_info.h | 2 ++ 22 files changed, 65 insertions(+), 17 deletions(-)
The kernel-doc markup is missing the slab pointer description:
include/linux/kfence.h:221: warning: Function parameter or member 'slab' not described in '__kfence_obj_info'
Document it.
Signed-off-by: Mauro Carvalho Chehab mchehab@kernel.org ---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/22] at: https://lore.kernel.org/all/cover.1656409369.git.mchehab@kernel.org/
include/linux/kfence.h | 1 + 1 file changed, 1 insertion(+)
diff --git a/include/linux/kfence.h b/include/linux/kfence.h index 726857a4b680..9c242f4e9fab 100644 --- a/include/linux/kfence.h +++ b/include/linux/kfence.h @@ -210,6 +210,7 @@ struct kmem_obj_info; * __kfence_obj_info() - fill kmem_obj_info struct * @kpp: kmem_obj_info to be filled * @object: the object + * @slab: pointer to slab * * Return: * * false - not a KFENCE object
On Tue, 28 Jun 2022 at 11:46, Mauro Carvalho Chehab mchehab@kernel.org wrote:
The kernel-doc markup is missing the slab pointer description:
include/linux/kfence.h:221: warning: Function parameter or member 'slab' not described in '__kfence_obj_info'
Document it.
Signed-off-by: Mauro Carvalho Chehab mchehab@kernel.org
Reviewed-by: Marco Elver elver@google.com
Thank you.
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/22] at: https://lore.kernel.org/all/cover.1656409369.git.mchehab@kernel.org/
include/linux/kfence.h | 1 + 1 file changed, 1 insertion(+)
diff --git a/include/linux/kfence.h b/include/linux/kfence.h index 726857a4b680..9c242f4e9fab 100644 --- a/include/linux/kfence.h +++ b/include/linux/kfence.h @@ -210,6 +210,7 @@ struct kmem_obj_info;
- __kfence_obj_info() - fill kmem_obj_info struct
- @kpp: kmem_obj_info to be filled
- @object: the object
- @slab: pointer to slab
- Return:
- false - not a KFENCE object
-- 2.36.1
On Tue, 28 Jun 2022 10:46:04 +0100, Mauro Carvalho Chehab wrote:
As we're currently discussing about making kernel-doc issues fatal when CONFIG_WERROR is enable, let's fix all 60 kernel-doc warnings inside linux-next:
arch/x86/include/uapi/asm/sgx.h:19: warning: Enum value 'SGX_PAGE_MEASURE' not described in enum 'sgx_page_flags' arch/x86/include/uapi/asm/sgx.h:97: warning: Function parameter or member 'rdi' not described in 'sgx_enclave_user_handler_t' arch/x86/include/uapi/asm/sgx.h:97: warning: Function parameter or member 'rsi' not described in 'sgx_enclave_user_handler_t' arch/x86/include/uapi/asm/sgx.h:97: warning: Function parameter or member 'rdx' not described in 'sgx_enclave_user_handler_t' arch/x86/include/uapi/asm/sgx.h:97: warning: Function parameter or member 'rsp' not described in 'sgx_enclave_user_handler_t' arch/x86/include/uapi/asm/sgx.h:97: warning: Function parameter or member 'r8' not described in 'sgx_enclave_user_handler_t' arch/x86/include/uapi/asm/sgx.h:97: warning: Function parameter or member 'r9' not described in 'sgx_enclave_user_handler_t' arch/x86/include/uapi/asm/sgx.h:124: warning: Function parameter or member 'reserved' not described in 'sgx_enclave_run' drivers/devfreq/devfreq.c:707: warning: Function parameter or member 'val' not described in 'qos_min_notifier_call' drivers/devfreq/devfreq.c:707: warning: Function parameter or member 'ptr' not described in 'qos_min_notifier_call' drivers/devfreq/devfreq.c:717: warning: Function parameter or member 'val' not described in 'qos_max_notifier_call' drivers/devfreq/devfreq.c:717: warning: Function parameter or member 'ptr' not described in 'qos_max_notifier_call' drivers/gpu/drm/amd/amdgpu/amdgpu_device.c:5095: warning: expecting prototype for amdgpu_device_gpu_recover_imp(). Prototype was for amdgpu_device_gpu_recover() instead drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:544: warning: Function parameter or member 'dmub_outbox_params' not described in 'amdgpu_display_manager' drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:544: warning: Function parameter or member 'num_of_edps' not described in 'amdgpu_display_manager' drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:544: warning: Function parameter or member 'disable_hpd_irq' not described in 'amdgpu_display_manager' drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:544: warning: Function parameter or member 'dmub_aux_transfer_done' not described in 'amdgpu_display_manager' drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:544: warning: Function parameter or member 'delayed_hpd_wq' not described in 'amdgpu_display_manager' drivers/gpu/drm/amd/include/amd_shared.h:224: warning: Enum value 'PP_GFX_DCS_MASK' not described in enum 'PP_FEATURE_MASK' drivers/gpu/drm/scheduler/sched_main.c:999: warning: Function parameter or member 'dev' not described in 'drm_sched_init' drivers/usb/dwc3/core.h:1328: warning: Function parameter or member 'async_callbacks' not described in 'dwc3' drivers/usb/dwc3/gadget.c:675: warning: Function parameter or member 'mult' not described in 'dwc3_gadget_calc_tx_fifo_size' fs/attr.c:36: warning: Function parameter or member 'ia_vfsuid' not described in 'chown_ok' fs/attr.c:36: warning: Excess function parameter 'uid' description in 'chown_ok' fs/attr.c:63: warning: Function parameter or member 'ia_vfsgid' not described in 'chgrp_ok' fs/attr.c:63: warning: Excess function parameter 'gid' description in 'chgrp_ok' fs/namei.c:649: warning: Function parameter or member 'mnt' not described in 'path_connected' fs/namei.c:649: warning: Function parameter or member 'dentry' not described in 'path_connected' fs/namei.c:1089: warning: Function parameter or member 'inode' not described in 'may_follow_link' include/drm/gpu_scheduler.h:463: warning: Function parameter or member 'dev' not described in 'drm_gpu_scheduler' include/linux/dcache.h:309: warning: expecting prototype for dget, dget_dlock(). Prototype was for dget_dlock() instead include/linux/fscache.h:270: warning: Function parameter or member 'cookie' not described in 'fscache_use_cookie' include/linux/fscache.h:270: warning: Excess function parameter 'object' description in 'fscache_use_cookie' include/linux/fscache.h:287: warning: Function parameter or member 'cookie' not described in 'fscache_unuse_cookie' include/linux/fscache.h:287: warning: Excess function parameter 'object' description in 'fscache_unuse_cookie' include/linux/genalloc.h:54: warning: Function parameter or member 'start_addr' not described in 'genpool_algo_t' include/linux/kfence.h:221: warning: Function parameter or member 'slab' not described in '__kfence_obj_info' include/linux/regulator/driver.h:434: warning: Function parameter or member 'n_ramp_values' not described in 'regulator_desc' include/linux/textsearch.h:51: warning: Function parameter or member 'list' not described in 'ts_ops' include/linux/usb/typec_altmode.h:132: warning: Function parameter or member 'altmode' not described in 'typec_altmode_get_orientation' include/net/cfg80211.h:391: warning: Function parameter or member 'bw' not described in 'ieee80211_eht_mcs_nss_supp' include/net/cfg80211.h:437: warning: Function parameter or member 'eht_cap' not described in 'ieee80211_sband_iftype_data' include/net/cfg80211.h:507: warning: Function parameter or member 's1g' not described in 'ieee80211_sta_s1g_cap' include/net/cfg80211.h:1390: warning: Function parameter or member 'counter_offset_beacon' not described in 'cfg80211_color_change_settings' include/net/cfg80211.h:1390: warning: Function parameter or member 'counter_offset_presp' not described in 'cfg80211_color_change_settings' include/net/cfg80211.h:1430: warning: Enum value 'STATION_PARAM_APPLY_STA_TXPOWER' not described in enum 'station_parameters_apply_mask' include/net/cfg80211.h:2195: warning: Function parameter or member 'dot11MeshConnectedToAuthServer' not described in 'mesh_config' include/net/cfg80211.h:2341: warning: Function parameter or member 'short_ssid' not described in 'cfg80211_scan_6ghz_params' include/net/cfg80211.h:3328: warning: Function parameter or member 'kck_len' not described in 'cfg80211_gtk_rekey_data' include/net/cfg80211.h:3698: warning: Function parameter or member 'ftm' not described in 'cfg80211_pmsr_result' include/net/cfg80211.h:3828: warning: Function parameter or member 'global_mcast_stypes' not described in 'mgmt_frame_regs' include/net/cfg80211.h:4977: warning: Function parameter or member 'ftm' not described in 'cfg80211_pmsr_capabilities' include/net/cfg80211.h:5742: warning: Function parameter or member 'u' not described in 'wireless_dev' include/net/cfg80211.h:5742: warning: Function parameter or member 'links' not described in 'wireless_dev' include/net/cfg80211.h:5742: warning: Function parameter or member 'valid_links' not described in 'wireless_dev' include/net/cfg80211.h:6076: warning: Function parameter or member 'is_amsdu' not described in 'ieee80211_data_to_8023_exthdr' include/net/cfg80211.h:6949: warning: Function parameter or member 'sig_dbm' not described in 'cfg80211_notify_new_peer_candidate' include/net/mac80211.h:6250: warning: Function parameter or member 'vif' not described in 'ieee80211_channel_switch_disconnect' mm/memory.c:1729: warning: Function parameter or member 'mt' not described in 'unmap_vmas' net/mac80211/sta_info.h:569: warning: Function parameter or member 'cur_max_bandwidth' not described in 'link_sta_info'
[...]
Applied to
https://git.kernel.org/pub/scm/linux/kernel/git/broonie/regulator.git for-next
Thanks!
[18/22] regulator: fix a kernel-doc warning commit: 0e584d46218e3b9dc12a98e18e81a0cd3e0d5419
All being well this means that it will be integrated into the linux-next tree (usually sometime in the next 24 hours) and sent to Linus during the next merge window (or sooner if it is a bug fix), however if problems are discovered then the patch may be dropped or reverted.
You may get further e-mails resulting from automated or manual testing and review of the tree, please engage with people reporting problems and send followup patches addressing any issues that are reported if needed.
If any updates are required or you are submitting further changes they should be sent as incremental updates against current git, existing patches will not be replaced.
Please add any relevant lists and maintainers to the CCs when replying to this mail.
Thanks, Mark
On Tue, Jun 28, 2022 at 10:46:04AM +0100, Mauro Carvalho Chehab wrote:
As we're currently discussing about making kernel-doc issues fatal when CONFIG_WERROR is enable, let's fix all 60 kernel-doc warnings inside linux-next:
To be fair, besides triggering error on kernel-doc warnings, Sphinx warnings should also be errors on CONFIG_WERROR.
linaro-mm-sig@lists.linaro.org