Skip to contentSkip to conversation

drm/privacy-screen: Fix sphinx warning

PATCH In review Hans de Goede 2 participants 4 messages Jan 26, 2022 – Feb 7, 2022

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 drm/privacy-screen: Fix sphinx warning

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)")
---
 drivers/gpu/drm/drm_privacy_screen.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/gpu/drm/drm_privacy_screen.c +1 -1
index beaf99e9120a..9f35f8f0cf60 100644
@@ -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
Signature · 1 line
2.33.1
#1 lore raw
Quoted 2 lines · Hans de Goede

- * 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``

#2 lore raw

Hi,

Thank you for the review.

Quoted 7 lines · Simon Ser
Quoted 2 lines · Hans de Goede

- * 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);
Quoted 3 lines

Alternatively, use double backquotes to format it as inline code blocks:

   ``void *data``

So I'll prepare a v2 using this.

Regards,

Hans

#3 lore raw
Quoted 1 line · Hans de Goede

It is not an argument to the function being described

Ah right, makes sense then!