From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Linux Documentation <linux-doc@vger.kernel.org>,
Linux Memory Management List <linux-mm@kvack.org>,
LKML <linux-kernel@vger.kernel.org>,
Linus Torvalds <torvalds@linux-foundation.org>
Cc: Andrew Morton <akpm@linux-foundation.org>,
"Matthew Wilcox (Oracle)" <willy@infradead.org>,
Vlastimil Babka <vbabka@suse.cz>,
David Hildenbrand <david@redhat.com>,
Hugh Dickins <hughd@google.com>,
"Liam R. Howlett" <Liam.Howlett@oracle.com>,
Peter Xu <peterx@redhat.com>, Yu Zhao <yuzhao@google.com>,
Colin Cross <ccross@google.com>, Arnd Bergmann <arnd@arndb.de>,
Pasha Tatashin <pasha.tatashin@soleen.com>
Subject: Cannot parse struct or union error on mm-everything
Date: Sat, 19 Nov 2022 11:10:15 +0700 [thread overview]
Message-ID: <Y3hXJ0D+qAwfpm7B@debian.me> (raw)
[-- Attachment #1: Type: text/plain, Size: 1698 bytes --]
Greetings,
I found a new htmldocs warning on mm-everything:
WARNING: kernel-doc './scripts/kernel-doc -rst -enable-lineno -sphinx-version 2.4.4 -internal ./include/linux/mm_types.h' failed with return code 1
Checking the header with './scripts/kernel-doc -v -none
./include/linux/mm_types.h', I got the full error:
include/linux/mm_types.h:255: info: Scanning doc for struct encoded_page
include/linux/mm_types.h:268: error: Cannot parse struct or union!
include/linux/mm_types.h:287: info: Scanning doc for struct folio
include/linux/mm_types.h:917: info: Scanning doc for typedef vm_fault_t
include/linux/mm_types.h:924: info: Scanning doc for enum vm_fault_reason
include/linux/mm_types.h:1028: info: Scanning doc for enum fault_flag
1 errors
The culprit is encoded_page struct, which is null struct (nonexistent type)
with kernel-doc comments:
/**
* struct encoded_page - a nonexistent type marking this pointer
*
* An 'encoded_page' pointer is a pointer to a regular 'struct page', but
* with the low bits of the pointer indicating extra context-dependent
* information. Not super-common, but happens in mmu_gather and mlock
* handling, and this acts as a type system check on that use.
*
* We only really have two guaranteed bits in general, although you could
* play with 'struct page' alignment (see CONFIG_HAVE_ALIGNED_STRUCT_PAGE)
* for more.
*
* Use the supplied helper functions to endcode/decode the pointer and bits.
*/
struct encoded_page;
The struct is introduced by d57ab372568585 ("mm: introduce 'encoded' page
pointers with embedded extra bits").
Thanks.
--
An old man doll... just what I always wanted! - Clara
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
next reply other threads:[~2022-11-19 4:10 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-19 4:10 Bagas Sanjaya [this message]
2022-11-19 5:26 ` Randy Dunlap
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=Y3hXJ0D+qAwfpm7B@debian.me \
--to=bagasdotme@gmail.com \
--cc=Liam.Howlett@oracle.com \
--cc=akpm@linux-foundation.org \
--cc=arnd@arndb.de \
--cc=ccross@google.com \
--cc=david@redhat.com \
--cc=hughd@google.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=pasha.tatashin@soleen.com \
--cc=peterx@redhat.com \
--cc=torvalds@linux-foundation.org \
--cc=vbabka@suse.cz \
--cc=willy@infradead.org \
--cc=yuzhao@google.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox