Re: [LTP] [PATCH v2 1/2] doc: Document process_state

[Petr Vorel <pvorel@suse.cz>]

> Hi!
> > > > - * R - process is running
> > > > - * S - process is sleeping
> > > > - * D - process sleeping uninterruptibly
> > > > - * Z - zombie process
> > > > - * T - process is traced
> > > > + * Possible process states:
> > > Maybe: use link to https://man7.org/linux/man-pages/man1/ps.1.html ?

> > > -* Possible process states:
> > > +* Possible process states (see :man1:`ps`):

> > 1. We do not have man1 defined in exlinks in conf.py

> > 2. Even if added there exlinks does not seem work from documentation
> >    generated from headers

> This actually works, once I fixed typo in the conf.py change.

+1

...

> > > * Z

> > Zombie process is described in the list.

> > > Also, do we want specify the process states in both TST_PROCESS_STATE_WAIT() and
> > > TST_THREAD_STATE_WAIT(), or just specify it in one and mention in the other that
> > > they specify it? (via :ref: or c:func:).

> > Again, none of the :ref: or c:func: is working in docs generate from
> > headers.

Maybe c:func: really works only in the headers. I have in my notes
:c:func:`tst_kvercmp()`. We already use in doc/* some :ref: e.g.
:ref:`struct tst_device` or :ref:`tst_brk`.

> And this one needs to be just TST_PROCESS_STATE_WAIT() to be processed
> as a link in headers.

Interesting. For me works only :c:func:`TST_PROCESS_STATE_WAIT()` or
:c:func:`tst_brk()` when adding it into random file (e.g.
doc/maintainers/patch_review.rst). 

Anyway, thanks for taking care to link it.

Kind regards,
Petr

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp