MIME-Version: 1.0
References: <7799513f0fb5aee27b64752c037980471be669c5.1677120686.git.self@dylanle.dev>
 <Y/bqtlbnWkKMIJI4@debian.me>
In-Reply-To: <Y/bqtlbnWkKMIJI4@debian.me>
From:   Jeffrey Hugo <jeffrey.l.hugo@gmail.com>
Date:   Mon, 27 Feb 2023 09:43:11 -0700
Message-ID: <CAOCk7NrAKZ2G-VbQW3MJUZmkKkO1Ccrs2wo12kg6QHysH-d=Yg@mail.gmail.com>
Subject: Re: [PATCH] Documentation: gpu: add acceleration node section
To:     Bagas Sanjaya <bagasdotme@gmail.com>, ogabbay@kernel.org
Cc:     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>,
        Shuah Khan <skhan@linuxfoundation.org>,
        linux-kernel@vger.kernel.org, dri-devel@lists.freedesktop.org,
        linux-doc@vger.kernel.org
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

I'm thinking the drm_file.h reference is broken.  I suspect it should
reference Documentation/accel/index.rst

Oded?

On Wed, Feb 22, 2023 at 9:25 PM Bagas Sanjaya <bagasdotme@gmail.com> wrote:
>
> 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