From: Randy Dunlap <rdunlap@infradead.org>
To: Benjamin Gaignard <benjamin.gaignard@st.com>,
maarten.lankhorst@linux.intel.com, mripard@kernel.org,
airlied@linux.ie, daniel@ffwll.ch
Cc: linux-kernel@vger.kernel.org, dri-devel@lists.freedesktop.org
Subject: Re: [PATCH v2] drm: fix parameters documentation style
Date: Tue, 14 Jan 2020 08:04:18 -0800 [thread overview]
Message-ID: <df036eb5-6e08-3aec-f7c0-ce7db0486391@infradead.org> (raw)
In-Reply-To: <20200114160135.14990-1-benjamin.gaignard@st.com>
On 1/14/20 8:01 AM, Benjamin Gaignard wrote:
> Remove old documentation style and use new one to avoid warnings when
> compiling with W=1
>
> Signed-off-by: Benjamin Gaignard <benjamin.gaignard@st.com>
Looks good. Thanks.
Acked-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> CC: Randy Dunlap <rdunlap@infradead.org>
> version 2:
> - fix return documentation
>
> drivers/gpu/drm/drm_dma.c | 21 +++++++++++----------
> 1 file changed, 11 insertions(+), 10 deletions(-)
>
> diff --git a/drivers/gpu/drm/drm_dma.c b/drivers/gpu/drm/drm_dma.c
> index e45b07890c5a..a7add55a85b4 100644
> --- a/drivers/gpu/drm/drm_dma.c
> +++ b/drivers/gpu/drm/drm_dma.c
> @@ -42,10 +42,10 @@
> #include "drm_legacy.h"
>
> /**
> - * Initialize the DMA data.
> + * drm_legacy_dma_setup() - Initialize the DMA data.
> *
> - * \param dev DRM device.
> - * \return zero on success or a negative value on failure.
> + * @dev: DRM device.
> + * Return: zero on success or a negative value on failure.
> *
> * Allocate and initialize a drm_device_dma structure.
> */
> @@ -71,9 +71,9 @@ int drm_legacy_dma_setup(struct drm_device *dev)
> }
>
> /**
> - * Cleanup the DMA resources.
> + * drm_legacy_dma_takedown() - Cleanup the DMA resources.
> *
> - * \param dev DRM device.
> + * @dev: DRM device.
> *
> * Free all pages associated with DMA buffers, the buffers and pages lists, and
> * finally the drm_device::dma structure itself.
> @@ -120,10 +120,10 @@ void drm_legacy_dma_takedown(struct drm_device *dev)
> }
>
> /**
> - * Free a buffer.
> + * drm_legacy_free_buffer() - Free a buffer.
> *
> - * \param dev DRM device.
> - * \param buf buffer to free.
> + * @dev: DRM device.
> + * @buf: buffer to free.
> *
> * Resets the fields of \p buf.
> */
> @@ -139,9 +139,10 @@ void drm_legacy_free_buffer(struct drm_device *dev, struct drm_buf * buf)
> }
>
> /**
> - * Reclaim the buffers.
> + * drm_legacy_reclaim_buffers() - Reclaim the buffers.
> *
> - * \param file_priv DRM file private.
> + * @dev: DRM device.
> + * @file_priv: DRM file private.
> *
> * Frees each buffer associated with \p file_priv not already on the hardware.
> */
>
--
~Randy
Reported-by: Randy Dunlap <rdunlap@infradead.org>
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel
next prev parent reply other threads:[~2020-01-15 8:28 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-01-14 16:01 [PATCH v2] drm: fix parameters documentation style Benjamin Gaignard
2020-01-14 16:04 ` Randy Dunlap [this message]
2020-01-18 9:41 ` Sam Ravnborg
2020-01-20 8:11 ` Benjamin GAIGNARD
2020-01-20 20:21 ` Sam Ravnborg
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=df036eb5-6e08-3aec-f7c0-ce7db0486391@infradead.org \
--to=rdunlap@infradead.org \
--cc=airlied@linux.ie \
--cc=benjamin.gaignard@st.com \
--cc=daniel@ffwll.ch \
--cc=dri-devel@lists.freedesktop.org \
--cc=linux-kernel@vger.kernel.org \
--cc=maarten.lankhorst@linux.intel.com \
--cc=mripard@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).