dri-devel Archive on lore.kernel.org
 help / color / mirror / Atom feed
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 2/3] Documentation/gpu: use === for Intel display section heading underlines
Date: Fri, 8 May 2026 09:15:42 -0400	[thread overview]
Message-ID: <af3h_ljWsBUMY5Um@intel.com> (raw)
In-Reply-To: <f49968792220ca3ff24efde813550850340d092e.1778235406.git.jani.nikula@intel.com>

On Fri, May 08, 2026 at 01:20:48PM +0300, Jani Nikula wrote:
> Prefer to use === instead of --- for top level section heading
> underlines to allow using the latter for sub-headings later.
> 
> While at it, fix the underline lenghts where needed.
> 
> Signed-off-by: Jani Nikula <jani.nikula@intel.com>

Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com>

> ---
>  Documentation/gpu/intel-display/async-flip.rst    | 2 +-
>  Documentation/gpu/intel-display/audio.rst         | 4 ++--
>  Documentation/gpu/intel-display/cdclk.rst         | 2 +-
>  Documentation/gpu/intel-display/dmc.rst           | 6 +++---
>  Documentation/gpu/intel-display/dpio.rst          | 2 +-
>  Documentation/gpu/intel-display/dpll.rst          | 2 +-
>  Documentation/gpu/intel-display/drrs.rst          | 2 +-
>  Documentation/gpu/intel-display/dsb.rst           | 2 +-
>  Documentation/gpu/intel-display/fbc.rst           | 2 +-
>  Documentation/gpu/intel-display/fifo-underrun.rst | 2 +-
>  Documentation/gpu/intel-display/frontbuffer.rst   | 2 +-
>  Documentation/gpu/intel-display/hotplug.rst       | 2 +-
>  Documentation/gpu/intel-display/plane.rst         | 2 +-
>  Documentation/gpu/intel-display/psr.rst           | 2 +-
>  Documentation/gpu/intel-display/vbt.rst           | 2 +-
>  15 files changed, 18 insertions(+), 18 deletions(-)
> 
> diff --git a/Documentation/gpu/intel-display/async-flip.rst b/Documentation/gpu/intel-display/async-flip.rst
> index e4ae4012efc5..40f93e885bb7 100644
> --- a/Documentation/gpu/intel-display/async-flip.rst
> +++ b/Documentation/gpu/intel-display/async-flip.rst
> @@ -2,7 +2,7 @@
>  .. Copyright © 2026 Intel Corporation
>  
>  Asynchronous Page Flip
> -----------------------
> +======================
>  
>  .. kernel-doc:: drivers/gpu/drm/i915/display/intel_display.c
>     :doc: asynchronous flip implementation
> diff --git a/Documentation/gpu/intel-display/audio.rst b/Documentation/gpu/intel-display/audio.rst
> index 7d3c1b514b0e..eef95df75f8d 100644
> --- a/Documentation/gpu/intel-display/audio.rst
> +++ b/Documentation/gpu/intel-display/audio.rst
> @@ -2,7 +2,7 @@
>  .. Copyright © 2026 Intel Corporation
>  
>  High Definition Audio
> ----------------------
> +=====================
>  
>  .. kernel-doc:: drivers/gpu/drm/i915/display/intel_audio.c
>     :doc: High Definition Audio over HDMI and Display Port
> @@ -14,7 +14,7 @@ High Definition Audio
>     :internal:
>  
>  Intel HDMI LPE Audio Support
> -----------------------------
> +============================
>  
>  .. kernel-doc:: drivers/gpu/drm/i915/display/intel_lpe_audio.c
>     :doc: LPE Audio integration for HDMI or DP playback
> diff --git a/Documentation/gpu/intel-display/cdclk.rst b/Documentation/gpu/intel-display/cdclk.rst
> index 231b22a733e7..a66d623b0ec9 100644
> --- a/Documentation/gpu/intel-display/cdclk.rst
> +++ b/Documentation/gpu/intel-display/cdclk.rst
> @@ -2,7 +2,7 @@
>  .. Copyright © 2026 Intel Corporation
>  
>  Display clocks
> ---------------
> +==============
>  
>  .. kernel-doc:: drivers/gpu/drm/i915/display/intel_cdclk.c
>     :doc: CDCLK / RAWCLK
> diff --git a/Documentation/gpu/intel-display/dmc.rst b/Documentation/gpu/intel-display/dmc.rst
> index 2fcdbd457d79..4368da4c7048 100644
> --- a/Documentation/gpu/intel-display/dmc.rst
> +++ b/Documentation/gpu/intel-display/dmc.rst
> @@ -4,7 +4,7 @@
>  .. _drm/intel-display/dmc:
>  
>  DMC Firmware Support
> ---------------------
> +====================
>  
>  .. kernel-doc:: drivers/gpu/drm/i915/display/intel_dmc.c
>     :doc: DMC Firmware Support
> @@ -14,13 +14,13 @@ DMC Firmware Support
>  
>  
>  DMC Flip Queue
> ---------------------
> +==============
>  
>  .. kernel-doc:: drivers/gpu/drm/i915/display/intel_flipq.c
>     :doc: DMC Flip Queue
>  
>  DMC wakelock support
> ---------------------
> +====================
>  
>  .. kernel-doc:: drivers/gpu/drm/i915/display/intel_dmc_wl.c
>     :doc: DMC wakelock support
> diff --git a/Documentation/gpu/intel-display/dpio.rst b/Documentation/gpu/intel-display/dpio.rst
> index 32e6f299f256..84d92ac162f8 100644
> --- a/Documentation/gpu/intel-display/dpio.rst
> +++ b/Documentation/gpu/intel-display/dpio.rst
> @@ -2,7 +2,7 @@
>  .. Copyright © 2026 Intel Corporation
>  
>  DPIO
> -----
> +====
>  
>  .. kernel-doc:: drivers/gpu/drm/i915/display/intel_dpio_phy.c
>     :doc: DPIO
> diff --git a/Documentation/gpu/intel-display/dpll.rst b/Documentation/gpu/intel-display/dpll.rst
> index 35e8168ccfb9..c750352e0ae5 100644
> --- a/Documentation/gpu/intel-display/dpll.rst
> +++ b/Documentation/gpu/intel-display/dpll.rst
> @@ -2,7 +2,7 @@
>  .. Copyright © 2026 Intel Corporation
>  
>  Display PLLs
> -------------
> +============
>  
>  .. kernel-doc:: drivers/gpu/drm/i915/display/intel_dpll_mgr.c
>     :doc: Display PLLs
> diff --git a/Documentation/gpu/intel-display/drrs.rst b/Documentation/gpu/intel-display/drrs.rst
> index adb413f300f1..a5aaba63d6b9 100644
> --- a/Documentation/gpu/intel-display/drrs.rst
> +++ b/Documentation/gpu/intel-display/drrs.rst
> @@ -2,7 +2,7 @@
>  .. Copyright © 2026 Intel Corporation
>  
>  Display Refresh Rate Switching (DRRS)
> --------------------------------------
> +=====================================
>  
>  .. kernel-doc:: drivers/gpu/drm/i915/display/intel_drrs.c
>     :doc: Display Refresh Rate Switching (DRRS)
> diff --git a/Documentation/gpu/intel-display/dsb.rst b/Documentation/gpu/intel-display/dsb.rst
> index cbd40b0a4e7b..857aca59995a 100644
> --- a/Documentation/gpu/intel-display/dsb.rst
> +++ b/Documentation/gpu/intel-display/dsb.rst
> @@ -2,7 +2,7 @@
>  .. Copyright © 2026 Intel Corporation
>  
>  Display State Buffer
> ---------------------
> +====================
>  
>  .. kernel-doc:: drivers/gpu/drm/i915/display/intel_dsb.c
>     :doc: DSB
> diff --git a/Documentation/gpu/intel-display/fbc.rst b/Documentation/gpu/intel-display/fbc.rst
> index 40f9d16bdebd..de9e19021f50 100644
> --- a/Documentation/gpu/intel-display/fbc.rst
> +++ b/Documentation/gpu/intel-display/fbc.rst
> @@ -2,7 +2,7 @@
>  .. Copyright © 2026 Intel Corporation
>  
>  Frame Buffer Compression (FBC)
> -------------------------------
> +==============================
>  
>  .. kernel-doc:: drivers/gpu/drm/i915/display/intel_fbc.c
>     :doc: Frame Buffer Compression (FBC)
> diff --git a/Documentation/gpu/intel-display/fifo-underrun.rst b/Documentation/gpu/intel-display/fifo-underrun.rst
> index 50731f3a1f03..5d8f01921506 100644
> --- a/Documentation/gpu/intel-display/fifo-underrun.rst
> +++ b/Documentation/gpu/intel-display/fifo-underrun.rst
> @@ -2,7 +2,7 @@
>  .. Copyright © 2026 Intel Corporation
>  
>  Display FIFO Underrun Reporting
> --------------------------------
> +===============================
>  
>  .. kernel-doc:: drivers/gpu/drm/i915/display/intel_fifo_underrun.c
>     :doc: fifo underrun handling
> diff --git a/Documentation/gpu/intel-display/frontbuffer.rst b/Documentation/gpu/intel-display/frontbuffer.rst
> index 2a1bc63ba6b4..7ae38e0827bf 100644
> --- a/Documentation/gpu/intel-display/frontbuffer.rst
> +++ b/Documentation/gpu/intel-display/frontbuffer.rst
> @@ -2,7 +2,7 @@
>  .. Copyright © 2026 Intel Corporation
>  
>  Frontbuffer Tracking
> ---------------------
> +====================
>  
>  .. kernel-doc:: drivers/gpu/drm/i915/display/intel_frontbuffer.c
>     :doc: frontbuffer tracking
> diff --git a/Documentation/gpu/intel-display/hotplug.rst b/Documentation/gpu/intel-display/hotplug.rst
> index 4cd9dd5ac8fc..f33bc0087c27 100644
> --- a/Documentation/gpu/intel-display/hotplug.rst
> +++ b/Documentation/gpu/intel-display/hotplug.rst
> @@ -2,7 +2,7 @@
>  .. Copyright © 2026 Intel Corporation
>  
>  Hotplug
> --------
> +=======
>  
>  .. kernel-doc:: drivers/gpu/drm/i915/display/intel_hotplug.c
>     :doc: Hotplug
> diff --git a/Documentation/gpu/intel-display/plane.rst b/Documentation/gpu/intel-display/plane.rst
> index 41cf6571aab0..59932a82051b 100644
> --- a/Documentation/gpu/intel-display/plane.rst
> +++ b/Documentation/gpu/intel-display/plane.rst
> @@ -2,7 +2,7 @@
>  .. Copyright © 2026 Intel Corporation
>  
>  Atomic Plane Helpers
> ---------------------
> +====================
>  
>  .. kernel-doc:: drivers/gpu/drm/i915/display/intel_plane.c
>     :doc: atomic plane helpers
> diff --git a/Documentation/gpu/intel-display/psr.rst b/Documentation/gpu/intel-display/psr.rst
> index 134c905f500e..63e56abcdd56 100644
> --- a/Documentation/gpu/intel-display/psr.rst
> +++ b/Documentation/gpu/intel-display/psr.rst
> @@ -2,7 +2,7 @@
>  .. Copyright © 2026 Intel Corporation
>  
>  Panel Self Refresh PSR (PSR/SRD)
> ---------------------------------
> +================================
>  
>  .. kernel-doc:: drivers/gpu/drm/i915/display/intel_psr.c
>     :doc: Panel Self Refresh (PSR/SRD)
> diff --git a/Documentation/gpu/intel-display/vbt.rst b/Documentation/gpu/intel-display/vbt.rst
> index bbc7ee183f1b..be69f7fd7b39 100644
> --- a/Documentation/gpu/intel-display/vbt.rst
> +++ b/Documentation/gpu/intel-display/vbt.rst
> @@ -2,7 +2,7 @@
>  .. Copyright © 2026 Intel Corporation
>  
>  Video BIOS Table (VBT)
> -----------------------
> +======================
>  
>  .. kernel-doc:: drivers/gpu/drm/i915/display/intel_bios.c
>     :doc: Video BIOS Table (VBT)
> -- 
> 2.47.3
> 

  reply	other threads:[~2026-05-08 13:15 UTC|newest]

Thread overview: 9+ 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-08 10:20 ` [PATCH 2/3] Documentation/gpu: use === for Intel display section heading underlines Jani Nikula
2026-05-08 13:15   ` Rodrigo Vivi [this message]
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

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=af3h_ljWsBUMY5Um@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox