Date:   Thu, 23 Feb 2023 11:25:26 +0700
From:   Bagas Sanjaya <bagasdotme@gmail.com>
To:     Dylan Le <self@dylanle.dev>, David Airlie <airlied@gmail.com>,
        Daniel Vetter <daniel@ffwll.ch>,
        Maarten Lankhorst <maarten.lankhorst@linux.intel.com>,
        Maxime Ripard <mripard@kernel.org>,
        Thomas Zimmermann <tzimmermann@suse.de>,
        Jonathan Corbet <corbet@lwn.net>
Cc:     dri-devel@lists.freedesktop.org, linux-doc@vger.kernel.org,
        linux-kernel@vger.kernel.org,
        Shuah Khan <skhan@linuxfoundation.org>
Subject: Re: [PATCH] Documentation: gpu: add acceleration node section
Message-ID: <Y/bqtlbnWkKMIJI4@debian.me>
References: <7799513f0fb5aee27b64752c037980471be669c5.1677120686.git.self@dylanle.dev>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha512;
        protocol="application/pgp-signature"; boundary="txtJYMaFtpqUbF0X"
Content-Disposition: inline
In-Reply-To: <7799513f0fb5aee27b64752c037980471be669c5.1677120686.git.self@dylanle.dev>
Precedence: bulk


--txtJYMaFtpqUbF0X
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Thu, Feb 23, 2023 at 02:52:52AM +0000, Dylan Le wrote:
>=20
> This patch was initially written for the Linux Kernel Bug Fixing Mentorsh=
ip
> program. The patch adds a temporarily stubbed section on Acceleration Nod=
es
> to resolve a documentation warning.
>=20
> This resolves the warning:
> ./Documentation/gpu/drm-internals:179: ./include/drm/drm_file.h:411: WARN=
ING: undefined label: drm_accel_node

Please write the patch description in imperative mood ("Do foo" instead
of "This patch does foo").

>=20
> I would appreciate any feedback on what should be documented here.

I think above is better placed between the three dashes and diffstat ...


> ---

like here.

>  Documentation/gpu/drm-uapi.rst | 9 +++++++++
>  1 file changed, 9 insertions(+)
>=20

> +.. _drm_accel_node:
> +
> +Acceleration nodes
> +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
> +
> +.. note::
> +   There is not any documentation yet need to figure out what this is.

I'd like to write this stub as generic .. admonition:: block [1] instead,
with the content which is "This section is empty, add appropriate
documentation here." or similar.

[1]: https://docutils.sourceforge.io/docs/ref/rst/directives.html#generic-a=
dmonition

Thanks.=20

--=20
An old man doll... just what I always wanted! - Clara

--txtJYMaFtpqUbF0X
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iHUEABYKAB0WIQSSYQ6Cy7oyFNCHrUH2uYlJVVFOowUCY/bqrgAKCRD2uYlJVVFO
o+FeAP0b2iW2CAj1S1TrJcYRRRBYm4FfoNNv0qW/IOnP0+0YtgEAqSsziM6+WEkh
GGUj0Juc52PbS9EkGXhiWCs0Ai1Q6AE=
=C2XA
-----END PGP SIGNATURE-----

--txtJYMaFtpqUbF0X--