Re: [PATCH] docs: dev-tools: Add documentation for the device focused kselftests

[Shuah Khan]

On 10/3/24 08:41, Nícolas F. R. A. Prado wrote:
> On Wed, Oct 02, 2024 at 12:00:10PM -0600, Shuah Khan wrote:
> > On 10/1/24 09:43, Nícolas F. R. A. Prado wrote:
> > > Add documentation for the kselftests focused on testing devices and
> > > point to it from the kselftest documentation. There are multiple tests
> > > in this category so the aim of this page is to make it clear when to run
> > > each test.
> > >
> > > Signed-off-by: Nícolas F. R. A. Prado <nfraprado@xxxxxxxxxxxxx>
> > > ---
> > > This patch depends on patch "kselftest: devices: Add test to detect
> > > missing devices" [1], since this patch documents that test.
> > >
> > > [1] https://lore.kernel.org/all/20240928-kselftest-dev-exist-v2-1-fab07de6b80b@xxxxxxxxxxxxx
> > > ---
> > >    Documentation/dev-tools/kselftest.rst       |  9 ++++++
> > >    Documentation/dev-tools/testing-devices.rst | 47 +++++++++++++++++++++++++++++
> >
> > The new file needs to be added to Documentation/dev-tools/index.rst
> >
> > Docs make should have warned about this?
>
> There is no warning. I have added this new document in a new toctree in the
> kselftest.rst, as you can see in the hunk below.

I missed that.

> Since this new page is specific to kselftest, I think listing it on the
> kselftest page makes the most sense and will make it easier to find.

Yes - including it from kselftest makes sense to me.

Reviewed-by: Shuah Khan <skhan@xxxxxxxxxxxxxxxxxxx>

Jon, Let me know if you would like me to take this through kselftest
tree.

thanks,
-- Shuah