From: Rodrigo Vivi <rodrigo.vivi@intel.com>
To: Jani Nikula <jani.nikula@intel.com>
Cc: intel-gfx@lists.freedesktop.org, intel-xe@lists.freedesktop.org,
dri-devel@lists.freedesktop.org, linux-doc@vger.kernel.org,
"Matthew Brost" <matthew.brost@intel.com>,
"Thomas Hellström" <thomas.hellstrom@linux.intel.com>,
joonas.lahtinen@linux.intel.com, tursulin@ursulin.net
Subject: Re: [PATCH 3/3] Documentation/gpu: add remaining DOC: comments to Intel display documentation
Date: Fri, 8 May 2026 09:19:00 -0400 [thread overview]
Message-ID: <af3ixP5pKOwxM9Jj@intel.com> (raw)
In-Reply-To: <589c46cf9a46763f4fbb7e1756656e6d71ba1431.1778235406.git.jani.nikula@intel.com>
On Fri, May 08, 2026 at 01:20:49PM +0300, Jani Nikula wrote:
> Not all of the overview DOC: comments in the display driver are
> incorporated into the documentation. Add the missing ones, including
> some function documentation.
>
> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
> ---
> Documentation/gpu/intel-display/atomic.rst | 11 +++++++++++
> Documentation/gpu/intel-display/casf.rst | 8 ++++++++
> Documentation/gpu/intel-display/cmtg.rst | 8 ++++++++
> Documentation/gpu/intel-display/index.rst | 4 ++++
> Documentation/gpu/intel-display/snps-phy.rst | 8 ++++++++
> 5 files changed, 39 insertions(+)
> create mode 100644 Documentation/gpu/intel-display/atomic.rst
> create mode 100644 Documentation/gpu/intel-display/casf.rst
> create mode 100644 Documentation/gpu/intel-display/cmtg.rst
> create mode 100644 Documentation/gpu/intel-display/snps-phy.rst
>
> diff --git a/Documentation/gpu/intel-display/atomic.rst b/Documentation/gpu/intel-display/atomic.rst
> new file mode 100644
> index 000000000000..43a473181e7a
> --- /dev/null
> +++ b/Documentation/gpu/intel-display/atomic.rst
> @@ -0,0 +1,11 @@
> +.. SPDX-License-Identifier: MIT
> +.. Copyright © 2026 Intel Corporation
> +
> +Atomic Modeset Support
> +======================
> +
> +.. kernel-doc:: drivers/gpu/drm/i915/display/intel_atomic.c
> + :doc: atomic modeset support
> +
> +.. kernel-doc:: drivers/gpu/drm/i915/display/intel_atomic.c
> + :internal:
I believe they key functions on the other files below also deserves this
kind of doc. But I know, future work not related to this patch. ;)
Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com>
> diff --git a/Documentation/gpu/intel-display/casf.rst b/Documentation/gpu/intel-display/casf.rst
> new file mode 100644
> index 000000000000..406778ccd94c
> --- /dev/null
> +++ b/Documentation/gpu/intel-display/casf.rst
> @@ -0,0 +1,8 @@
> +.. SPDX-License-Identifier: MIT
> +.. Copyright © 2026 Intel Corporation
> +
> +Content Adaptive Sharpness Filter (CASF)
> +========================================
> +
> +.. kernel-doc:: drivers/gpu/drm/i915/display/intel_casf.c
> + :doc: Content Adaptive Sharpness Filter (CASF)
> diff --git a/Documentation/gpu/intel-display/cmtg.rst b/Documentation/gpu/intel-display/cmtg.rst
> new file mode 100644
> index 000000000000..04edd0bd165d
> --- /dev/null
> +++ b/Documentation/gpu/intel-display/cmtg.rst
> @@ -0,0 +1,8 @@
> +.. SPDX-License-Identifier: MIT
> +.. Copyright © 2026 Intel Corporation
> +
> +Common Primary Timing Generator (CMTG)
> +======================================
> +
> +.. kernel-doc:: drivers/gpu/drm/i915/display/intel_cmtg.c
> + :doc: Common Primary Timing Generator (CMTG)
> diff --git a/Documentation/gpu/intel-display/index.rst b/Documentation/gpu/intel-display/index.rst
> index 8d40363b8f90..01c3d1e576b7 100644
> --- a/Documentation/gpu/intel-display/index.rst
> +++ b/Documentation/gpu/intel-display/index.rst
> @@ -24,8 +24,11 @@ driver. The display driver isn't an independent driver in that sense.
> :caption: Detailed display topics
>
> async-flip
> + atomic
> audio
> + casf
> cdclk
> + cmtg
> dmc
> dpio
> dpll
> @@ -37,4 +40,5 @@ driver. The display driver isn't an independent driver in that sense.
> hotplug
> plane
> psr
> + snps-phy
> vbt
> diff --git a/Documentation/gpu/intel-display/snps-phy.rst b/Documentation/gpu/intel-display/snps-phy.rst
> new file mode 100644
> index 000000000000..c9e333fa7f62
> --- /dev/null
> +++ b/Documentation/gpu/intel-display/snps-phy.rst
> @@ -0,0 +1,8 @@
> +.. SPDX-License-Identifier: MIT
> +.. Copyright © 2026 Intel Corporation
> +
> +Synopsis PHY support
> +====================
> +
> +.. kernel-doc:: drivers/gpu/drm/i915/display/intel_snps_phy.c
> + :doc: Synopsis PHY support
> --
> 2.47.3
>
next prev parent reply other threads:[~2026-05-08 13:19 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-05-08 10:20 [PATCH 0/3] drm/i915: reorganize display documentation Jani Nikula
2026-05-08 10:20 ` [PATCH 1/3] Documentation/gpu: add dedicated documentation for Intel display Jani Nikula
2026-05-08 13:15 ` Rodrigo Vivi
2026-05-08 18:22 ` Randy Dunlap
2026-05-11 7:41 ` Jani Nikula
2026-05-08 10:20 ` [PATCH 2/3] Documentation/gpu: use === for Intel display section heading underlines Jani Nikula
2026-05-08 13:15 ` Rodrigo Vivi
2026-05-08 18:22 ` Randy Dunlap
2026-05-08 10:20 ` [PATCH 3/3] Documentation/gpu: add remaining DOC: comments to Intel display documentation Jani Nikula
2026-05-08 13:19 ` Rodrigo Vivi [this message]
2026-05-08 10:29 ` ✗ CI.checkpatch: warning for drm/i915: reorganize " Patchwork
2026-05-08 10:32 ` ✓ CI.KUnit: success " Patchwork
2026-05-08 11:07 ` ✓ i915.CI.BAT: " Patchwork
2026-05-08 11:38 ` ✓ Xe.CI.BAT: " Patchwork
2026-05-08 23:38 ` ✗ Xe.CI.FULL: failure " Patchwork
2026-05-09 8:04 ` ✓ i915.CI.Full: success " Patchwork
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=af3ixP5pKOwxM9Jj@intel.com \
--to=rodrigo.vivi@intel.com \
--cc=dri-devel@lists.freedesktop.org \
--cc=intel-gfx@lists.freedesktop.org \
--cc=intel-xe@lists.freedesktop.org \
--cc=jani.nikula@intel.com \
--cc=joonas.lahtinen@linux.intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=matthew.brost@intel.com \
--cc=thomas.hellstrom@linux.intel.com \
--cc=tursulin@ursulin.net \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.