diff options
| author | Rob Herring <robh@kernel.org> | 2021-04-21 10:39:36 -0500 |
|---|---|---|
| committer | Rob Herring <robh@kernel.org> | 2021-04-21 16:05:53 -0500 |
| commit | aed4349c5d259c970f24dd8c84255ab8a5cd4a7d (patch) | |
| tree | 5acce0f88d0700ef59eceaf13edfa39c2e081242 /drivers/of | |
| parent | c968b89a1d446ec4a1ed3022ebd79d36de5ea1eb (diff) | |
of: overlay: Fix kerneldoc warning in of_overlay_remove()
'*ovcs_id' causes a warning because '*' is treated as bold markup:
Documentation/devicetree/kernel-api:56: ../drivers/of/overlay.c:1184: WARNING: Inline emphasis start-string without end-string.
Fix this by using the normal '@' markup for function parameters. That
appears to be enough to keep the '*' from being interpretted as markup.
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Cc: Frank Rowand <frowand.list@gmail.com>
Link: https://lore.kernel.org/r/20210421154548.1192903-1-robh@kernel.org/
Signed-off-by: Rob Herring <robh@kernel.org>
Diffstat (limited to 'drivers/of')
| -rw-r--r-- | drivers/of/overlay.c | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/drivers/of/overlay.c b/drivers/of/overlay.c index d241273170fd..93af03c10e3b 100644 --- a/drivers/of/overlay.c +++ b/drivers/of/overlay.c @@ -1181,7 +1181,7 @@ static int overlay_removal_is_ok(struct overlay_changeset *remove_ovcs) * If an error is returned by an overlay changeset post-remove notifier * then no further overlay changeset post-remove notifier will be called. * - * Return: 0 on success, or a negative error number. *ovcs_id is set to + * Return: 0 on success, or a negative error number. *@ovcs_id is set to * zero after reverting the changeset, even if a subsequent error occurs. */ int of_overlay_remove(int *ovcs_id) |