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

[Nícolas F. R. A. Prado]

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.

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.

Do you want the new file to be listed in both places (ie kselftest.rst and
index.rst)? It will show up in the index.rst next to kselftest rather than
inside it.

Another option would be to do like kunit and create a directory for kselftest
and have an index.rst there to point to both the current kselftest.rst and the
new document. Structure-wise that would probably be the best approach.

> 
> >   2 files changed, 56 insertions(+)
> > 
> > diff --git a/Documentation/dev-tools/kselftest.rst b/Documentation/dev-tools/kselftest.rst
> > index f3766e326d1e..fdb1df86783a 100644
> > --- a/Documentation/dev-tools/kselftest.rst
> > +++ b/Documentation/dev-tools/kselftest.rst
> > @@ -31,6 +31,15 @@ kselftest runs as a userspace process.  Tests that can be written/run in
> >   userspace may wish to use the `Test Harness`_.  Tests that need to be
> >   run in kernel space may wish to use a `Test Module`_.
> > +Documentation on the tests
> > +==========================
> > +
> > +For documentation on the kselftests themselves, see:
> > +
> > +.. toctree::
> > +
> > +   testing-devices
> > +
> >   Running the selftests (hotplug tests are run in limited mode)
> >   =============================================================
> > diff --git a/Documentation/dev-tools/testing-devices.rst b/Documentation/dev-tools/testing-devices.rst
> > new file mode 100644
> > index 000000000000..ab26adb99051
> > --- /dev/null
> > +++ b/Documentation/dev-tools/testing-devices.rst
> > @@ -0,0 +1,47 @@
> > +.. SPDX-License-Identifier: GPL-2.0
> > +.. Copyright (c) 2024 Collabora Ltd
> > +
> > +=============================
> > +Device testing with kselftest
> > +=============================
> > +
> 
> Get rid of the extra blank line.

Ack.

Thanks,
Nícolas