| Message ID | 20220126151105.494521-1-hdegoede@redhat.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | drm/privacy-screen: Fix sphinx warning | expand |
On Wednesday, January 26th, 2022 at 16:11, Hans de Goede <hdegoede@redhat.com> wrote: > - * A pointer to the drm_privacy_screen's struct is passed as the void *data > + * A pointer to the drm_privacy_screen's struct is passed as the void \*data Maybe we can use @data here instead? It's used to refer to arguments or struct members. Alternatively, use double backquotes to format it as inline code blocks: ``void *data``
Hi, Thank you for the review. On 2/7/22 12:43, Simon Ser wrote: > On Wednesday, January 26th, 2022 at 16:11, Hans de Goede <hdegoede@redhat.com> wrote: > >> - * A pointer to the drm_privacy_screen's struct is passed as the void *data >> + * A pointer to the drm_privacy_screen's struct is passed as the void \*data > > Maybe we can use @data here instead? It's used to refer to arguments or struct > members. It is not an argument to the function being described; nor is it a struct member, it is the void *data in: typedef int (*notifier_fn_t)(struct notifier_block *nb, unsigned long action, void *data); > Alternatively, use double backquotes to format it as inline code blocks: > > ``void *data`` So I'll prepare a v2 using this. Regards, Hans
On Monday, February 7th, 2022 at 13:55, Hans de Goede <hdegoede@redhat.com> wrote:
> It is not an argument to the function being described
Ah right, makes sense then!
diff --git a/drivers/gpu/drm/drm_privacy_screen.c b/drivers/gpu/drm/drm_privacy_screen.c index beaf99e9120a..9f35f8f0cf60 100644 --- a/drivers/gpu/drm/drm_privacy_screen.c +++ b/drivers/gpu/drm/drm_privacy_screen.c @@ -269,7 +269,7 @@ EXPORT_SYMBOL(drm_privacy_screen_get_state); * * The notifier is called with no locks held. The new hw_state and sw_state * can be retrieved using the drm_privacy_screen_get_state() function. - * A pointer to the drm_privacy_screen's struct is passed as the void *data + * A pointer to the drm_privacy_screen's struct is passed as the void \*data * argument of the notifier_block's notifier_call. * * The notifier will NOT be called when changes are made through
Fix the following warning from "make htmldocs": drivers/gpu/drm/drm_privacy_screen.c:270: WARNING: Inline emphasis start-string without end-string. Fixes: 8a12b170558a ("drm/privacy-screen: Add notifier support (v2)") Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> Signed-off-by: Hans de Goede <hdegoede@redhat.com> --- drivers/gpu/drm/drm_privacy_screen.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)