From mboxrd@z Thu Jan  1 00:00:00 1970
From: Li Wang <liwang@redhat.com>
Date: Thu, 27 May 2021 11:31:07 +0800
Subject: [LTP] [RFC PATCH 1/1] doc: Split test-writing-guidelines
In-Reply-To: <20210526154949.4473-1-pvorel@suse.cz>
References: <20210526154949.4473-1-pvorel@suse.cz>
Message-ID: <CAEemH2ecppttvGW1JeJ_E=w1eUJYEY8+Sx8Euztn2MhRYykEKQ@mail.gmail.com>
List-Id: <ltp.lists.linux.it>
MIME-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
To: ltp@lists.linux.it

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