[PATCH] drm/privacy-screen: Fix sphinx warning

[PATCH] drm/privacy-screen: Fix sphinx warning

[Hans de Goede]

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(-)

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
-- 
2.33.1

Re: [PATCH] drm/privacy-screen: Fix sphinx warning

[Simon Ser]

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

Re: [PATCH] drm/privacy-screen: Fix sphinx warning

[Hans de Goede]

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

Re: [PATCH] drm/privacy-screen: Fix sphinx warning

[Simon Ser]

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!

Re: [PATCH] drm/privacy-screen: Fix sphinx warning

[Rajat Jain]

In case it matters...

On Mon, Feb 7, 2022 at 3:33 AM Hans de Goede <hdegoede@redhat.com> wrote:
>
> Fix the following warning from "make htmldocs":
>
> drivers/gpu/drm/drm_privacy_screen.c:392:
>   warning: Function parameter or member 'data' not described in
>   'drm_privacy_screen_register'
>
> Fixes: 30598d925d46 ("drm/privacy_screen: Add drvdata in drm_privacy_screen")
> Cc: Rajat Jain <rajatja@google.com>
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Signed-off-by: Hans de Goede <hdegoede@redhat.com>

Acked-by: Rajat Jain <rajatja@google.com>

Thanks Hans for taking care of this for me.

Best Regards,

Rajat


> ---
>  drivers/gpu/drm/drm_privacy_screen.c | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/drivers/gpu/drm/drm_privacy_screen.c b/drivers/gpu/drm/drm_privacy_screen.c
> index 03b149cc455b..45c080134488 100644
> --- a/drivers/gpu/drm/drm_privacy_screen.c
> +++ b/drivers/gpu/drm/drm_privacy_screen.c
> @@ -379,6 +379,7 @@ static void drm_privacy_screen_device_release(struct device *dev)
>   * drm_privacy_screen_register - register a privacy-screen
>   * @parent: parent-device for the privacy-screen
>   * @ops: &struct drm_privacy_screen_ops pointer with ops for the privacy-screen
> + * @data: Private data owned by the privacy screen provider
>   *
>   * Create and register a privacy-screen.
>   *
> --
> 2.33.1
>

Re: [PATCH] drm/privacy-screen: Fix sphinx warning

[Hans de Goede]

Hi Simon,

On 2/7/22 12:37, Simon Ser wrote:
> Reviewed-by: Simon Ser <contact@emersion.fr>

Thank you, I also have this very similar patch pennding (also a simple htmldocs warning fix).

Any chance you can also review this one? :

https://patchwork.freedesktop.org/patch/470957/

Regards,

Hans
 

Re: [PATCH] drm/privacy-screen: Fix sphinx warning

[Simon Ser]

Reviewed-by: Simon Ser <contact@emersion.fr>

[PATCH] drm/privacy-screen: Fix sphinx warning

[Hans de Goede]

Fix the following warning from "make htmldocs":

drivers/gpu/drm/drm_privacy_screen.c:392:
  warning: Function parameter or member 'data' not described in
  'drm_privacy_screen_register'

Fixes: 30598d925d46 ("drm/privacy_screen: Add drvdata in drm_privacy_screen")
Cc: Rajat Jain <rajatja@google.com>
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 | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/gpu/drm/drm_privacy_screen.c b/drivers/gpu/drm/drm_privacy_screen.c
index 03b149cc455b..45c080134488 100644
--- a/drivers/gpu/drm/drm_privacy_screen.c
+++ b/drivers/gpu/drm/drm_privacy_screen.c
@@ -379,6 +379,7 @@ static void drm_privacy_screen_device_release(struct device *dev)
  * drm_privacy_screen_register - register a privacy-screen
  * @parent: parent-device for the privacy-screen
  * @ops: &struct drm_privacy_screen_ops pointer with ops for the privacy-screen
+ * @data: Private data owned by the privacy screen provider
  *
  * Create and register a privacy-screen.
  *
-- 
2.33.1