From: Daniel Vetter <daniel@ffwll.ch>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>, Daniel Vetter <daniel@ffwll.ch>,
David Airlie <airlied@linux.ie>,
Maarten Lankhorst <maarten.lankhorst@linux.intel.com>,
Maxime Ripard <mripard@kernel.org>,
Thomas Zimmermann <tzimmermann@suse.de>,
dri-devel@lists.freedesktop.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v3 31/32] drm: drm_print.h: fix kernel-doc markups
Date: Tue, 27 Oct 2020 11:22:53 +0100 [thread overview]
Message-ID: <20201027102253.GK401619@phenom.ffwll.local> (raw)
In-Reply-To: <5b76c5625709aaaa3abee98faa620b9f3d27ff85.1603791716.git.mchehab+huawei@kernel.org>
On Tue, Oct 27, 2020 at 10:51:35AM +0100, Mauro Carvalho Chehab wrote:
> A kernel-doc markup should start with the identifier on its
> first line.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
I've merged all the drm patches, excluding the amdgpu ones, to
drm-misc-fixes. Should land in -rc2.
Thanks for doing these patches.
-Daniel
> ---
> include/drm/drm_print.h | 20 +++++++++++++++++---
> 1 file changed, 17 insertions(+), 3 deletions(-)
>
> diff --git a/include/drm/drm_print.h b/include/drm/drm_print.h
> index 1c9417430d08..f32d179e139d 100644
> --- a/include/drm/drm_print.h
> +++ b/include/drm/drm_print.h
> @@ -338,7 +338,7 @@ void drm_dev_dbg(const struct device *dev, enum drm_debug_category category,
> const char *format, ...);
>
> /**
> - * Error output.
> + * DRM_DEV_ERROR() - Error output.
> *
> * @dev: device pointer
> * @fmt: printf() like format string.
> @@ -347,10 +347,12 @@ void drm_dev_dbg(const struct device *dev, enum drm_debug_category category,
> drm_dev_printk(dev, KERN_ERR, "*ERROR* " fmt, ##__VA_ARGS__)
>
> /**
> - * Rate limited error output. Like DRM_ERROR() but won't flood the log.
> + * DRM_DEV_ERROR_RATELIMITED() - Rate limited error output.
> *
> * @dev: device pointer
> * @fmt: printf() like format string.
> + *
> + * Like DRM_ERROR() but won't flood the log.
> */
> #define DRM_DEV_ERROR_RATELIMITED(dev, fmt, ...) \
> ({ \
> @@ -375,15 +377,27 @@ void drm_dev_dbg(const struct device *dev, enum drm_debug_category category,
> })
>
> /**
> - * Debug output.
> + * DRM_DEV_DEBUG() - Debug output for generic drm code
> *
> * @dev: device pointer
> * @fmt: printf() like format string.
> */
> #define DRM_DEV_DEBUG(dev, fmt, ...) \
> drm_dev_dbg(dev, DRM_UT_CORE, fmt, ##__VA_ARGS__)
> +/**
> + * DRM_DEV_DEBUG_DRIVER() - Debug output for vendor specific part of the driver
> + *
> + * @dev: device pointer
> + * @fmt: printf() like format string.
> + */
> #define DRM_DEV_DEBUG_DRIVER(dev, fmt, ...) \
> drm_dev_dbg(dev, DRM_UT_DRIVER, fmt, ##__VA_ARGS__)
> +/**
> + * DRM_DEV_DEBUG_KMS() - Debug output for modesetting code
> + *
> + * @dev: device pointer
> + * @fmt: printf() like format string.
> + */
> #define DRM_DEV_DEBUG_KMS(dev, fmt, ...) \
> drm_dev_dbg(dev, DRM_UT_KMS, fmt, ##__VA_ARGS__)
>
> --
> 2.26.2
>
--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
next prev parent reply other threads:[~2020-10-27 10:23 UTC|newest]
Thread overview: 39+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-27 9:51 [PATCH v3 00/32] Documentation build fixes against v5.10-rc1 Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 01/32] scripts: kernel-doc: use :c:union when needed Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 02/32] sphinx: conf.py: properly handle Sphinx 4.0 Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 03/32] docs: hwmon: adm1266.rst: fix a broken reference Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 04/32] docs: admin-guide: net.rst: add a missing blank line Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 05/32] docs: kasan.rst: add two missing blank lines Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 06/32] docs: net: statistics.rst: remove a duplicated kernel-doc Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 07/32] docs: hwmon: mp2975.rst: address some html build warnings Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 08/32] docs: userspace-api: add iommu.rst to the index file Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 09/32] blk-mq: docs: add kernel-doc description for a new struct member Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 10/32] drm: kernel-doc: document drm_dp_set_subconnector_property() params Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 11/32] drm/dp: fix kernel-doc warnings at drm_dp_helper.c Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 12/32] drm/dp: fix a kernel-doc issue at drm_edid.c Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 13/32] mm: pagemap.h: fix two kernel-doc markups Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 14/32] net: phy: remove kernel-doc duplication Mauro Carvalho Chehab
2020-10-27 12:41 ` Andrew Lunn
2020-10-27 9:51 ` [PATCH v3 15/32] crypto: sun8x-ce*: update entries to its documentation Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 16/32] ice: docs fix a devlink info that broke a table Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 17/32] MAINTAINERS: fix broken doc refs due to yaml conversion Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 18/32] docs: lockdep-design: fix some warning issues Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 19/32] locking/refcount: move kernel-doc markups to the proper place Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 20/32] IB/srpt: docs: add a description for cq_size member Mauro Carvalho Chehab
2020-10-28 3:48 ` Bart Van Assche
2020-10-27 9:51 ` [PATCH v3 21/32] docs: fs: api-summary.rst: get rid of kernel-doc include Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 22/32] drm: amdgpu: kernel-doc: update some adev parameters Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 23/32] jbd2: fix a kernel-doc markup Mauro Carvalho Chehab
2020-10-27 21:26 ` Theodore Y. Ts'o
2020-10-27 9:51 ` [PATCH v3 24/32] drm: drm_edid: remove a duplicated kernel-doc declaration Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 25/32] drm: kernel-doc: add description for a new function parameter Mauro Carvalho Chehab
2020-10-27 10:04 ` Gerd Hoffmann
2020-10-27 9:51 ` [PATCH v3 26/32] gpu: docs: amdgpu.rst: get rid of wrong kernel-doc markups Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 27/32] drm: kernel-doc: drm_dp_helper.h: fix a typo Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 28/32] drm: amdgpu_dm: " Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 29/32] selftests: kselftest_harness.h: fix kernel-doc markups Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 30/32] amdgpu: fix a few kernel-doc markup issues Mauro Carvalho Chehab
2020-10-27 9:51 ` [PATCH v3 31/32] drm: drm_print.h: fix kernel-doc markups Mauro Carvalho Chehab
2020-10-27 10:22 ` Daniel Vetter [this message]
2020-10-27 9:51 ` [PATCH v3 32/32] docs: SafeSetID: fix a warning Mauro Carvalho Chehab
2020-10-28 17:46 ` [PATCH v3 00/32] Documentation build fixes against v5.10-rc1 Jonathan Corbet
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=20201027102253.GK401619@phenom.ffwll.local \
--to=daniel@ffwll.ch \
--cc=airlied@linux.ie \
--cc=corbet@lwn.net \
--cc=dri-devel@lists.freedesktop.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=maarten.lankhorst@linux.intel.com \
--cc=mchehab+huawei@kernel.org \
--cc=mripard@kernel.org \
--cc=tzimmermann@suse.de \
/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