From: Harry Wentland <harry.wentland@amd.com>
To: Lee Jones <lee@kernel.org>, Alex Deucher <alexdeucher@gmail.com>
Cc: "Leo Li" <sunpeng.li@amd.com>, "Pan, Xinhui" <Xinhui.Pan@amd.com>,
"Rodrigo Siqueira" <Rodrigo.Siqueira@amd.com>,
linux-kernel@vger.kernel.org, dri-devel@lists.freedesktop.org,
"Christian König" <christian.koenig@amd.com>,
amd-gfx@lists.freedesktop.org,
"Jasdeep Dhillon" <jdhillon@amd.com>,
"Alex Deucher" <alexander.deucher@amd.com>,
"Nicholas Kazlauskas" <Nicholas.Kazlauskas@amd.com>,
"Mustapha Ghaddar" <mghaddar@amd.com>
Subject: Re: [PATCH 28/37] drm/amd/display/dc/core/dc_stat: Convert a couple of doc headers to kerneldoc format
Date: Mon, 20 Mar 2023 09:11:47 -0400 [thread overview]
Message-ID: <fa3bcadf-3ee9-86d7-d6ad-5408081766bf@amd.com> (raw)
In-Reply-To: <20230320081951.GI9667@google.com>
On 3/20/23 04:19, Lee Jones wrote:
> On Fri, 17 Mar 2023, Alex Deucher wrote:
>
>> On Fri, Mar 17, 2023 at 4:23 AM Lee Jones <lee@kernel.org> wrote:
>>>
>>> Fixes the following W=1 kernel build warning(s):
>>>
>>> drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc_stat.c:38: warning: Cannot understand *****************************************************************************
>>> drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc_stat.c:76: warning: Cannot understand *****************************************************************************
>>>
>>> Cc: Harry Wentland <harry.wentland@amd.com>
>>> Cc: Leo Li <sunpeng.li@amd.com>
>>> Cc: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
>>> Cc: Alex Deucher <alexander.deucher@amd.com>
>>> Cc: "Christian König" <christian.koenig@amd.com>
>>> Cc: "Pan, Xinhui" <Xinhui.Pan@amd.com>
>>> Cc: David Airlie <airlied@gmail.com>
>>> Cc: Daniel Vetter <daniel@ffwll.ch>
>>> Cc: Mustapha Ghaddar <mghaddar@amd.com>
>>> Cc: Nicholas Kazlauskas <Nicholas.Kazlauskas@amd.com>
>>> Cc: Jasdeep Dhillon <jdhillon@amd.com>
>>> Cc: amd-gfx@lists.freedesktop.org
>>> Cc: dri-devel@lists.freedesktop.org
>>> Signed-off-by: Lee Jones <lee@kernel.org>
>>> ---
>>> drivers/gpu/drm/amd/display/dc/core/dc_stat.c | 28 +++++++------------
>>> 1 file changed, 10 insertions(+), 18 deletions(-)
>>>
>>> diff --git a/drivers/gpu/drm/amd/display/dc/core/dc_stat.c b/drivers/gpu/drm/amd/display/dc/core/dc_stat.c
>>> index 6c06587dd88c2..5f6392ae31a66 100644
>>> --- a/drivers/gpu/drm/amd/display/dc/core/dc_stat.c
>>> +++ b/drivers/gpu/drm/amd/display/dc/core/dc_stat.c
>>> @@ -35,19 +35,15 @@
>>> */
>>>
>>> /**
>>
>> This looks like it follows some other documentation scheme. Would
>> probably be better to just remove the extra * and make it not kernel
>> doc. @Wentland, Harry @Siqueira, Rodrigo ?
>
> Happy to wait for further input.
>
> Either demoting from or converting to kerneldoc would be fine.
>
There's no reason they are formatted the way they are. Converting them to
kerneldoc is fine.
Reviewed-by: Harry Wentland <harry.wentland@amd.com>
Harry
>>> - *****************************************************************************
>>> - * Function: dc_stat_get_dmub_notification
>>> + * dc_stat_get_dmub_notification
>>> *
>>> - * @brief
>>> - * Calls dmub layer to retrieve dmub notification
>>> + * Calls dmub layer to retrieve dmub notification
>>> *
>>> - * @param
>>> - * [in] dc: dc structure
>>> - * [in] notify: dmub notification structure
>>> + * @dc: dc structure
>>> + * @notify: dmub notification structure
>>> *
>>> - * @return
>>> + * Returns
>>> * None
>>> - *****************************************************************************
>>> */
>>> void dc_stat_get_dmub_notification(const struct dc *dc, struct dmub_notification *notify)
>>> {
>>> @@ -73,19 +69,15 @@ void dc_stat_get_dmub_notification(const struct dc *dc, struct dmub_notification
>>> }
>>>
>>> /**
>>> - *****************************************************************************
>>> - * Function: dc_stat_get_dmub_dataout
>>> + * dc_stat_get_dmub_dataout
>>> *
>>> - * @brief
>>> - * Calls dmub layer to retrieve dmub gpint dataout
>>> + * Calls dmub layer to retrieve dmub gpint dataout
>>> *
>>> - * @param
>>> - * [in] dc: dc structure
>>> - * [in] dataout: dmub gpint dataout
>>> + * @dc: dc structure
>>> + * @dataout: dmub gpint dataout
>>> *
>>> - * @return
>>> + * Returns
>>> * None
>>> - *****************************************************************************
>>> */
>>> void dc_stat_get_dmub_dataout(const struct dc *dc, uint32_t *dataout)
>>> {
>>> --
>>> 2.40.0.rc1.284.g88254d51c5-goog
>>>
>
> --
> Lee Jones [李琼斯]
next prev parent reply other threads:[~2023-03-20 13:11 UTC|newest]
Thread overview: 43+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20230317081718.2650744-1-lee@kernel.org>
2023-03-17 8:16 ` [PATCH 01/37] drm/amd/display/dc/dc_hdmi_types: Move string definition to the only file it's used in Lee Jones
2023-03-17 20:15 ` Alex Deucher
2023-03-17 8:16 ` [PATCH 03/37] drm/amd/amdgpu/amdgpu_device: Provide missing kerneldoc entry for 'reset_context' Lee Jones
2023-03-17 20:16 ` Alex Deucher
2023-03-17 8:16 ` [PATCH 13/37] drm/amd/amdgpu/amdgpu_ucode: Remove unused function ‘amdgpu_ucode_print_imu_hdr’ Lee Jones
2023-03-17 20:18 ` Alex Deucher
2023-03-17 8:16 ` [PATCH 14/37] drm/amd/amdgpu/amdgpu_vm_pt: Supply description for amdgpu_vm_pt_free_dfs()'s unlocked param Lee Jones
2023-03-17 20:21 ` Alex Deucher
2023-03-17 8:16 ` [PATCH 15/37] drm/amd/amdgpu/gmc_v11_0: Provide a few missing param descriptions relating to hubs and flushes Lee Jones
2023-03-17 20:22 ` Alex Deucher
2023-03-17 8:16 ` [PATCH 16/37] drm/amd/amdgpu/ih_v6_0: Repair misspelling and provide descriptions for 'ih' Lee Jones
2023-03-17 20:23 ` Alex Deucher
2023-03-17 8:16 ` [PATCH 17/37] drm/amd/amdgpu/amdgpu_mes: Ensure amdgpu_bo_create_kernel()'s return value is checked Lee Jones
2023-03-17 20:25 ` Alex Deucher
2023-03-17 8:16 ` [PATCH 18/37] drm/amd/amdgpu/amdgpu_vce: Provide description for amdgpu_vce_validate_bo()'s 'p' param Lee Jones
2023-03-17 20:27 ` Alex Deucher
2023-03-17 8:17 ` [PATCH 19/37] drm/amd/pm/swsmu/smu11/vangogh_ppt: Provide a couple of missing parameter descriptions Lee Jones
2023-03-17 20:28 ` Alex Deucher
2023-03-17 8:17 ` [PATCH 20/37] drm/amd/display/amdgpu_dm/amdgpu_dm_helpers: Move defines out to where they are actually used Lee Jones
2023-03-17 20:30 ` Alex Deucher
2023-03-17 8:17 ` [PATCH 26/37] drm/amd/display/amdgpu_dm/amdgpu_dm_helpers: Move SYNAPTICS_DEVICE_ID into CONFIG_DRM_AMD_DC_DCN ifdef Lee Jones
2023-03-17 20:32 ` Alex Deucher
2023-03-17 8:17 ` [PATCH 27/37] drm/amd/display/dc/dce/dmub_psr: Demote kerneldoc abuse Lee Jones
2023-03-17 20:33 ` Alex Deucher
2023-03-17 8:17 ` [PATCH 28/37] drm/amd/display/dc/core/dc_stat: Convert a couple of doc headers to kerneldoc format Lee Jones
2023-03-17 20:36 ` Alex Deucher
2023-03-20 8:19 ` Lee Jones
2023-03-20 13:11 ` Harry Wentland [this message]
2023-03-20 13:25 ` Lee Jones
2023-03-20 14:04 ` Hamza Mahfooz
2023-03-17 8:17 ` [PATCH 29/37] drm/amd/display/dc/link/link_detection: Remove unused variable 'status' Lee Jones
2023-03-17 20:38 ` Alex Deucher
2023-03-17 8:17 ` [PATCH 30/37] drm/amd/display/dc/link/protocols/link_dp_training: Remove set but unused variable 'result' Lee Jones
2023-03-17 20:39 ` Alex Deucher
2023-03-17 8:17 ` [PATCH 32/37] drm/amd/display/dc/link/protocols/link_dp_capability: Remove unused variable and mark another as __maybe_unused Lee Jones
2023-03-17 20:41 ` Alex Deucher
2023-03-17 8:17 ` [PATCH 33/37] drm/amd/display/dc/link/protocols/link_dp_capability: Demote non-compliant kerneldoc Lee Jones
2023-03-17 20:42 ` Alex Deucher
2023-03-17 8:17 ` [PATCH 35/37] drm/amd/display/dc/dce60/Makefile: Fix previous attempt to silence known override-init warnings Lee Jones
2023-03-17 20:43 ` Alex Deucher
2023-03-17 8:17 ` [PATCH 36/37] drm/amd/display/dc/link/link_detection: Demote a couple of kerneldoc abuses Lee Jones
2023-03-17 20:44 ` Alex Deucher
2023-03-20 8:23 ` 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=fa3bcadf-3ee9-86d7-d6ad-5408081766bf@amd.com \
--to=harry.wentland@amd.com \
--cc=Nicholas.Kazlauskas@amd.com \
--cc=Rodrigo.Siqueira@amd.com \
--cc=Xinhui.Pan@amd.com \
--cc=alexander.deucher@amd.com \
--cc=alexdeucher@gmail.com \
--cc=amd-gfx@lists.freedesktop.org \
--cc=christian.koenig@amd.com \
--cc=dri-devel@lists.freedesktop.org \
--cc=jdhillon@amd.com \
--cc=lee@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mghaddar@amd.com \
--cc=sunpeng.li@amd.com \
/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).