From: Matthew Wilcox <willy@infradead.org>
To: Brian Starkey <brian.starkey@arm.com>
Cc: dri-devel@lists.freedesktop.org, daniel.vetter@ffwll.ch,
airlied@linux.ie, gustavo@padovan.org,
maarten.lankhorst@linux.intel.com, seanpaul@chromium.org,
corbet@lwn.net, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, alexandru-cosmin.gheorghe@arm.com,
liviu.dudau@arm.com, ayan.halder@arm.com
Subject: Re: [PATCH] drm/fourcc: Add DOC: overview comment
Date: Tue, 21 Aug 2018 09:26:39 -0700 [thread overview]
Message-ID: <20180821162639.GA21697@bombadil.infradead.org> (raw)
In-Reply-To: <20180821161611.10424-1-brian.starkey@arm.com>
On Tue, Aug 21, 2018 at 05:16:11PM +0100, Brian Starkey wrote:
> There's a number of things which haven't previously been documented
> around the usage of format modifiers. Capture the current
> understanding in an overview comment and add it to the rst
> documentation.
>
> Ideally, the generated documentation would also include documentation
> of all of the #defines, but the kernel-doc system doesn't currently
> support kernel-doc comments on #define constants.
Can you turn them into enums? This seems to work ok:
-/* color index */
-#define DRM_FORMAT_C8 fourcc_code('C', '8', ' ', ' ') /* [7:0] C */
-
-/* 8 bpp Red */
-#define DRM_FORMAT_R8 fourcc_code('R', '8', ' ', ' ') /* [7:0] R */
+enum {
+ /* color index */
+ DRM_FORMAT_C8 = fourcc_code('C', '8', ' ', ' '), /* [7:0] C */
+ /* 8 bpp Red */
+ DRM_FORMAT_R8 = fourcc_code('R', '8', ' ', ' '), /* [7:0] R */
+};
but I appreciate this is user API and maybe there's some code out there
that does #ifndef DRM_FORMAT_C8 ...
next prev parent reply other threads:[~2018-08-21 16:26 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-08-21 16:16 [PATCH] drm/fourcc: Add DOC: overview comment Brian Starkey
2018-08-21 16:26 ` Matthew Wilcox [this message]
2018-08-21 16:44 ` Brian Starkey
2018-08-22 14:59 ` Eric Engestrom
2018-08-22 15:11 ` Daniel Vetter
2018-08-22 15:57 ` Brian Starkey
2018-08-23 14:34 ` Matthew Wilcox
2018-08-23 15:40 ` Brian Starkey
2018-08-21 16:51 ` Daniel Vetter
2018-08-21 17:09 ` Alexandru-Cosmin Gheorghe
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=20180821162639.GA21697@bombadil.infradead.org \
--to=willy@infradead.org \
--cc=airlied@linux.ie \
--cc=alexandru-cosmin.gheorghe@arm.com \
--cc=ayan.halder@arm.com \
--cc=brian.starkey@arm.com \
--cc=corbet@lwn.net \
--cc=daniel.vetter@ffwll.ch \
--cc=dri-devel@lists.freedesktop.org \
--cc=gustavo@padovan.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=liviu.dudau@arm.com \
--cc=maarten.lankhorst@linux.intel.com \
--cc=seanpaul@chromium.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).