Files
linux/include/linux
Fabio M. De Francesco e7392b4eca mm/highmem: fix kernel-doc warnings in highmem*.h
Patch series "Extend and reorganize Highmem's documentation", v4.

This series has the purpose to extend and reorganize Highmem's
documentation.

This is a work in progress because some information should still be moved
from highmem.rst to highmem.h and highmem-internal.h.  Specifically I'm
talking about moving the "how to" information to the relevant headers, as
it as been suggested by Ira Weiny (Intel).

Also, this is a work in progress because some kdocs in highmem.h and
highmem-internal.h should be improved.


This patch (of 4):

`scripts/kernel-doc -v -none include/linux/highmem*` reports the following
warnings:

include/linux/highmem.h:160: warning: expecting prototype for kunmap_atomic(). Prototype was for nr_free_highpages() instead
include/linux/highmem.h:204: warning: No description found for return value of 'alloc_zeroed_user_highpage_movable'
include/linux/highmem-internal.h:256: warning: Function parameter or member '__addr' not described in 'kunmap_atomic'
include/linux/highmem-internal.h:256: warning: Excess function parameter 'addr' description in 'kunmap_atomic'

Fix these warnings by (1) moving the kernel-doc comments from highmem.h to
highmem-internal.h (which is the file were the kunmap_atomic() macro is
actually defined), (2) extending and merging it with the comment which was
already in highmem-internal.h, and (3) using correct parameter names (4)
correcting a few technical inaccuracies in comments, and (5) adding a
deprecation notice in kunmap_atomic() for consistency with kmap_atomic().

Link: https://lkml.kernel.org/r/20220428212455.892-1-fmdefrancesco@gmail.com
Link: https://lkml.kernel.org/r/20220428212455.892-2-fmdefrancesco@gmail.com
Signed-off-by: Fabio M. De Francesco <fmdefrancesco@gmail.com>
Reviewed-by: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
Reviewed-by: Ira Weiny <ira.weiny@intel.com>
Cc: Matthew Wilcox <willy@infradead.org>
Cc: Mike Rapoport <rppt@linux.ibm.com>
Cc: Catalin Marinas <catalin.marinas@arm.com>
Cc: Will Deacon <will@kernel.org>
Cc: Peter Collingbourne <pcc@google.com>
Cc: Vlastimil Babka <vbabka@suse.cz>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
2022-05-13 16:48:55 -07:00
..
2022-02-27 13:38:10 +00:00
2022-03-23 19:58:38 +01:00
2022-02-01 14:25:50 +02:00
2022-01-22 08:33:34 +02:00
2022-01-15 08:47:31 -08:00
2022-03-08 19:39:38 -07:00
2022-03-17 20:17:18 -07:00
2022-03-11 19:15:03 -08:00
2021-09-08 15:32:35 -07:00
2022-03-15 10:32:44 +01:00
2021-12-10 17:10:55 -08:00
2022-02-07 16:35:35 -08:00
2021-12-10 12:51:28 +01:00
2021-08-26 15:32:28 -04:00
2021-07-27 11:00:36 +02:00
2021-09-06 07:20:56 -04:00
2022-03-16 15:13:36 -07:00
2022-01-15 08:47:31 -08:00
2022-02-13 16:50:07 -08:00
2022-05-09 18:20:49 -07:00
2022-05-13 07:20:18 -07:00
2021-07-26 15:09:44 +02:00
2022-01-20 08:52:54 +02:00
2021-07-27 20:11:45 +01:00
2021-07-27 20:11:44 +01:00
2022-03-02 22:44:49 -08:00
2021-08-05 11:46:42 +01:00
2022-02-28 23:26:27 -08:00
2022-03-15 08:23:29 -04:00
2022-02-28 13:25:49 +01:00
2022-02-19 19:23:53 -08:00
2022-02-14 15:43:15 +01:00
2021-10-05 06:54:16 -05:00
2022-02-05 15:20:34 +00:00
2021-07-27 17:05:06 +01:00
2022-03-18 09:47:04 +01:00
2022-01-27 13:53:26 +00:00
2021-09-30 12:46:44 -06:00
2022-03-21 12:57:38 -04:00
2022-05-13 07:20:17 -07:00
2022-04-28 23:16:14 -07:00
2021-07-01 11:06:05 -07:00
2021-12-16 22:22:20 +01:00
2021-08-23 13:19:12 +02:00
2022-04-01 14:40:44 -04:00
2022-02-09 09:24:40 -05:00
2022-02-28 13:45:04 +02:00
2022-01-12 10:14:09 -06:00
2021-11-16 19:07:53 -08:00
2021-09-17 13:52:17 +01:00
2021-09-27 09:27:29 -04:00
2022-05-13 07:20:17 -07:00
2022-04-01 13:45:08 -04:00
2022-02-02 07:49:59 -07:00
2021-09-27 17:00:21 +02:00
2021-07-06 10:37:46 -05:00
2022-02-09 08:04:44 +01:00
2022-02-09 08:04:44 +01:00
2021-10-14 13:29:18 +02:00
2022-04-19 10:19:02 -07:00
2021-08-18 22:08:24 +02:00
2022-01-22 08:33:37 +02:00
2022-01-08 12:43:57 -06:00
2021-11-18 09:36:39 +01:00
2022-01-24 14:45:02 +01:00
2022-03-08 14:33:36 -06:00
2022-03-17 20:16:29 -07:00
2022-03-23 19:58:41 +01:00
2022-02-24 15:04:51 +00:00
2021-08-06 13:41:48 -07:00
2021-08-19 09:02:55 +09:00
2021-11-03 11:41:25 -07:00
2022-05-13 07:20:16 -07:00
2022-05-13 07:20:09 -07:00
2022-02-25 09:36:06 +01:00
2022-04-11 19:18:27 -06:00
2022-02-16 07:49:41 +01:00
2022-03-22 15:57:11 -07:00
2021-11-25 18:35:23 +01:00
2022-01-26 14:54:48 +01:00
2022-01-27 13:53:27 +00:00
2021-10-12 11:41:39 -03:00
2021-12-30 12:13:04 +01:00
2022-03-28 16:53:00 -04:00
2021-08-11 06:44:24 -04:00
2021-12-09 10:49:56 -08:00
2021-10-19 23:44:30 +08:00