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: [PATCH 33/34] drm/vboxvideo/hgsmi_base: Place function names into headers
Date: Wed, 26 May 2021 09:47:25 +0100 [thread overview]
Message-ID: <20210526084726.552052-34-lee.jones@linaro.org> (raw)
In-Reply-To: <20210526084726.552052-1-lee.jones@linaro.org>
Fixes the following W=1 kernel build warning(s):
drivers/gpu/drm/vboxvideo/hgsmi_base.c:12: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
drivers/gpu/drm/vboxvideo/hgsmi_base.c:42: warning: expecting prototype for Notify the host of HGSMI(). Prototype was for hgsmi_send_caps_info() instead
drivers/gpu/drm/vboxvideo/hgsmi_base.c:74: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
drivers/gpu/drm/vboxvideo/hgsmi_base.c:102: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
drivers/gpu/drm/vboxvideo/hgsmi_base.c:174: 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/hgsmi_base.c | 19 ++++++++++++-------
1 file changed, 12 insertions(+), 7 deletions(-)
diff --git a/drivers/gpu/drm/vboxvideo/hgsmi_base.c b/drivers/gpu/drm/vboxvideo/hgsmi_base.c
index 361d3193258ea..8c041d7ce4f1b 100644
--- a/drivers/gpu/drm/vboxvideo/hgsmi_base.c
+++ b/drivers/gpu/drm/vboxvideo/hgsmi_base.c
@@ -9,7 +9,8 @@
#include "hgsmi_ch_setup.h"
/**
- * Inform the host of the location of the host flags in VRAM via an HGSMI cmd.
+ * hgsmi_report_flags_location - Inform the host of the location of
+ * the host flags in VRAM via an HGSMI cmd.
* Return: 0 or negative errno value.
* @ctx: The context of the guest heap to use.
* @location: The offset chosen for the flags within guest VRAM.
@@ -33,7 +34,8 @@ int hgsmi_report_flags_location(struct gen_pool *ctx, u32 location)
}
/**
- * Notify the host of HGSMI-related guest capabilities via an HGSMI command.
+ * hgsmi_send_caps_info - Notify the host of HGSMI-related guest capabilities
+ * via an HGSMI command.
* Return: 0 or negative errno value.
* @ctx: The context of the guest heap to use.
* @caps: The capabilities to report, see vbva_caps.
@@ -71,7 +73,8 @@ int hgsmi_test_query_conf(struct gen_pool *ctx)
}
/**
- * Query the host for an HGSMI configuration parameter via an HGSMI command.
+ * hgsmi_query_conf - Query the host for an HGSMI configuration
+ * parameter via an HGSMI command.
* Return: 0 or negative errno value.
* @ctx: The context containing the heap used.
* @index: The index of the parameter to query.
@@ -99,7 +102,8 @@ int hgsmi_query_conf(struct gen_pool *ctx, u32 index, u32 *value_ret)
}
/**
- * Pass the host a new mouse pointer shape via an HGSMI command.
+ * hgsmi_update_pointer_shape - Pass the host a new mouse pointer shape
+ * via an HGSMI command.
* Return: 0 or negative errno value.
* @ctx: The context containing the heap to be used.
* @flags: Cursor flags.
@@ -171,9 +175,10 @@ int hgsmi_update_pointer_shape(struct gen_pool *ctx, u32 flags,
}
/**
- * Report the guest cursor position. The host may wish to use this information
- * to re-position its own cursor (though this is currently unlikely). The
- * current host cursor position is returned.
+ * hgsmi_cursor_position - Report the guest cursor position. The host may
+ * wish to use this information to re-position its
+ * own cursor (though this is currently unlikely).
+ * The current host cursor position is returned.
* Return: 0 or negative errno value.
* @ctx: The context containing the heap used.
* @report_position: Are we reporting a position?
--
2.31.1
next prev parent reply other threads:[~2021-05-26 8:48 UTC|newest]
Thread overview: 60+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-26 8:46 [PATCH 00/34] Rid W=1 warnings from GPU Lee Jones
2021-05-26 8:46 ` [PATCH 01/34] drm/amd/pm/inc/smu_v13_0: Move table into the only source file that uses it Lee Jones
2021-05-27 3:42 ` Alex Deucher
2021-05-26 8:46 ` [PATCH 02/34] drm/amd/pm/swsmu/smu13/aldebaran_ppt: Remove unused variable 'ret' Lee Jones
2021-05-27 3:49 ` Alex Deucher
2021-05-26 8:46 ` [PATCH 03/34] drm/amd/pm/powerplay/hwmgr/smu7_thermal: Provide function name for 'smu7_fan_ctrl_set_default_mode()' Lee Jones
2021-05-27 3:51 ` Alex Deucher
2021-05-26 8:46 ` [PATCH 04/34] drm/amd/pm/powerplay/hwmgr/vega12_thermal: Provide function name Lee Jones
2021-05-27 3:52 ` Alex Deucher
2021-05-26 8:46 ` [PATCH 05/34] drm/amd/pm/powerplay/hwmgr/vega12_hwmgr: Provide 'vega12_init_smc_table()' " Lee Jones
2021-05-27 3:53 ` Alex Deucher
2021-05-26 8:46 ` [PATCH 06/34] drm/amd/pm/powerplay/hwmgr/vega10_hwmgr: Kernel-doc headers must contain function names Lee Jones
2021-05-27 3:54 ` Alex Deucher
2021-05-26 8:46 ` [PATCH 07/34] drm/amd/pm/powerplay/hwmgr/vega20_hwmgr: Provide function name 'vega20_init_smc_table()' Lee Jones
2021-05-27 3:54 ` Alex Deucher
2021-05-26 8:47 ` [PATCH 08/34] drm/amd/display/dc/bios/command_table_helper: Fix function name for 'dal_cmd_table_helper_transmitter_bp_to_atom()' Lee Jones
2021-05-27 3:55 ` Alex Deucher
2021-05-26 8:47 ` [PATCH 09/34] drm/amd/display/dc/bios/command_table_helper2: Fix function name 'dal_cmd_table_helper_transmitter_bp_to_atom2()' Lee Jones
2021-05-27 3:56 ` Alex Deucher
2021-05-26 8:47 ` [PATCH 10/34] drm/amd/display/dc/bios/bios_parser: Fix formatting and misnaming issues Lee Jones
2021-05-27 3:57 ` Alex Deucher
2021-05-26 8:47 ` [PATCH 11/34] drm/nouveau/nvkm/subdev/mc/tu102: Make functions called by reference static Lee Jones
2021-05-26 11:16 ` [Nouveau] " Karol Herbst
2021-05-26 8:47 ` [PATCH 12/34] drm/amd/display/amdgpu_dm/amdgpu_dm: Functions must directly follow their headers Lee Jones
2021-05-27 3:59 ` Alex Deucher
2021-05-26 8:47 ` [PATCH 13/34] drm/amd/display/dc/dce/dmub_outbox: Convert over to kernel-doc Lee Jones
2021-05-27 4:00 ` Alex Deucher
2021-05-26 8:47 ` [PATCH 14/34] drm/amd/display/dc/gpio/gpio_service: Pass around correct dce_{version, environment} types Lee Jones
2021-05-27 4:06 ` Alex Deucher
2021-05-26 8:47 ` [PATCH 15/34] drm/amd/display/dc/dce110/dce110_hw_sequencer: Include our own header Lee Jones
2021-05-27 4:07 ` Alex Deucher
2021-05-26 8:47 ` [PATCH 16/34] drm/amd/display/dc/dce/dce_transform: Remove superfluous re-initialisation of DCFE_MEM_LIGHT_SLEEP_CNTL, Lee Jones
2021-05-27 4:12 ` Alex Deucher
2021-05-26 8:47 ` [PATCH 17/34] drm/amd/display/dc/dce/dce_mem_input: Remove duplicate initialisation of GRPH_CONTROL__GRPH_NUM_BANKS_{SHIFT, MASK} Lee Jones
2021-05-27 4:19 ` Alex Deucher
2021-05-26 8:47 ` [PATCH 18/34] drm/amd/display/dc/dce/dce_mem_input: Remove duplicate initialisation of GRPH_CONTROL__GRPH_NUM_BANKS_{SHIFT, MASK Lee Jones
2021-05-27 4:20 ` Alex Deucher
2021-05-26 8:47 ` [PATCH 19/34] drm/amd/amdgpu/amdgpu_device: Make local function static Lee Jones
2021-05-27 4:20 ` Alex Deucher
2021-05-26 8:47 ` [PATCH 20/34] drm/amd/display/amdgpu_dm/amdgpu_dm: Fix kernel-doc formatting issue Lee Jones
2021-05-27 4:22 ` Alex Deucher
2021-05-26 8:47 ` [PATCH 21/34] drm/amd/display/dc/dce110/dce110_hw_sequencer: Include header containing our prototypes Lee Jones
2021-05-27 4:25 ` Alex Deucher
2021-05-26 8:47 ` [PATCH 22/34] drm/amd/display/dc/core/dc: Convert function headers to kernel-doc Lee Jones
2021-05-27 4:26 ` Alex Deucher
2021-05-26 8:47 ` [PATCH 23/34] drm/amd/display/dmub/src/dmub_srv_stat: Convert function header " Lee Jones
2021-05-27 4:27 ` Alex Deucher
2021-05-26 8:47 ` [PATCH 24/34] drm/amd/display/modules/hdcp/hdcp_psp: Remove unused function 'mod_hdcp_hdcp1_get_link_encryption_status()' Lee Jones
2021-05-27 4:28 ` Alex Deucher
2021-05-26 8:47 ` [PATCH 25/34] drm/xlnx/zynqmp_disp: Fix incorrectly named enum 'zynqmp_disp_layer_id' Lee Jones
2021-05-26 8:47 ` [PATCH 26/34] drm/xlnx/zynqmp_dp: Fix incorrectly name function 'zynqmp_dp_train()' Lee Jones
2021-05-26 8:47 ` [PATCH 27/34] drm/ttm/ttm_tt: Demote non-conformant kernel-doc header Lee Jones
2021-05-26 8:47 ` [PATCH 28/34] drm/panel/panel-raspberrypi-touchscreen: Demote kernel-doc abuse Lee Jones
2021-05-26 8:47 ` [PATCH 29/34] drm/panel/panel-sitronix-st7701: " Lee Jones
2021-05-26 8:47 ` [PATCH 30/34] drm/vgem/vgem_drv: Standard comment blocks should not use kernel-doc format Lee Jones
2021-05-26 13:10 ` Daniel Vetter
2021-05-26 8:47 ` [PATCH 31/34] drm/exynos/exynos7_drm_decon: Fix incorrect naming of 'decon_shadow_protect_win()' Lee Jones
2021-05-26 8:47 ` [PATCH 32/34] drm/exynos/exynos_drm_ipp: Fix documentation for 'exynos_drm_ipp_get_{caps, res}_ioctl()' Lee Jones
2021-05-26 8:47 ` Lee Jones [this message]
2021-05-26 8:47 ` [PATCH 34/34] drm/vboxvideo/modesetting: Provide function names for prototype headers 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=20210526084726.552052-34-lee.jones@linaro.org \
--to=lee.jones@linaro.org \
--cc=airlied@linux.ie \
--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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).