[LTP] [PATCH 1/3] doc: Add missing API references to api_c_tests.rst

[Andrea Cervesato]

Hi Petr,

as mentioned inside the cover letter, this patch-set has to be
added on top of the " [PATCH 0/4] Fix documentation issues "
patch-set. Once done that it won't have issues anymore with
warnings etc.

> Hi Andrea,
> 
> > Fix broken kernel-doc reference to renamed tse_numa.h header and add
> Not only this patch but none of the other two actually fixes it. I suppose you
> forget to amend git commit.
> 
> How about to fix this one in a separate commit (which you can merge right now,
> no need to even send it to ML) with the usual tag?
> 
> Fixes: eef750db28 ("libs: adopt tse_ prefix for extended (non-core) library")
> 
> Specially because Cyril might want to review if all the docs is correct (which
> takes time).
> 
> Also there are still some unresolved problems, but we can fix it afterwards:
> 
> include/tst_test.h:302: WARNING: undefined label: 'struct tst_option'
> include/tst_test.h:325: WARNING: undefined label: 'struct tst_device'
> include/tst_test.h:361: WARNING: undefined label: 'struct tst_device'
> include/tst_test.h:502: WARNING: undefined label: 'struct tst_path_val'
> include/tst_test.h:523: WARNING: undefined label: 'struct tst_buffers'
> include/tst_test.h:528: WARNING: undefined label: 'struct tst_cap'
> include/tst_test.h:531: WARNING: undefined label: 'struct tst_tag'
> include/tst_test.h:533: WARNING: undefined label: 'struct tst_cmd'
> include/tst_kvercmp.h:97: WARNING: undefined label: 'struct tst_kern_exv'
> doc/developers/api_shell_tests.rst:30: WARNING: undefined label: 'struct tst_test'
> doc/developers/test_case_tutorial.rst:140: WARNING: undefined label: 'struct tst_test'
> doc/developers/todo.rst:62: WARNING: undefined label: 'struct tst_test'
> doc/developers/writing_tests.rst:141: WARNING: undefined label: 'struct tst_test'
> doc/developers/writing_tests.rst:364: WARNING: undefined label: 'struct tst_test'
> doc/developers/writing_tests.rst:558: WARNING: undefined label: 'struct tst_device'
> 
> Generally changes are good, thanks for finishing the transition.
> With fixed tse_numa.h (preferably in a separate commit) you may add:
> 
> Reviewed-by: Petr Vorel <pvorel@suse.cz>
> 
> > kernel-doc directives for 12 headers that were missing from the C API
> > documentation page:
> 
> >   tst_clone.h, tst_device.h, tst_fs.h, tst_fuzzy_sync.h,
> >   tst_hugepage.h, tst_kconfig.h, tst_memutils.h, tst_safe_file_ops.h,
> >   tst_taint.h, tse_numa.h, tse_swap.h, tse_uinput.h
> 
> > Convert plain comments to kernel-doc format in tst_device.h,
> > tst_hugepage.h, tst_clone.h, and tst_taint.h so the documentation
> > builder can extract them.
> 
> > Sort all sections alphabetically under LTP C API.
> 
> FYI I quite liked that Core API was the first, but ok with the move.
> 
> Kind regards,
> Petr

--
Andrea Cervesato
SUSE QE Automation Engineer Linux
andrea.cervesato@suse.com