[LTP] [RFC PATCH 1/1] doc: Split test-writing-guidelines
Li Wang
liwang@redhat.com
Thu May 27 05:31:07 CEST 2021
Hi Petr,
On Wed, May 26, 2021 at 11:50 PM Petr Vorel <pvorel@suse.cz> wrote:
>
> Test Writing Guidelines wiki page is too long, thus split it
> into 3 parts:
>
> 1) generic part (only first chapter, the same URL)
> 2) C test API (2.2 chapter, 4. Common problems)
> 3) shell test API
>
> Unfortunately this breaks users' bookmarks.
>
> Start numbering in headers from 1 on each page (links are broken
> anyway).
>
> NOTE: in order to have '...' formatting as code,
> main header ====== was needed to add on the page.
>
> Signed-off-by: Petr Vorel <pvorel@suse.cz>
> ---
> See it:
> https://github.com/pevik/ltp/wiki/Test-Writing-Guidelines
> https://github.com/pevik/ltp/wiki/C-Test-API
> https://github.com/pevik/ltp/wiki/Shell-Test-API
+1
I think this is a good proposal, the split doc looks more friendly to read.
--
Regards,
Li Wang
More information about the ltp
mailing list