* linux-next: build warnings after merge of the jc_docs tree
@ 2021-03-26 7:54 Stephen Rothwell
2021-03-26 19:20 ` Jonathan Corbet
0 siblings, 1 reply; 13+ messages in thread
From: Stephen Rothwell @ 2021-03-26 7:54 UTC (permalink / raw)
To: Jonathan Corbet
Cc: Mauro Carvalho Chehab, Linux Kernel Mailing List,
Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 684 bytes --]
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
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 13+ messages in thread* Re: linux-next: build warnings after merge of the jc_docs tree
2021-03-26 7:54 linux-next: build warnings after merge of the jc_docs tree Stephen Rothwell
@ 2021-03-26 19:20 ` Jonathan Corbet
0 siblings, 0 replies; 13+ messages in thread
From: Jonathan Corbet @ 2021-03-26 19:20 UTC (permalink / raw)
To: Stephen Rothwell
Cc: Mauro Carvalho Chehab, Linux Kernel Mailing List,
Linux Next Mailing List
Stephen Rothwell <sfr@canb.auug.org.au> 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 <corbet@lwn.net>
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 <sfr@canb.auug.org.au>
Fixes: 8d295fbad687 ("kernel-doc: better handle '::' sequences")
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
---
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
^ permalink raw reply related [flat|nested] 13+ messages in thread
* linux-next: build warnings after merge of the jc_docs tree
@ 2022-10-31 6:05 Stephen Rothwell
2022-10-31 9:02 ` Bagas Sanjaya
2022-10-31 14:27 ` Jonathan Corbet
0 siblings, 2 replies; 13+ messages in thread
From: Stephen Rothwell @ 2022-10-31 6:05 UTC (permalink / raw)
To: Jonathan Corbet
Cc: Binbin Zhou, Linux Kernel Mailing List, Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 11356 bytes --]
Hi all,
After merging the jc_docs tree, today's linux-next build (htmldocs)
produced these warnings:
Documentation/core-api/timekeeping.rst:16: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:26.
Declaration is '.. c:function:: ktime_t ktime_get(void)'.
Documentation/core-api/timekeeping.rst:23: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:33.
Declaration is '.. c:function:: ktime_t ktime_get_boottime(void)'.
Documentation/core-api/timekeeping.rst:31: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:40.
Declaration is '.. c:function:: ktime_t ktime_get_real(void)'.
Documentation/core-api/timekeeping.rst:43: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:49.
Declaration is '.. c:function:: ktime_t ktime_get_clocktai(void)'.
Documentation/core-api/timekeeping.rst:51: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:56.
Declaration is '.. c:function:: ktime_t ktime_get_raw(void)'.
Documentation/core-api/timekeeping.rst:65: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:68.
Declaration is '.. c:function:: u64 ktime_get_ns(void)'.
Documentation/core-api/timekeeping.rst:65: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:68.
Declaration is '.. c:function:: u64 ktime_get_boottime_ns(void)'.
Documentation/core-api/timekeeping.rst:65: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:68.
Declaration is '.. c:function:: u64 ktime_get_real_ns(void)'.
Documentation/core-api/timekeeping.rst:65: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:68.
Declaration is '.. c:function:: u64 ktime_get_clocktai_ns(void)'.
Documentation/core-api/timekeeping.rst:65: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:68.
Declaration is '.. c:function:: u64 ktime_get_raw_ns(void)'.
Documentation/core-api/timekeeping.rst:75: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:77.
Declaration is '.. c:function:: void ktime_get_ts64(struct timespec64*)'.
Documentation/core-api/timekeeping.rst:75: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:77.
Declaration is '.. c:function:: void ktime_get_boottime_ts64(struct timespec64*)'.
Documentation/core-api/timekeeping.rst:75: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:77.
Declaration is '.. c:function:: void ktime_get_real_ts64(struct timespec64*)'.
Documentation/core-api/timekeeping.rst:75: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:77.
Declaration is '.. c:function:: void ktime_get_clocktai_ts64(struct timespec64*)'.
Documentation/core-api/timekeeping.rst:75: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:77.
Declaration is '.. c:function:: void ktime_get_raw_ts64(struct timespec64*)'.
Documentation/core-api/timekeeping.rst:86: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:87.
Declaration is '.. c:function:: time64_t ktime_get_seconds(void)'.
Documentation/core-api/timekeeping.rst:86: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:87.
Declaration is '.. c:function:: time64_t ktime_get_boottime_seconds(void)'.
Documentation/core-api/timekeeping.rst:86: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:87.
Declaration is '.. c:function:: time64_t ktime_get_real_seconds(void)'.
Documentation/core-api/timekeeping.rst:86: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:87.
Declaration is '.. c:function:: time64_t ktime_get_clocktai_seconds(void)'.
Documentation/core-api/timekeeping.rst:86: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:87.
Declaration is '.. c:function:: time64_t ktime_get_raw_seconds(void)'.
Documentation/core-api/timekeeping.rst:102: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:101.
Declaration is '.. c:function:: ktime_t ktime_get_coarse(void)'.
Documentation/core-api/timekeeping.rst:102: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:101.
Declaration is '.. c:function:: ktime_t ktime_get_coarse_boottime(void)'.
Documentation/core-api/timekeeping.rst:102: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:101.
Declaration is '.. c:function:: ktime_t ktime_get_coarse_real(void)'.
Documentation/core-api/timekeeping.rst:102: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:101.
Declaration is '.. c:function:: ktime_t ktime_get_coarse_clocktai(void)'.
Documentation/core-api/timekeeping.rst:107: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:106.
Declaration is '.. c:function:: u64 ktime_get_coarse_ns(void)'.
Documentation/core-api/timekeeping.rst:107: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:106.
Declaration is '.. c:function:: u64 ktime_get_coarse_boottime_ns(void)'.
Documentation/core-api/timekeeping.rst:107: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:106.
Declaration is '.. c:function:: u64 ktime_get_coarse_real_ns(void)'.
Documentation/core-api/timekeeping.rst:107: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:106.
Declaration is '.. c:function:: u64 ktime_get_coarse_clocktai_ns(void)'.
Documentation/core-api/timekeeping.rst:112: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:111.
Declaration is '.. c:function:: void ktime_get_coarse_ts64(struct timespec64*)'.
Documentation/core-api/timekeeping.rst:112: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:111.
Declaration is '.. c:function:: void ktime_get_coarse_boottime_ts64(struct timespec64*)'.
Documentation/core-api/timekeeping.rst:112: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:111.
Declaration is '.. c:function:: void ktime_get_coarse_real_ts64(struct timespec64*)'.
Documentation/core-api/timekeeping.rst:112: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:111.
Declaration is '.. c:function:: void ktime_get_coarse_clocktai_ts64(struct timespec64*)'.
Documentation/core-api/timekeeping.rst:132: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:126.
Declaration is '.. c:function:: u64 ktime_get_mono_fast_ns(void)'.
Documentation/core-api/timekeeping.rst:132: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:126.
Declaration is '.. c:function:: u64 ktime_get_raw_fast_ns(void)'.
Documentation/core-api/timekeeping.rst:132: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:126.
Declaration is '.. c:function:: u64 ktime_get_boot_fast_ns(void)'.
Documentation/core-api/timekeeping.rst:132: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:126.
Declaration is '.. c:function:: u64 ktime_get_tai_fast_ns(void)'.
Documentation/core-api/timekeeping.rst:132: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:126.
Declaration is '.. c:function:: u64 ktime_get_real_fast_ns(void)'.
Documentation/core-api/timekeeping.rst:154: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:144.
Declaration is '.. c:function:: void ktime_get_ts(struct timespec*)'.
Documentation/core-api/timekeeping.rst:158: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:148.
Declaration is '.. c:function:: void do_gettimeofday(struct timeval*)'.
Documentation/core-api/timekeeping.rst:158: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:148.
Declaration is '.. c:function:: void getnstimeofday(struct timespec*)'.
Documentation/core-api/timekeeping.rst:158: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:148.
Declaration is '.. c:function:: void getnstimeofday64(struct timespec64*)'.
Documentation/core-api/timekeeping.rst:158: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:148.
Declaration is '.. c:function:: void ktime_get_real_ts(struct timespec*)'.
Documentation/core-api/timekeeping.rst:167: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:157.
Declaration is '.. c:function:: struct timespec current_kernel_time(void)'.
Documentation/core-api/timekeeping.rst:167: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:157.
Declaration is '.. c:function:: struct timespec64 current_kernel_time64(void)'.
Documentation/core-api/timekeeping.rst:167: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:157.
Declaration is '.. c:function:: struct timespec get_monotonic_coarse(void)'.
Documentation/core-api/timekeeping.rst:167: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:157.
Declaration is '.. c:function:: struct timespec64 get_monotonic_coarse64(void)'.
Documentation/core-api/timekeeping.rst:178: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:166.
Declaration is '.. c:function:: struct timespec getrawmonotonic(void)'.
Documentation/core-api/timekeeping.rst:178: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:166.
Declaration is '.. c:function:: struct timespec64 getrawmonotonic64(void)'.
Documentation/core-api/timekeeping.rst:178: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:166.
Declaration is '.. c:function:: struct timespec timekeeping_clocktai(void)'.
Documentation/core-api/timekeeping.rst:178: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:166.
Declaration is '.. c:function:: struct timespec64 timekeeping_clocktai64(void)'.
Documentation/core-api/timekeeping.rst:178: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:166.
Declaration is '.. c:function:: struct timespec get_monotonic_boottime(void)'.
Documentation/core-api/timekeeping.rst:178: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:166.
Declaration is '.. c:function:: struct timespec64 get_monotonic_boottime64(void)'.
Presumably introduced by commit
d24c911bd031 ("docs/zh_CN: core-api: Add timekeeping Chinese translation")
but I have no idea why :-(
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 13+ messages in thread* Re: linux-next: build warnings after merge of the jc_docs tree
2022-10-31 6:05 Stephen Rothwell
@ 2022-10-31 9:02 ` Bagas Sanjaya
2022-10-31 14:27 ` Jonathan Corbet
1 sibling, 0 replies; 13+ messages in thread
From: Bagas Sanjaya @ 2022-10-31 9:02 UTC (permalink / raw)
To: Stephen Rothwell, Jonathan Corbet
Cc: Binbin Zhou, Linux Kernel Mailing List, Linux Next Mailing List,
Linux Doc Mailing List
On 10/31/22 13:05, Stephen Rothwell wrote:
> Hi all,
>
> After merging the jc_docs tree, today's linux-next build (htmldocs)
> produced these warnings:
>
> Documentation/core-api/timekeeping.rst:16: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:26.
> Declaration is '.. c:function:: ktime_t ktime_get(void)'.
> Documentation/core-api/timekeeping.rst:23: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:33.
> Declaration is '.. c:function:: ktime_t ktime_get_boottime(void)'.
> Documentation/core-api/timekeeping.rst:31: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:40.
> Declaration is '.. c:function:: ktime_t ktime_get_real(void)'.
> Documentation/core-api/timekeeping.rst:43: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:49.
> Declaration is '.. c:function:: ktime_t ktime_get_clocktai(void)'.
> Documentation/core-api/timekeeping.rst:51: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:56.
> Declaration is '.. c:function:: ktime_t ktime_get_raw(void)'.
> Documentation/core-api/timekeeping.rst:65: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:68.
> Declaration is '.. c:function:: u64 ktime_get_ns(void)'.
> Documentation/core-api/timekeeping.rst:65: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:68.
> Declaration is '.. c:function:: u64 ktime_get_boottime_ns(void)'.
> Documentation/core-api/timekeeping.rst:65: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:68.
> Declaration is '.. c:function:: u64 ktime_get_real_ns(void)'.
> Documentation/core-api/timekeeping.rst:65: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:68.
> Declaration is '.. c:function:: u64 ktime_get_clocktai_ns(void)'.
> Documentation/core-api/timekeeping.rst:65: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:68.
> Declaration is '.. c:function:: u64 ktime_get_raw_ns(void)'.
> Documentation/core-api/timekeeping.rst:75: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:77.
> Declaration is '.. c:function:: void ktime_get_ts64(struct timespec64*)'.
> Documentation/core-api/timekeeping.rst:75: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:77.
> Declaration is '.. c:function:: void ktime_get_boottime_ts64(struct timespec64*)'.
> Documentation/core-api/timekeeping.rst:75: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:77.
> Declaration is '.. c:function:: void ktime_get_real_ts64(struct timespec64*)'.
> Documentation/core-api/timekeeping.rst:75: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:77.
> Declaration is '.. c:function:: void ktime_get_clocktai_ts64(struct timespec64*)'.
> Documentation/core-api/timekeeping.rst:75: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:77.
> Declaration is '.. c:function:: void ktime_get_raw_ts64(struct timespec64*)'.
> Documentation/core-api/timekeeping.rst:86: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:87.
> Declaration is '.. c:function:: time64_t ktime_get_seconds(void)'.
> Documentation/core-api/timekeeping.rst:86: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:87.
> Declaration is '.. c:function:: time64_t ktime_get_boottime_seconds(void)'.
> Documentation/core-api/timekeeping.rst:86: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:87.
> Declaration is '.. c:function:: time64_t ktime_get_real_seconds(void)'.
> Documentation/core-api/timekeeping.rst:86: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:87.
> Declaration is '.. c:function:: time64_t ktime_get_clocktai_seconds(void)'.
> Documentation/core-api/timekeeping.rst:86: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:87.
> Declaration is '.. c:function:: time64_t ktime_get_raw_seconds(void)'.
> Documentation/core-api/timekeeping.rst:102: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:101.
> Declaration is '.. c:function:: ktime_t ktime_get_coarse(void)'.
> Documentation/core-api/timekeeping.rst:102: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:101.
> Declaration is '.. c:function:: ktime_t ktime_get_coarse_boottime(void)'.
> Documentation/core-api/timekeeping.rst:102: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:101.
> Declaration is '.. c:function:: ktime_t ktime_get_coarse_real(void)'.
> Documentation/core-api/timekeeping.rst:102: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:101.
> Declaration is '.. c:function:: ktime_t ktime_get_coarse_clocktai(void)'.
> Documentation/core-api/timekeeping.rst:107: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:106.
> Declaration is '.. c:function:: u64 ktime_get_coarse_ns(void)'.
> Documentation/core-api/timekeeping.rst:107: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:106.
> Declaration is '.. c:function:: u64 ktime_get_coarse_boottime_ns(void)'.
> Documentation/core-api/timekeeping.rst:107: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:106.
> Declaration is '.. c:function:: u64 ktime_get_coarse_real_ns(void)'.
> Documentation/core-api/timekeeping.rst:107: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:106.
> Declaration is '.. c:function:: u64 ktime_get_coarse_clocktai_ns(void)'.
> Documentation/core-api/timekeeping.rst:112: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:111.
> Declaration is '.. c:function:: void ktime_get_coarse_ts64(struct timespec64*)'.
> Documentation/core-api/timekeeping.rst:112: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:111.
> Declaration is '.. c:function:: void ktime_get_coarse_boottime_ts64(struct timespec64*)'.
> Documentation/core-api/timekeeping.rst:112: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:111.
> Declaration is '.. c:function:: void ktime_get_coarse_real_ts64(struct timespec64*)'.
> Documentation/core-api/timekeeping.rst:112: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:111.
> Declaration is '.. c:function:: void ktime_get_coarse_clocktai_ts64(struct timespec64*)'.
> Documentation/core-api/timekeeping.rst:132: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:126.
> Declaration is '.. c:function:: u64 ktime_get_mono_fast_ns(void)'.
> Documentation/core-api/timekeeping.rst:132: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:126.
> Declaration is '.. c:function:: u64 ktime_get_raw_fast_ns(void)'.
> Documentation/core-api/timekeeping.rst:132: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:126.
> Declaration is '.. c:function:: u64 ktime_get_boot_fast_ns(void)'.
> Documentation/core-api/timekeeping.rst:132: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:126.
> Declaration is '.. c:function:: u64 ktime_get_tai_fast_ns(void)'.
> Documentation/core-api/timekeeping.rst:132: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:126.
> Declaration is '.. c:function:: u64 ktime_get_real_fast_ns(void)'.
> Documentation/core-api/timekeeping.rst:154: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:144.
> Declaration is '.. c:function:: void ktime_get_ts(struct timespec*)'.
> Documentation/core-api/timekeeping.rst:158: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:148.
> Declaration is '.. c:function:: void do_gettimeofday(struct timeval*)'.
> Documentation/core-api/timekeeping.rst:158: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:148.
> Declaration is '.. c:function:: void getnstimeofday(struct timespec*)'.
> Documentation/core-api/timekeeping.rst:158: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:148.
> Declaration is '.. c:function:: void getnstimeofday64(struct timespec64*)'.
> Documentation/core-api/timekeeping.rst:158: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:148.
> Declaration is '.. c:function:: void ktime_get_real_ts(struct timespec*)'.
> Documentation/core-api/timekeeping.rst:167: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:157.
> Declaration is '.. c:function:: struct timespec current_kernel_time(void)'.
> Documentation/core-api/timekeeping.rst:167: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:157.
> Declaration is '.. c:function:: struct timespec64 current_kernel_time64(void)'.
> Documentation/core-api/timekeeping.rst:167: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:157.
> Declaration is '.. c:function:: struct timespec get_monotonic_coarse(void)'.
> Documentation/core-api/timekeeping.rst:167: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:157.
> Declaration is '.. c:function:: struct timespec64 get_monotonic_coarse64(void)'.
> Documentation/core-api/timekeeping.rst:178: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:166.
> Declaration is '.. c:function:: struct timespec getrawmonotonic(void)'.
> Documentation/core-api/timekeeping.rst:178: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:166.
> Declaration is '.. c:function:: struct timespec64 getrawmonotonic64(void)'.
> Documentation/core-api/timekeeping.rst:178: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:166.
> Declaration is '.. c:function:: struct timespec timekeeping_clocktai(void)'.
> Documentation/core-api/timekeeping.rst:178: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:166.
> Declaration is '.. c:function:: struct timespec64 timekeeping_clocktai64(void)'.
> Documentation/core-api/timekeeping.rst:178: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:166.
> Declaration is '.. c:function:: struct timespec get_monotonic_boottime(void)'.
> Documentation/core-api/timekeeping.rst:178: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:166.
> Declaration is '.. c:function:: struct timespec64 get_monotonic_boottime64(void)'.
>
> Presumably introduced by commit
>
> d24c911bd031 ("docs/zh_CN: core-api: Add timekeeping Chinese translation")
>
> but I have no idea why :-(
>
The only other place in Documentation/translations/zh_CN where
Sphinx C domain syntax is used is in doc-guide/sphinx.rst, but it is under
code block (since the doc is about writing the doc itself).
Cc'ing linux-doc folks.
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply [flat|nested] 13+ messages in thread* Re: linux-next: build warnings after merge of the jc_docs tree
2022-10-31 6:05 Stephen Rothwell
2022-10-31 9:02 ` Bagas Sanjaya
@ 2022-10-31 14:27 ` Jonathan Corbet
1 sibling, 0 replies; 13+ messages in thread
From: Jonathan Corbet @ 2022-10-31 14:27 UTC (permalink / raw)
To: Stephen Rothwell
Cc: Binbin Zhou, Linux Kernel Mailing List, Linux Next Mailing List
Stephen Rothwell <sfr@canb.auug.org.au> writes:
> After merging the jc_docs tree, today's linux-next build (htmldocs)
> produced these warnings:
>
> Documentation/core-api/timekeeping.rst:16: WARNING: Duplicate C declaration, also defined at translations/zh_CN/core-api/timekeeping:26.
> Declaration is '.. c:function:: ktime_t ktime_get(void)'.
[...]
> Presumably introduced by commit
>
> d24c911bd031 ("docs/zh_CN: core-api: Add timekeeping Chinese translation")
>
> but I have no idea why :-(
"Why" is the ".. c:function::" definitions in core-api/timekeeping.rst.
The translation duplicated those, leading to the warnings you mention.
I should have caught that, but the old (fast!) version of sphinx I used
to check things doesn't put out that warning. I'm just going to have to
be more patient, I guess.
I've reverted the commit in question. I'm not sure what the best
practice should be for translating documents with those declarations in
them. Perhaps the function prototype should just go into a literal
block without the c:function declaration?
Thanks,
jon
^ permalink raw reply [flat|nested] 13+ messages in thread
* linux-next: build warnings after merge of the jc_docs tree
@ 2022-01-27 3:15 Stephen Rothwell
2022-01-27 3:36 ` Stephen Rothwell
2022-01-27 18:22 ` Jonathan Corbet
0 siblings, 2 replies; 13+ messages in thread
From: Stephen Rothwell @ 2022-01-27 3:15 UTC (permalink / raw)
To: Jonathan Corbet; +Cc: Linux Kernel Mailing List, Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 432 bytes --]
Hi all,
After merging the jc_docs tree, today's linux-next build (htmldocs)
produced these warnings:
Documentation/tools/index.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
Documentation/tools/index.rst: WARNING: document isn't included in any toctree
Introduced by commit
1ce5371ee32f ("docs: Hook the RTLA documents into the kernel docs build")
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 13+ messages in thread* Re: linux-next: build warnings after merge of the jc_docs tree
2022-01-27 3:15 Stephen Rothwell
@ 2022-01-27 3:36 ` Stephen Rothwell
2022-01-27 18:22 ` Jonathan Corbet
1 sibling, 0 replies; 13+ messages in thread
From: Stephen Rothwell @ 2022-01-27 3:36 UTC (permalink / raw)
To: Jonathan Corbet; +Cc: Linux Kernel Mailing List, Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 659 bytes --]
Hi all,
On Thu, 27 Jan 2022 14:15:18 +1100 Stephen Rothwell <sfr@canb.auug.org.au> wrote:
>
> After merging the jc_docs tree, today's linux-next build (htmldocs)
> produced these warnings:
>
> Documentation/tools/index.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
> Documentation/tools/index.rst: WARNING: document isn't included in any toctree
>
> Introduced by commit
>
> 1ce5371ee32f ("docs: Hook the RTLA documents into the kernel docs build")
Also:
Documentation/tools/rtla/index.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 13+ messages in thread* Re: linux-next: build warnings after merge of the jc_docs tree
2022-01-27 3:15 Stephen Rothwell
2022-01-27 3:36 ` Stephen Rothwell
@ 2022-01-27 18:22 ` Jonathan Corbet
1 sibling, 0 replies; 13+ messages in thread
From: Jonathan Corbet @ 2022-01-27 18:22 UTC (permalink / raw)
To: Stephen Rothwell; +Cc: Linux Kernel Mailing List, Linux Next Mailing List
Stephen Rothwell <sfr@canb.auug.org.au> writes:
> Hi all,
>
> After merging the jc_docs tree, today's linux-next build (htmldocs)
> produced these warnings:
>
> Documentation/tools/index.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
> Documentation/tools/index.rst: WARNING: document isn't included in any toctree
So this is bizarre...somehow the change to Documentation/index.rst that
brings all this stuff in didn't survive the cherry-pick that brought
that change into docs-next. No idea how that came to be.
The other warning, instead, was just me being dumb about inserting the
SPDX lines and forgetting the necessary blank line.
Fixed (forcing a rebase of docs-next), apologies for the noise,
jon
^ permalink raw reply [flat|nested] 13+ messages in thread
* linux-next: build warnings after merge of the jc_docs tree
@ 2021-03-10 3:20 Stephen Rothwell
0 siblings, 0 replies; 13+ messages in thread
From: Stephen Rothwell @ 2021-03-10 3:20 UTC (permalink / raw)
To: Jonathan Corbet
Cc: Wu XiangCheng, Linux Kernel Mailing List, Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 607 bytes --]
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
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 13+ messages in thread* linux-next: build warnings after merge of the jc_docs tree
@ 2021-01-19 6:13 Stephen Rothwell
2021-01-19 6:45 ` Stephen Rothwell
` (2 more replies)
0 siblings, 3 replies; 13+ messages in thread
From: Stephen Rothwell @ 2021-01-19 6:13 UTC (permalink / raw)
To: Jonathan Corbet
Cc: Mauro Carvalho Chehab, Linux Kernel Mailing List,
Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 6441 bytes --]
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/rapidio/rio.c:758: warning: expecting prototype for rio_unmap_inb_region(). Prototype was for rio_unmap_outb_region() instead
include/linux/w1.h:292: warning: expecting prototype for module_w1_driver(). Prototype was for module_w1_family() instead
drivers/rapidio/rio.c:758: warning: expecting prototype for rio_unmap_inb_region(). Prototype was for rio_unmap_outb_region() instead
fs/dcache.c:477: warning: expecting prototype for d_drop(). Prototype was for ___d_drop() instead
fs/dcache.c:1014: warning: expecting prototype for d_find_alias(). Prototype was for __d_find_alias() instead
fs/inode.c:1517: warning: expecting prototype for find_inode_by_rcu(). Prototype was for find_inode_by_ino_rcu() instead
fs/inode.c:1792: warning: expecting prototype for touch_atime(). Prototype was for atime_needs_update() instead
fs/super.c:1728: warning: expecting prototype for thaw_super(). Prototype was for thaw_super_locked() instead
fs/seq_file.c:1056: warning: expecting prototype for seq_hlist_start_precpu(). Prototype was for seq_hlist_start_percpu() instead
drivers/parport/share.c:280: warning: expecting prototype for parport_register_driver(). Prototype was for __parport_register_driver() instead
lib/crc7.c:66: warning: expecting prototype for crc7(). Prototype was for crc7_be() instead
Exposed by commit
52042e2db452 ("scripts: kernel-doc: validate kernel-doc markup with the actual names")
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 13+ messages in thread* Re: linux-next: build warnings after merge of the jc_docs tree
2021-01-19 6:13 Stephen Rothwell
@ 2021-01-19 6:45 ` Stephen Rothwell
2021-01-19 7:16 ` Stephen Rothwell
2021-01-19 9:07 ` Mauro Carvalho Chehab
2 siblings, 0 replies; 13+ messages in thread
From: Stephen Rothwell @ 2021-01-19 6:45 UTC (permalink / raw)
To: Jonathan Corbet
Cc: Mauro Carvalho Chehab, Linux Kernel Mailing List,
Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 251 bytes --]
Hi all,
On Tue, 19 Jan 2021 17:13:03 +1100 Stephen Rothwell <sfr@canb.auug.org.au> wrote:
>
> Hi all,
>
> After merging the jc_docs tree, today's linux-next build (KCONFIG_NAME)
This was a "make htmldocs"
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 13+ messages in thread
* Re: linux-next: build warnings after merge of the jc_docs tree
2021-01-19 6:13 Stephen Rothwell
2021-01-19 6:45 ` Stephen Rothwell
@ 2021-01-19 7:16 ` Stephen Rothwell
2021-01-19 9:07 ` Mauro Carvalho Chehab
2 siblings, 0 replies; 13+ messages in thread
From: Stephen Rothwell @ 2021-01-19 7:16 UTC (permalink / raw)
To: Jonathan Corbet
Cc: Mauro Carvalho Chehab, Linux Kernel Mailing List,
Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 7449 bytes --]
Hi all,
On Tue, 19 Jan 2021 17:13:03 +1100 Stephen Rothwell <sfr@canb.auug.org.au> 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 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 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
fs/seq_file.c:672: warning: wrong kernel-doc identifier on line:
* A helper routine for putting decimal numbers without rich format of printf().
lib/crc7.c:1: warning: no structured comments found
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 13+ messages in thread
* Re: linux-next: build warnings after merge of the jc_docs tree
2021-01-19 6:13 Stephen Rothwell
2021-01-19 6:45 ` Stephen Rothwell
2021-01-19 7:16 ` Stephen Rothwell
@ 2021-01-19 9:07 ` Mauro Carvalho Chehab
2 siblings, 0 replies; 13+ messages in thread
From: Mauro Carvalho Chehab @ 2021-01-19 9:07 UTC (permalink / raw)
To: Stephen Rothwell
Cc: Jonathan Corbet, Linux Kernel Mailing List, Linux Next Mailing List
Hi Stephen,
Em Tue, 19 Jan 2021 17:13:03 +1100
Stephen Rothwell <sfr@canb.auug.org.au> 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 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/rapidio/rio.c:758: warning: expecting prototype for rio_unmap_inb_region(). Prototype was for rio_unmap_outb_region() instead
> include/linux/w1.h:292: warning: expecting prototype for module_w1_driver(). Prototype was for module_w1_family() instead
> drivers/rapidio/rio.c:758: warning: expecting prototype for rio_unmap_inb_region(). Prototype was for rio_unmap_outb_region() instead
> fs/dcache.c:477: warning: expecting prototype for d_drop(). Prototype was for ___d_drop() instead
> fs/dcache.c:1014: warning: expecting prototype for d_find_alias(). Prototype was for __d_find_alias() instead
> fs/inode.c:1517: warning: expecting prototype for find_inode_by_rcu(). Prototype was for find_inode_by_ino_rcu() instead
> fs/inode.c:1792: warning: expecting prototype for touch_atime(). Prototype was for atime_needs_update() instead
> fs/super.c:1728: warning: expecting prototype for thaw_super(). Prototype was for thaw_super_locked() instead
> fs/seq_file.c:1056: warning: expecting prototype for seq_hlist_start_precpu(). Prototype was for seq_hlist_start_percpu() instead
> drivers/parport/share.c:280: warning: expecting prototype for parport_register_driver(). Prototype was for __parport_register_driver() instead
> lib/crc7.c:66: warning: expecting prototype for crc7(). Prototype was for crc7_be() instead
>
> Exposed by commit
>
> 52042e2db452 ("scripts: kernel-doc: validate kernel-doc markup with the actual names")
Having some extra warnings were already expected ;-)
The problem is that a kernel-doc markup like:
/**
* foo() - some desciption
*/
void bar(void) {}
Produces:
.. c:function:: void bar (void)
some desciption
**Parameters**
``void``
no argument
In other words, kernel-doc documents function "bar()", using the text
from the function "foo()" markup.
While, on several cases, this is what it was expected, we've got several
problems already, where some other function was added between
the kernel-doc markup and the function it documents, causing
troubles on its documentation.
So, we added a kernel-doc warning to let the developers to know
that the function documented has a different name on its kernel-doc
markup.
Thanks,
Mauro
^ permalink raw reply [flat|nested] 13+ messages in thread
end of thread, other threads:[~2022-10-31 14:27 UTC | newest]
Thread overview: 13+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-03-26 7:54 linux-next: build warnings after merge of the jc_docs tree Stephen Rothwell
2021-03-26 19:20 ` Jonathan Corbet
-- strict thread matches above, loose matches on Subject: below --
2022-10-31 6:05 Stephen Rothwell
2022-10-31 9:02 ` Bagas Sanjaya
2022-10-31 14:27 ` Jonathan Corbet
2022-01-27 3:15 Stephen Rothwell
2022-01-27 3:36 ` Stephen Rothwell
2022-01-27 18:22 ` Jonathan Corbet
2021-03-10 3:20 Stephen Rothwell
2021-01-19 6:13 Stephen Rothwell
2021-01-19 6:45 ` Stephen Rothwell
2021-01-19 7:16 ` Stephen Rothwell
2021-01-19 9:07 ` Mauro Carvalho Chehab
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.