Mauro Carvalho Chehab 52042e2db4
scripts: kernel-doc: validate kernel-doc markup with the actual names ...
Kernel-doc currently expects that the kernel-doc markup to come
just before the function/enum/struct/union/typedef prototype.
Yet, if it find things like:
/**
* refcount_add - add a value to a refcount
* @i: the value to add to the refcount
* @r: the refcount
*/
static inline void __refcount_add(int i, refcount_t *r, int *oldp);
static inline void refcount_add(int i, refcount_t *r);
Kernel-doc will do the wrong thing:
foobar.h:6: warning: Function parameter or member 'oldp' not described in '__refcount_add'
.. c:function:: void __refcount_add (int i, refcount_t *r, int *oldp)
add a value to a refcount
**Parameters**
``int i``
the value to add to the refcount
``refcount_t *r``
the refcount
``int *oldp``
*undescribed*
Basically, it will document "__refcount_add" with the kernel-doc
markup for refcount_add.
If both functions have the same arguments, this won't even
produce any warning!
Add a logic to check if the kernel-doc identifier matches the actual
name of the C function or data structure that will be documented.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Link: https://lore.kernel.org/r/081546f141a496d6cabb99a4adc140444c705e93.1610610937.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2021-01-18 13:33:26 -07:00
2020-11-07 13:20:41 +01:00
2020-08-10 01:32:59 +09:00
2020-08-27 00:44:33 +09:00
2020-12-15 20:55:19 +01:00
2020-10-12 09:58:15 -05:00
2020-04-09 00:13:45 +09:00
2021-01-06 15:08:23 -08:00
2020-10-16 11:11:22 -07:00
2020-12-21 13:57:08 +09:00
2021-01-04 10:38:11 +09:00
2017-03-28 16:16:52 +02:00
2020-12-22 14:02:39 -08:00
2020-11-02 11:31:00 +09:00
2020-08-17 20:42:00 -04:00
2020-12-08 23:30:04 +09:00
2020-09-25 00:36:41 +09:00
2020-03-03 20:49:21 +09:00
2019-05-24 17:27:11 +02:00
2018-07-18 01:18:05 +09:00
2020-12-08 23:30:04 +09:00
2019-06-05 17:37:11 +02:00
2020-12-04 22:32:40 +01:00
2018-06-28 13:36:39 +09:00
2017-11-02 11:10:55 +01:00
2020-02-25 03:35:16 -07:00
2017-11-02 11:10:55 +01:00
2020-08-14 13:30:03 +09:00
2020-12-29 15:36:49 -08:00
2020-05-26 00:03:16 +09:00
2019-02-19 21:27:53 +01:00
2017-11-02 11:10:55 +01:00
2019-03-04 22:34:54 +09:00
2017-11-02 11:10:55 +01:00
2017-11-02 11:10:55 +01:00
2020-12-24 12:59:43 +01:00
2021-01-04 10:38:11 +09:00
2020-10-16 11:11:21 -07:00
2020-08-07 11:33:21 -07:00
2020-10-13 18:38:26 -07:00
2021-01-01 12:26:39 -08:00
2020-09-04 18:19:37 +02:00
2020-12-08 23:30:04 +09:00
2020-04-15 15:13:13 -06:00
2020-03-17 08:59:03 +09:00
2019-06-05 17:37:07 +02:00
2020-08-18 20:16:46 +09:00
2015-04-15 14:01:12 +02:00
2017-11-02 11:10:55 +01:00
2017-11-02 11:10:55 +01:00
2019-06-05 17:37:10 +02:00
2018-11-18 10:15:09 -08:00
2018-03-26 02:01:24 +09:00
2020-01-27 14:25:06 -07:00
2019-01-06 09:46:51 +09:00
2017-11-02 11:10:55 +01:00
2019-03-04 22:35:04 +09:00
2018-06-08 18:56:00 +09:00
2018-06-25 23:21:13 +09:00
2020-03-03 20:49:21 +09:00
2018-12-01 23:13:14 +09:00
2020-12-08 23:30:04 +09:00
2019-05-24 17:36:45 +02:00
2020-12-04 14:34:27 -07:00
2020-10-16 11:11:19 -07:00
2019-05-30 11:26:39 -07:00
2017-11-02 11:10:55 +01:00
2017-11-02 11:10:55 +01:00
2020-08-07 13:29:39 -07:00
2016-02-26 15:30:20 +00:00
2019-11-22 10:35:18 -07:00
2020-09-25 00:41:54 +09:00
2020-10-21 00:28:53 +09:00
2020-06-17 10:38:42 +09:00
2021-01-18 13:33:26 -07:00
2017-11-02 11:10:55 +01:00
2019-05-30 11:26:39 -07:00
2017-11-02 11:10:55 +01:00
2020-10-22 13:13:57 -07:00
2020-12-01 22:46:06 +09:00
2020-09-25 00:36:41 +09:00
2019-03-17 12:56:32 +09:00
2020-12-06 21:09:28 +09:00
2020-08-10 01:32:59 +09:00
2020-03-25 10:19:43 +09:00
2020-12-08 23:30:05 +09:00
2020-06-24 07:48:28 -07:00
2019-11-15 00:23:10 +09:00
2020-08-10 01:32:59 +09:00
2020-09-25 00:36:50 +09:00
2020-08-10 01:32:59 +09:00
2020-10-22 13:13:57 -07:00
2020-12-22 12:55:08 -08:00
2020-11-25 00:05:01 +01:00
2019-07-17 22:39:27 +09:00
2020-08-02 23:09:16 +09:00
2019-07-17 22:39:27 +09:00
2020-06-11 20:14:41 +09:00
2020-12-15 22:46:18 -08:00
2020-05-17 18:52:01 +09:00
2017-11-02 11:10:55 +01:00
2019-06-05 17:37:10 +02:00
2020-10-21 00:46:04 +09:00
2019-08-29 23:54:29 +09:00
2020-06-06 23:39:20 +09:00
2017-11-02 11:10:55 +01:00
2020-09-25 00:36:41 +09:00
2020-05-26 00:03:16 +09:00
2020-12-12 18:31:29 +01:00
2019-05-30 11:29:23 -07:00
2020-03-26 15:08:27 -07:00
2017-11-02 11:10:55 +01:00
2017-11-02 11:10:55 +01:00
2017-11-02 11:10:55 +01:00
2020-08-10 15:22:06 +01:00
2020-06-16 21:21:00 -04:00
2020-11-20 19:19:11 +01:00
2020-09-25 02:28:12 +09:00
2020-12-08 23:30:04 +09:00
2017-02-10 12:43:47 +11:00
2020-07-20 10:55:50 +02:00
2019-12-13 10:47:58 +01:00
2018-12-28 12:11:44 -08:00
2020-10-02 11:31:26 +02:00
2020-10-15 15:11:56 -07:00
2020-12-08 23:30:04 +09:00
2020-12-08 23:30:04 +09:00
2017-11-02 11:10:55 +01:00
2017-11-02 11:10:55 +01:00
2018-09-05 08:12:09 -06:00
2020-10-09 08:55:17 +02:00
2019-11-13 10:52:05 +00:00
2018-11-30 14:45:01 -08:00
2020-02-10 13:35:15 -08:00
2017-11-02 11:10:55 +01:00
2020-06-06 23:42:01 +09:00
52042e2db4