All of lore.kernel.org
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org, Hans de Goede <hdegoede@redhat.com>,
	David Airlie <airlied@linux.ie>, Daniel Vetter <daniel@ffwll.ch>,
	dri-devel@lists.freedesktop.org
Subject: [RESEND 26/26] drm/vboxvideo/modesetting: Provide function names for prototype headers
Date: Wed,  2 Jun 2021 15:33:00 +0100	[thread overview]
Message-ID: <20210602143300.2330146-27-lee.jones@linaro.org> (raw)
In-Reply-To: <20210602143300.2330146-1-lee.jones@linaro.org>

Fixes the following W=1 kernel build warning(s):

 drivers/gpu/drm/vboxvideo/modesetting.c:11: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/gpu/drm/vboxvideo/modesetting.c:54: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/gpu/drm/vboxvideo/modesetting.c:87: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

Cc: Hans de Goede <hdegoede@redhat.com>
Cc: David Airlie <airlied@linux.ie>
Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: dri-devel@lists.freedesktop.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/gpu/drm/vboxvideo/modesetting.c | 20 ++++++++++++--------
 1 file changed, 12 insertions(+), 8 deletions(-)

diff --git a/drivers/gpu/drm/vboxvideo/modesetting.c b/drivers/gpu/drm/vboxvideo/modesetting.c
index 7580b90023792..10b32d986b956 100644
--- a/drivers/gpu/drm/vboxvideo/modesetting.c
+++ b/drivers/gpu/drm/vboxvideo/modesetting.c
@@ -8,9 +8,11 @@
 #include "hgsmi_channels.h"
 
 /**
- * Set a video mode via an HGSMI request.  The views must have been
- * initialised first using @a VBoxHGSMISendViewInfo and if the mode is being
- * set on the first display then it must be set first using registers.
+ * hgsmi_process_display_info - Set a video mode via an HGSMI request.
+ *                              The views must have been initialised first
+ *                              using @a VBoxHGSMISendViewInfo and if the mode
+ *                              is being set on the first display then it must
+ *                              be set first using registers.
  * @ctx:           The context containing the heap to use.
  * @display:       The screen number.
  * @origin_x:      The horizontal displacement relative to the first scrn.
@@ -51,10 +53,12 @@ void hgsmi_process_display_info(struct gen_pool *ctx, u32 display,
 }
 
 /**
- * Report the rectangle relative to which absolute pointer events should be
- * expressed.  This information remains valid until the next VBVA resize event
- * for any screen, at which time it is reset to the bounding rectangle of all
- * virtual screens.
+ * hgsmi_update_input_mapping - Report the rectangle relative to which absolute
+ *                              pointer events should be expressed.  This
+ *                              information remains valid until the next VBVA
+ *                              resize event for any screen, at which time it is
+ *                              reset to the bounding rectangle of all virtual
+ *                              screens.
  * Return: 0 or negative errno value.
  * @ctx:       The context containing the heap to use.
  * @origin_x:  Upper left X co-ordinate relative to the first screen.
@@ -84,7 +88,7 @@ int hgsmi_update_input_mapping(struct gen_pool *ctx, s32 origin_x, s32 origin_y,
 }
 
 /**
- * Get most recent video mode hints.
+ * hgsmi_get_mode_hints - Get most recent video mode hints.
  * Return: 0 or negative errno value.
  * @ctx:      The context containing the heap to use.
  * @screens:  The number of screens to query hints for, starting at 0.
-- 
2.31.1


WARNING: multiple messages have this Message-ID (diff)
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: David Airlie <airlied@linux.ie>,
	Hans de Goede <hdegoede@redhat.com>,
	dri-devel@lists.freedesktop.org, linux-kernel@vger.kernel.org
Subject: [RESEND 26/26] drm/vboxvideo/modesetting: Provide function names for prototype headers
Date: Wed,  2 Jun 2021 15:33:00 +0100	[thread overview]
Message-ID: <20210602143300.2330146-27-lee.jones@linaro.org> (raw)
In-Reply-To: <20210602143300.2330146-1-lee.jones@linaro.org>

Fixes the following W=1 kernel build warning(s):

 drivers/gpu/drm/vboxvideo/modesetting.c:11: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/gpu/drm/vboxvideo/modesetting.c:54: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 drivers/gpu/drm/vboxvideo/modesetting.c:87: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

Cc: Hans de Goede <hdegoede@redhat.com>
Cc: David Airlie <airlied@linux.ie>
Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: dri-devel@lists.freedesktop.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/gpu/drm/vboxvideo/modesetting.c | 20 ++++++++++++--------
 1 file changed, 12 insertions(+), 8 deletions(-)

diff --git a/drivers/gpu/drm/vboxvideo/modesetting.c b/drivers/gpu/drm/vboxvideo/modesetting.c
index 7580b90023792..10b32d986b956 100644
--- a/drivers/gpu/drm/vboxvideo/modesetting.c
+++ b/drivers/gpu/drm/vboxvideo/modesetting.c
@@ -8,9 +8,11 @@
 #include "hgsmi_channels.h"
 
 /**
- * Set a video mode via an HGSMI request.  The views must have been
- * initialised first using @a VBoxHGSMISendViewInfo and if the mode is being
- * set on the first display then it must be set first using registers.
+ * hgsmi_process_display_info - Set a video mode via an HGSMI request.
+ *                              The views must have been initialised first
+ *                              using @a VBoxHGSMISendViewInfo and if the mode
+ *                              is being set on the first display then it must
+ *                              be set first using registers.
  * @ctx:           The context containing the heap to use.
  * @display:       The screen number.
  * @origin_x:      The horizontal displacement relative to the first scrn.
@@ -51,10 +53,12 @@ void hgsmi_process_display_info(struct gen_pool *ctx, u32 display,
 }
 
 /**
- * Report the rectangle relative to which absolute pointer events should be
- * expressed.  This information remains valid until the next VBVA resize event
- * for any screen, at which time it is reset to the bounding rectangle of all
- * virtual screens.
+ * hgsmi_update_input_mapping - Report the rectangle relative to which absolute
+ *                              pointer events should be expressed.  This
+ *                              information remains valid until the next VBVA
+ *                              resize event for any screen, at which time it is
+ *                              reset to the bounding rectangle of all virtual
+ *                              screens.
  * Return: 0 or negative errno value.
  * @ctx:       The context containing the heap to use.
  * @origin_x:  Upper left X co-ordinate relative to the first screen.
@@ -84,7 +88,7 @@ int hgsmi_update_input_mapping(struct gen_pool *ctx, s32 origin_x, s32 origin_y,
 }
 
 /**
- * Get most recent video mode hints.
+ * hgsmi_get_mode_hints - Get most recent video mode hints.
  * Return: 0 or negative errno value.
  * @ctx:      The context containing the heap to use.
  * @screens:  The number of screens to query hints for, starting at 0.
-- 
2.31.1


  parent reply	other threads:[~2021-06-02 14:34 UTC|newest]

Thread overview: 120+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-06-02 14:32 [RESEND 00/26] Rid W=1 warnings from GPU Lee Jones
2021-06-02 14:32 ` Lee Jones
2021-06-02 14:32 ` Lee Jones
2021-06-02 14:32 ` Lee Jones
2021-06-02 14:32 ` [Nouveau] " Lee Jones
2021-06-02 14:32 ` [RESEND 01/26] drm/mediatek/mtk_disp_color: Strip incorrect doc and demote header Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32 ` [RESEND 02/26] drm/mediatek/mtk_disp_gamma: Strip and demote non-conformant kernel-doc header Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32 ` [RESEND 03/26] drm/mediatek/mtk_disp_ovl: Strip and demote non-conformant header Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32 ` [RESEND 04/26] drm/mediatek/mtk_disp_rdma: Strip and demote non-conformant kernel-doc header Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32 ` [RESEND 05/26] drm/sti/sti_hdmi_tx3g4c28phy: Provide function names for kernel-doc headers Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32 ` [RESEND 06/26] drm/sti/sti_hda: Provide missing function names Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32 ` [RESEND 07/26] drm/sti/sti_tvout: Provide a bunch of " Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32 ` [RESEND 08/26] drm/sti/sti_hqvdp: Fix incorrectly named function 'sti_hqvdp_vtg_cb()' Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32 ` [RESEND 09/26] drm/msm/disp/dpu1/dpu_encoder_phys_cmd: Remove unused variable 'cmd_enc' Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 17:26   ` [Freedreno] " abhinavk
2021-06-02 17:26     ` abhinavk
2021-06-02 14:32 ` [RESEND 10/26] drm/msm/disp/dpu1/dpu_hw_interrupts: Demote a bunch of kernel-doc abuses Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 17:33   ` [Freedreno] " abhinavk
2021-06-02 17:33     ` abhinavk
2021-06-04  8:32   ` Dmitry Baryshkov
2021-06-04  8:32     ` Dmitry Baryshkov
2021-06-04  8:57     ` Lee Jones
2021-06-04  8:57       ` Lee Jones
2021-06-02 14:32 ` [RESEND 11/26] drm/msm/disp/dpu1/dpu_plane: Fix a couple of naming issues Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 17:29   ` [Freedreno] " abhinavk
2021-06-02 17:29     ` abhinavk
2021-06-02 14:32 ` [RESEND 12/26] drm/msm/msm_gem: Demote kernel-doc abuses Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-04  0:49   ` Dmitry Baryshkov
2021-06-04  0:49     ` Dmitry Baryshkov
2021-06-02 14:32 ` [RESEND 13/26] drm/msm/dp/dp_catalog: Correctly document param 'dp_catalog' Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 17:32   ` [Freedreno] " abhinavk
2021-06-02 17:32     ` abhinavk
2021-06-02 23:52   ` Stephen Boyd
2021-06-02 23:52     ` Stephen Boyd
2021-06-02 14:32 ` [RESEND 14/26] drm/msm/dp/dp_link: Fix some potential doc-rot Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-04  0:51   ` Dmitry Baryshkov
2021-06-04  0:51     ` Dmitry Baryshkov
2021-06-02 14:32 ` [RESEND 15/26] drm/nouveau/nvkm/subdev/mc/tu102: Make functions called by reference static Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32   ` [Nouveau] " Lee Jones
2021-06-02 14:32 ` [RESEND 16/26] drm/amd/display/dc/dce/dce_transform: Remove superfluous re-initialisation of DCFE_MEM_LIGHT_SLEEP_CNTL, Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:46   ` Harry Wentland
2021-06-02 14:46     ` Harry Wentland
2021-06-02 14:46     ` Harry Wentland
2021-06-02 16:23   ` Alex Deucher
2021-06-02 16:23     ` Alex Deucher
2021-06-02 16:23     ` Alex Deucher
2021-06-02 17:37     ` Lee Jones
2021-06-02 17:37       ` Lee Jones
2021-06-02 17:37       ` Lee Jones
2021-06-02 14:32 ` [RESEND 17/26] drm/xlnx/zynqmp_disp: Fix incorrectly named enum 'zynqmp_disp_layer_id' Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 16:20   ` Laurent Pinchart
2021-06-02 16:20     ` Laurent Pinchart
2021-06-02 16:20     ` Laurent Pinchart
2021-06-03 11:30     ` Daniel Vetter
2021-06-03 11:30       ` Daniel Vetter
2021-06-03 11:30       ` Daniel Vetter
2021-06-02 14:32 ` [RESEND 18/26] drm/xlnx/zynqmp_dp: Fix incorrectly name function 'zynqmp_dp_train()' Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 16:23   ` Laurent Pinchart
2021-06-02 16:23     ` Laurent Pinchart
2021-06-02 16:23     ` Laurent Pinchart
2021-06-02 17:38     ` Lee Jones
2021-06-02 17:38       ` Lee Jones
2021-06-02 17:38       ` Lee Jones
2021-06-02 14:32 ` [RESEND 19/26] drm/ttm/ttm_tt: Demote non-conformant kernel-doc header Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32 ` [RESEND 20/26] drm/panel/panel-raspberrypi-touchscreen: Demote kernel-doc abuse Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32 ` [RESEND 21/26] drm/panel/panel-sitronix-st7701: " Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32 ` [RESEND 22/26] drm/vgem/vgem_drv: Standard comment blocks should not use kernel-doc format Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32 ` [RESEND 23/26] drm/exynos/exynos7_drm_decon: Fix incorrect naming of 'decon_shadow_protect_win()' Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32 ` [RESEND 24/26] drm/exynos/exynos_drm_ipp: Fix documentation for 'exynos_drm_ipp_get_{caps,res}_ioctl()' Lee Jones
2021-06-02 14:32   ` [RESEND 24/26] drm/exynos/exynos_drm_ipp: Fix documentation for 'exynos_drm_ipp_get_{caps, res}_ioctl()' Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:32 ` [RESEND 25/26] drm/vboxvideo/hgsmi_base: Place function names into headers Lee Jones
2021-06-02 14:32   ` Lee Jones
2021-06-02 14:33 ` Lee Jones [this message]
2021-06-02 14:33   ` [RESEND 26/26] drm/vboxvideo/modesetting: Provide function names for prototype headers Lee Jones
2021-06-03 11:34 ` [RESEND 00/26] Rid W=1 warnings from GPU Daniel Vetter
2021-06-03 11:34   ` Daniel Vetter
2021-06-03 11:34   ` Daniel Vetter
2021-06-03 11:34   ` Daniel Vetter
2021-06-03 11:34   ` [Nouveau] " Daniel Vetter
2021-06-03 11:52   ` Lee Jones
2021-06-03 11:52     ` Lee Jones
2021-06-03 11:52     ` Lee Jones
2021-06-03 11:52     ` Lee Jones
2021-06-03 11:52     ` [Nouveau] " Lee Jones

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210602143300.2330146-27-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=airlied@linux.ie \
    --cc=daniel@ffwll.ch \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=hdegoede@redhat.com \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.