Re: linux-next: build warnings after merge of the jc_docs tree
Stephen Rothwell writes: > Hi all, > > After merging the jc_docs tree, today's linux-next build (htmldocs) > produced these warnings: > > include/linux/pstore_zone.h:55: warning: Function parameter or member 'write' > not described in 'pstore_zone_info' > include/linux/pstore_blk.h:43: warning: Function parameter or member 'write' > not described in 'pstore_device_info' > include/media/v4l2-mediabus.h:127: warning: Function parameter or member > 'type' not described in 'v4l2_mbus_config' > > and many more similar. These appear to be false positives :-( > > Introduced by commit > > 8d295fbad687 ("kernel-doc: better handle '::' sequences") > > I have reverted that commit for today. Argh, that was bad, sorry, I should have caught that. Just added the following to fix it. Thanks, jon >From 212209cff89fe497bc47abcd017aa95e4e8a5196 Mon Sep 17 00:00:00 2001 From: Jonathan Corbet Date: Fri, 26 Mar 2021 13:16:35 -0600 Subject: [PATCH] docs: kernel-doc: properly recognize parameter lines with colons The previous attempt to properly handle literal blocks broke parsing of parameter lines containing colons; fix it by tweaking the regex to specifically exclude the "::" pattern while accepting lines containing colons in general. Add a little documentation to the regex while in the neighborhood. Reported-by: Stephen Rothwell Fixes: 8d295fbad687 ("kernel-doc: better handle '::' sequences") Signed-off-by: Jonathan Corbet --- scripts/kernel-doc | 8 +++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 0ecd71477a16..d6d2b6e0b4eb 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -391,8 +391,14 @@ my $doc_com = '\s*\*\s*'; my $doc_com_body = '\s*\* ?'; my $doc_decl = $doc_com . '(\w+)'; # @params and a strictly limited set of supported section names +# Specifically: +# Match @word: +#@...: +# @{section-name}: +# while trying to not match literal block starts like "example::" +# my $doc_sect = $doc_com . - '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:([^:]*)$'; + '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:([^:].*)?$'; my $doc_content = $doc_com_body . '(.*)'; my $doc_block = $doc_com . 'DOC:\s*(.*)?'; my $doc_inline_start = '^\s*/\*\*\s*$'; -- 2.30.2
linux-next: build warnings after merge of the jc_docs tree
Hi all, After merging the jc_docs tree, today's linux-next build (htmldocs) produced these warnings: include/linux/pstore_zone.h:55: warning: Function parameter or member 'write' not described in 'pstore_zone_info' include/linux/pstore_blk.h:43: warning: Function parameter or member 'write' not described in 'pstore_device_info' include/media/v4l2-mediabus.h:127: warning: Function parameter or member 'type' not described in 'v4l2_mbus_config' and many more similar. These appear to be false positives :-( Introduced by commit 8d295fbad687 ("kernel-doc: better handle '::' sequences") I have reverted that commit for today. -- Cheers, Stephen Rothwell pgp_8Rvk3Wq0P.pgp Description: OpenPGP digital signature
linux-next: build warnings after merge of the jc_docs tree
Hi all, After merging the jc_docs tree, today's linux-next build (htmldocs) produced these warnings: Documentation/translations/zh_CN/admin-guide/README.rst:3: WARNING: undefined label: linux kernel release 5.x (if the link has no caption the label must precede a section header) Documentation/translations/zh_CN/admin-guide/unicode.rst:3: WARNING: undefined label: documentation/admin-guide/unicode.rst (if the link has no caption the label must precede a section header) Introduced by commit 550c8399d017 ("docs/zh_CN: Add zh_CN/admin-guide/README.rst") -- Cheers, Stephen Rothwell pgplOUyDrOg8S.pgp Description: OpenPGP digital signature
Re: linux-next: build warnings after merge of the jc_docs tree
Hi Stephen, Em Tue, 19 Jan 2021 17:13:03 +1100 Stephen Rothwell escreveu: > Hi all, > > After merging the jc_docs tree, today's linux-next build (KCONFIG_NAME) > produced these warnings: > > fs/pstore/zone.c:39: warning: expecting prototype for struct psz_head. > Prototype was for struct psz_buffer instead > include/linux/connector.h:122: warning: expecting prototype for > cn_netlink_send_mult(). Prototype was for cn_netlink_send() instead > include/linux/firmware/intel/stratix10-svc-client.h:15: warning: expecting > prototype for Service layer driver supports client names(). Prototype was for > SVC_CLIENT_FPGA() instead > include/linux/firmware/intel/stratix10-svc-client.h:45: warning: expecting > prototype for in bit number(). Prototype was for SVC_STATUS_OK() instead > include/linux/firmware/intel/stratix10-svc-client.h:59: warning: expecting > prototype for Flag bit for COMMAND_RECONFIG(). Prototype was for > COMMAND_RECONFIG_FLAG_PARTIAL() instead > include/linux/firmware/intel/stratix10-svc-client.h:66: warning: expecting > prototype for Timeout settings for service clients(). Prototype was for > SVC_RECONFIG_REQUEST_TIMEOUT_MS() instead > include/linux/firmware/intel/stratix10-svc-client.h:228: warning: expecting > prototype for intel_svc_done(). Prototype was for stratix10_svc_done() instead > include/linux/firmware/intel/stratix10-svc-client.h:15: warning: expecting > prototype for Service layer driver supports client names(). Prototype was for > SVC_CLIENT_FPGA() instead > include/linux/firmware/intel/stratix10-svc-client.h:45: warning: expecting > prototype for in bit number(). Prototype was for SVC_STATUS_OK() instead > include/linux/firmware/intel/stratix10-svc-client.h:59: warning: expecting > prototype for Flag bit for COMMAND_RECONFIG(). Prototype was for > COMMAND_RECONFIG_FLAG_PARTIAL() instead > include/linux/firmware/intel/stratix10-svc-client.h:66: warning: expecting > prototype for Timeout settings for service clients(). Prototype was for > SVC_RECONFIG_REQUEST_TIMEOUT_MS() instead > include/linux/firmware/intel/stratix10-svc-client.h:228: warning: expecting > prototype for intel_svc_done(). Prototype was for stratix10_svc_done() instead > include/linux/firmware/intel/stratix10-svc-client.h:15: warning: expecting > prototype for Service layer driver supports client names(). Prototype was for > SVC_CLIENT_FPGA() instead > include/linux/firmware/intel/stratix10-svc-client.h:45: warning: expecting > prototype for in bit number(). Prototype was for SVC_STATUS_OK() instead > include/linux/firmware/intel/stratix10-svc-client.h:59: warning: expecting > prototype for Flag bit for COMMAND_RECONFIG(). Prototype was for > COMMAND_RECONFIG_FLAG_PARTIAL() instead > include/linux/firmware/intel/stratix10-svc-client.h:66: warning: expecting > prototype for Timeout settings for service clients(). Prototype was for > SVC_RECONFIG_REQUEST_TIMEOUT_MS() instead > include/linux/firmware/intel/stratix10-svc-client.h:228: warning: expecting > prototype for intel_svc_done(). Prototype was for stratix10_svc_done() instead > include/linux/firmware/intel/stratix10-svc-client.h:15: warning: expecting > prototype for Service layer driver supports client names(). Prototype was for > SVC_CLIENT_FPGA() instead > include/linux/firmware/intel/stratix10-svc-client.h:45: warning: expecting > prototype for in bit number(). Prototype was for SVC_STATUS_OK() instead > include/linux/firmware/intel/stratix10-svc-client.h:59: warning: expecting > prototype for Flag bit for COMMAND_RECONFIG(). Prototype was for > COMMAND_RECONFIG_FLAG_PARTIAL() instead > include/linux/firmware/intel/stratix10-svc-client.h:66: warning: expecting > prototype for Timeout settings for service clients(). Prototype was for > SVC_RECONFIG_REQUEST_TIMEOUT_MS() instead > include/linux/firmware/intel/stratix10-svc-client.h:228: warning: expecting > prototype for intel_svc_done(). Prototype was for stratix10_svc_done() instead > include/linux/firmware/intel/stratix10-svc-client.h:15: warning: expecting > prototype for Service layer driver supports client names(). Prototype was for > SVC_CLIENT_FPGA() instead > include/linux/firmware/intel/stratix10-svc-client.h:45: warning: expecting > prototype for in bit number(). Prototype was for SVC_STATUS_OK() instead > include/linux/firmware/intel/stratix10-svc-client.h:59: warning: expecting > prototype for Flag bit for COMMAND_RECONFIG(). Prototype was for > COMMAND_RECONFIG_FLAG_PARTIAL() instead > include/linux/firmware/intel/stratix10-svc-client.h:66: warning: expecting > prototype for Timeout settings for service clients(). Prototype was for > SVC_RECONFIG_REQUEST_TIMEOUT_MS() instead > include/linux/firmware/intel/stratix10-svc-client.h:228: warning: expecting > prototype for intel_svc_done(). Prototype was for stratix10_svc_done() instead > include/linux/memblock.h:292: warning: expecting prototype for > for_each_free_mem_range_in_zone(). Prototype was for >
Re: linux-next: build warnings after merge of the jc_docs tree
Hi all, On Tue, 19 Jan 2021 17:13:03 +1100 Stephen Rothwell wrote: > > Hi all, > > After merging the jc_docs tree, today's linux-next build (KCONFIG_NAME) > produced these warnings: > Also, these: tools/testing/selftests/kselftest_harness.h:82: warning: wrong kernel-doc identifier on line: * TH_LOG(fmt, ...) tools/testing/selftests/kselftest_harness.h:116: warning: wrong kernel-doc identifier on line: * SKIP(statement, fmt, ...) tools/testing/selftests/kselftest_harness.h:139: warning: wrong kernel-doc identifier on line: * TEST(test_name) - Defines the test function and creates the registration tools/testing/selftests/kselftest_harness.h:158: warning: wrong kernel-doc identifier on line: * TEST_SIGNAL(test_name, signal) tools/testing/selftests/kselftest_harness.h:198: warning: wrong kernel-doc identifier on line: * FIXTURE_DATA(datatype_name) - Wraps the struct name so we have one less tools/testing/selftests/kselftest_harness.h:215: warning: wrong kernel-doc identifier on line: * FIXTURE(fixture_name) - Called once per fixture to setup the data and tools/testing/selftests/kselftest_harness.h:242: warning: wrong kernel-doc identifier on line: * FIXTURE_SETUP(fixture_name) - Prepares the setup function for the fixture. tools/testing/selftests/kselftest_harness.h:268: warning: wrong kernel-doc identifier on line: * FIXTURE_TEARDOWN(fixture_name) tools/testing/selftests/kselftest_harness.h:289: warning: wrong kernel-doc identifier on line: * FIXTURE_VARIANT(fixture_name) - Optionally called once per fixture tools/testing/selftests/kselftest_harness.h:308: warning: wrong kernel-doc identifier on line: * FIXTURE_VARIANT_ADD(fixture_name, variant_name) - Called once per fixture tools/testing/selftests/kselftest_harness.h:342: warning: wrong kernel-doc identifier on line: * TEST_F(fixture_name, test_name) - Emits test registration and helpers for include/linux/seqlock.h:829: warning: wrong kernel-doc identifier on line: * DEFINE_SEQLOCK(sl) - Define a statically allocated seqlock_t tools/testing/selftests/kselftest_harness.h:82: warning: wrong kernel-doc identifier on line: * TH_LOG(fmt, ...) tools/testing/selftests/kselftest_harness.h:116: warning: wrong kernel-doc identifier on line: * SKIP(statement, fmt, ...) tools/testing/selftests/kselftest_harness.h:139: warning: wrong kernel-doc identifier on line: * TEST(test_name) - Defines the test function and creates the registration tools/testing/selftests/kselftest_harness.h:158: warning: wrong kernel-doc identifier on line: * TEST_SIGNAL(test_name, signal) tools/testing/selftests/kselftest_harness.h:198: warning: wrong kernel-doc identifier on line: * FIXTURE_DATA(datatype_name) - Wraps the struct name so we have one less tools/testing/selftests/kselftest_harness.h:215: warning: wrong kernel-doc identifier on line: * FIXTURE(fixture_name) - Called once per fixture to setup the data and tools/testing/selftests/kselftest_harness.h:242: warning: wrong kernel-doc identifier on line: * FIXTURE_SETUP(fixture_name) - Prepares the setup function for the fixture. tools/testing/selftests/kselftest_harness.h:268: warning: wrong kernel-doc identifier on line: * FIXTURE_TEARDOWN(fixture_name) tools/testing/selftests/kselftest_harness.h:289: warning: wrong kernel-doc identifier on line: * FIXTURE_VARIANT(fixture_name) - Optionally called once per fixture tools/testing/selftests/kselftest_harness.h:308: warning: wrong kernel-doc identifier on line: * FIXTURE_VARIANT_ADD(fixture_name, variant_name) - Called once per fixture tools/testing/selftests/kselftest_harness.h:342: warning: wrong kernel-doc identifier on line: * TEST_F(fixture_name, test_name) - Emits test registration and helpers for tools/testing/selftests/kselftest_harness.h:82: warning: wrong kernel-doc identifier on line: * TH_LOG(fmt, ...) tools/testing/selftests/kselftest_harness.h:116: warning: wrong kernel-doc identifier on line: * SKIP(statement, fmt, ...) tools/testing/selftests/kselftest_harness.h:139: warning: wrong kernel-doc identifier on line: * TEST(test_name) - Defines the test function and creates the registration tools/testing/selftests/kselftest_harness.h:158: warning: wrong kernel-doc identifier on line: * TEST_SIGNAL(test_name, signal) tools/testing/selftests/kselftest_harness.h:198: warning: wrong kernel-doc identifier on line: * FIXTURE_DATA(datatype_name) - Wraps the struct name so we have one less tools/testing/selftests/kselftest_harness.h:215: warning: wrong kernel-doc identifier on line: * FIXTURE(fixture_name) - Called once per fixture to setup the data and tools/testing/selftests/kselftest_harness.h:242: warning: wrong kernel-doc identifier on line: * FIXTURE_SETUP(fixture_name) - Prepares the setup function for the fixture. tools/testing/selftests/kselftest_harness.h:268: warning: wrong kernel-doc identifier on line: * FIXTURE_TEARDOWN(fixture_name) tools/testing/selftests/kselftest_harness.h:289: warning: wrong kernel-doc
Re: linux-next: build warnings after merge of the jc_docs tree
Hi all, On Tue, 19 Jan 2021 17:13:03 +1100 Stephen Rothwell wrote: > > Hi all, > > After merging the jc_docs tree, today's linux-next build (KCONFIG_NAME) This was a "make htmldocs" -- Cheers, Stephen Rothwell pgpFv0_40bjTG.pgp Description: OpenPGP digital signature
linux-next: build warnings after merge of the jc_docs tree
Hi all, After merging the jc_docs tree, today's linux-next build (KCONFIG_NAME) produced these warnings: fs/pstore/zone.c:39: warning: expecting prototype for struct psz_head. Prototype was for struct psz_buffer instead include/linux/connector.h:122: warning: expecting prototype for cn_netlink_send_mult(). Prototype was for cn_netlink_send() instead include/linux/firmware/intel/stratix10-svc-client.h:15: warning: expecting prototype for Service layer driver supports client names(). Prototype was for SVC_CLIENT_FPGA() instead include/linux/firmware/intel/stratix10-svc-client.h:45: warning: expecting prototype for in bit number(). Prototype was for SVC_STATUS_OK() instead include/linux/firmware/intel/stratix10-svc-client.h:59: warning: expecting prototype for Flag bit for COMMAND_RECONFIG(). Prototype was for COMMAND_RECONFIG_FLAG_PARTIAL() instead include/linux/firmware/intel/stratix10-svc-client.h:66: warning: expecting prototype for Timeout settings for service clients(). Prototype was for SVC_RECONFIG_REQUEST_TIMEOUT_MS() instead include/linux/firmware/intel/stratix10-svc-client.h:228: warning: expecting prototype for intel_svc_done(). Prototype was for stratix10_svc_done() instead include/linux/firmware/intel/stratix10-svc-client.h:15: warning: expecting prototype for Service layer driver supports client names(). Prototype was for SVC_CLIENT_FPGA() instead include/linux/firmware/intel/stratix10-svc-client.h:45: warning: expecting prototype for in bit number(). Prototype was for SVC_STATUS_OK() instead include/linux/firmware/intel/stratix10-svc-client.h:59: warning: expecting prototype for Flag bit for COMMAND_RECONFIG(). Prototype was for COMMAND_RECONFIG_FLAG_PARTIAL() instead include/linux/firmware/intel/stratix10-svc-client.h:66: warning: expecting prototype for Timeout settings for service clients(). Prototype was for SVC_RECONFIG_REQUEST_TIMEOUT_MS() instead include/linux/firmware/intel/stratix10-svc-client.h:228: warning: expecting prototype for intel_svc_done(). Prototype was for stratix10_svc_done() instead include/linux/firmware/intel/stratix10-svc-client.h:15: warning: expecting prototype for Service layer driver supports client names(). Prototype was for SVC_CLIENT_FPGA() instead include/linux/firmware/intel/stratix10-svc-client.h:45: warning: expecting prototype for in bit number(). Prototype was for SVC_STATUS_OK() instead include/linux/firmware/intel/stratix10-svc-client.h:59: warning: expecting prototype for Flag bit for COMMAND_RECONFIG(). Prototype was for COMMAND_RECONFIG_FLAG_PARTIAL() instead include/linux/firmware/intel/stratix10-svc-client.h:66: warning: expecting prototype for Timeout settings for service clients(). Prototype was for SVC_RECONFIG_REQUEST_TIMEOUT_MS() instead include/linux/firmware/intel/stratix10-svc-client.h:228: warning: expecting prototype for intel_svc_done(). Prototype was for stratix10_svc_done() instead include/linux/firmware/intel/stratix10-svc-client.h:15: warning: expecting prototype for Service layer driver supports client names(). Prototype was for SVC_CLIENT_FPGA() instead include/linux/firmware/intel/stratix10-svc-client.h:45: warning: expecting prototype for in bit number(). Prototype was for SVC_STATUS_OK() instead include/linux/firmware/intel/stratix10-svc-client.h:59: warning: expecting prototype for Flag bit for COMMAND_RECONFIG(). Prototype was for COMMAND_RECONFIG_FLAG_PARTIAL() instead include/linux/firmware/intel/stratix10-svc-client.h:66: warning: expecting prototype for Timeout settings for service clients(). Prototype was for SVC_RECONFIG_REQUEST_TIMEOUT_MS() instead include/linux/firmware/intel/stratix10-svc-client.h:228: warning: expecting prototype for intel_svc_done(). Prototype was for stratix10_svc_done() instead include/linux/firmware/intel/stratix10-svc-client.h:15: warning: expecting prototype for Service layer driver supports client names(). Prototype was for SVC_CLIENT_FPGA() instead include/linux/firmware/intel/stratix10-svc-client.h:45: warning: expecting prototype for in bit number(). Prototype was for SVC_STATUS_OK() instead include/linux/firmware/intel/stratix10-svc-client.h:59: warning: expecting prototype for Flag bit for COMMAND_RECONFIG(). Prototype was for COMMAND_RECONFIG_FLAG_PARTIAL() instead include/linux/firmware/intel/stratix10-svc-client.h:66: warning: expecting prototype for Timeout settings for service clients(). Prototype was for SVC_RECONFIG_REQUEST_TIMEOUT_MS() instead include/linux/firmware/intel/stratix10-svc-client.h:228: warning: expecting prototype for intel_svc_done(). Prototype was for stratix10_svc_done() instead include/linux/memblock.h:292: warning: expecting prototype for for_each_free_mem_range_in_zone(). Prototype was for for_each_free_mem_pfn_range_in_zone() instead include/linux/memblock.h:308: warning: expecting prototype for for_each_free_mem_range_in_zone_from(). Prototype was for for_each_free_mem_pfn_range_in_zone_from() instead drivers/ra