[LTP] [PATCH 2/2] macros: Add basic docs

[Li Wang]

Petr Vorel <pvorel@suse.cz> wrote:

> > > + * DOC: tst_test_macros.h -- helpers for testing syscalls
> > >    */
> > Is this really needed?
>
> Well, IMHO throwing just functions description to users is not enough.
> I would even add a short description about the goal of these macros.
>
> And because sooner or later as we increase sphinx doc in the headers the list
> will be quite long. Therefore for the start I added just a title (short
> paragraph with a description would be of curse  better).

+1

Sometimes the file name doesn't reflect everything about the
content, adding a short description helps to understand.

Reviewed-by: Li Wang <liwang@redhat.com>

-- 
Regards,
Li Wang