Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Fri, 23 Jun 2023 17:08:22 +0300
From:   Laurent Pinchart <laurent.pinchart@ideasonboard.com>
To:     Geert Uytterhoeven <geert+renesas@glider.be>
Cc:     Maarten Lankhorst <maarten.lankhorst@linux.intel.com>,
        Maxime Ripard <mripard@kernel.org>,
        Thomas Zimmermann <tzimmermann@suse.de>,
        David Airlie <airlied@gmail.com>,
        Daniel Vetter <daniel@ffwll.ch>,
        Jonathan Corbet <corbet@lwn.net>,
        Jyri Sarha <jyri.sarha@iki.fi>,
        Tomi Valkeinen <tomba@kernel.org>,
        Bagas Sanjaya <bagasdotme@gmail.com>,
        dri-devel@lists.freedesktop.org, linux-doc@vger.kernel.org,
        linux-renesas-soc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2 2/4] drm/todo: Convert list of fbconv links to
 footnotes
Message-ID: <20230623140822.GC2112@pendragon.ideasonboard.com>
References: <cover.1686318012.git.geert+renesas@glider.be>
 <be8d2886f50485c86f74a3c1a117abb1b8718a07.1686318012.git.geert+renesas@glider.be>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
In-Reply-To: <be8d2886f50485c86f74a3c1a117abb1b8718a07.1686318012.git.geert+renesas@glider.be>
Precedence: bulk

Hi Geert,

Thank you for the patch.

On Fri, Jun 09, 2023 at 03:44:28PM +0200, Geert Uytterhoeven wrote:
> Convert the references to fbconv links to footnotes, so they can be
> navigated.
> 
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
> ---
> v2:
>   - New.
> ---
>  Documentation/gpu/todo.rst | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/gpu/todo.rst b/Documentation/gpu/todo.rst
> index 6c328613c049fc1d..ce1d4e22c327063b 100644
> --- a/Documentation/gpu/todo.rst
> +++ b/Documentation/gpu/todo.rst
> @@ -753,16 +753,16 @@ existing hardware. The new driver's call-back functions are filled from
>  existing fbdev code.
>  
>  More complex fbdev drivers can be refactored step-by-step into a DRM
> -driver with the help of the DRM fbconv helpers. [1] These helpers provide
> +driver with the help of the DRM fbconv helpers [4]_. These helpers provide
>  the transition layer between the DRM core infrastructure and the fbdev
>  driver interface. Create a new DRM driver on top of the fbconv helpers,
>  copy over the fbdev driver, and hook it up to the DRM code. Examples for
> -several fbdev drivers are available at [1] and a tutorial of this process
> -available at [2]. The result is a primitive DRM driver that can run X11
> +several fbdev drivers are available at [4]_ and a tutorial of this process
> +available at [5]_. The result is a primitive DRM driver that can run X11

When using footnotes, the main text must read correctly if you ignore
the notes. This isn't the case for the second and third footnotes here.

    Examples for several fbdev drivers are available in Thomas
    Zimmermann's fbconv tree [4]_, as well as a tutorial of this
    process [5]_.

I'm not making a call on whether that's better or not that's better than
the current situation.

An alternative is to use plain links:

    Examples for several fbdev drivers are available in 'Thomas
    Zimmermann's fbconv tree`_, as well as a `tutorial of this
    process`_.

    .. _Thomas Zimmermann's fbconv tree: https://gitlab.freedesktop.org/tzimmermann/linux/tree/fbconv
    .. _tutorial of this process: https://gitlab.freedesktop.org/tzimmermann/linux/blob/fbconv/drivers/gpu/drm/drm_fbconv_helper.c

>  and Weston.
>  
> - - [1] https://gitlab.freedesktop.org/tzimmermann/linux/tree/fbconv
> - - [2] https://gitlab.freedesktop.org/tzimmermann/linux/blob/fbconv/drivers/gpu/drm/drm_fbconv_helper.c
> + .. [4] https://gitlab.freedesktop.org/tzimmermann/linux/tree/fbconv
> + .. [5] https://gitlab.freedesktop.org/tzimmermann/linux/blob/fbconv/drivers/gpu/drm/drm_fbconv_helper.c
>  
>  Contact: Thomas Zimmermann <tzimmermann@suse.de>
>  

-- 
Regards,

Laurent Pinchart