2022-09-19 09:48:55

by Stephen Rothwell

[permalink] [raw]

Subject: linux-next: build warning after merge of the mm tree

---

Hi all,

After merging the mm tree, today's linux-next build (htmldocs) produced
this warning:

include/linux/gfp.h:1: warning: no structured comments found

Introduced by commit

4f57293dcaaa ("mm/page_alloc: remove obsolete gfpflags_normal_context()")

--
Cheers,
Stephen Rothwell

---

Attachments:

(No filename) (499.00 B)
OpenPGP digital signature

2022-09-19 10:18:05

by Miaohe Lin

[permalink] [raw]

Subject: Re: linux-next: build warning after merge of the mm tree

---

On 2022/9/19 17:09, Stephen Rothwell wrote:
> Hi all,
>
> After merging the mm tree, today's linux-next build (htmldocs) produced
> this warning:
>
> include/linux/gfp.h:1: warning: no structured comments found
>
> Introduced by commit
>
> 4f57293dcaaa ("mm/page_alloc: remove obsolete gfpflags_normal_context()")

Many thanks for report. It seems there's no structured comments for htmldocs left
after above commit. So I think htmldocs for this file should be deleted. Does below
code change fixes the warning?

diff --git a/Documentation/core-api/mm-api.rst b/Documentation/core-api/mm-api.rst
index 1ebcc6c3fafe..f5dde5bceaea 100644
--- a/Documentation/core-api/mm-api.rst
+++ b/Documentation/core-api/mm-api.rst
@@ -19,9 +19,6 @@ User Space Memory Access
Memory Allocation Controls
==========================

-.. kernel-doc:: include/linux/gfp.h
- :internal:
-
.. kernel-doc:: include/linux/gfp_types.h
:doc: Page mobility and placement hints

It will be really appreciated if you can help verify this. Thanks a lot. :)

Thanks,
Miaohe Lin