On Thu, Feb 23, 2023 at 02:52:52AM +0000, Dylan Le wrote:
>
> This patch was initially written for the Linux Kernel Bug Fixing Mentorship
> program. The patch adds a temporarily stubbed section on Acceleration Nodes
> to resolve a documentation warning.
>
> This resolves the warning:
> ./Documentation/gpu/drm-internals:179: ./include/drm/drm_file.h:411: WARNING: undefined label: drm_accel_node
Please write the patch description in imperative mood ("Do foo" instead
of "This patch does foo").
>
> 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(+)
>
> +.. _drm_accel_node:
> +
> +Acceleration nodes
> +==================
> +
> +.. 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-admonition
Thanks.
--
An old man doll... just what I always wanted! - Clara
Attachment:
signature.asc
Description: PGP signature
