From mboxrd@z Thu Jan 1 00:00:00 1970 From: Richard Palethorpe Date: Thu, 27 May 2021 07:56:50 +0100 Subject: [LTP] [RFC PATCH 1/1] doc: Split test-writing-guidelines In-Reply-To: References: <20210526154949.4473-1-pvorel@suse.cz> Message-ID: <87pmxck6kt.fsf@suse.de> List-Id: MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit To: ltp@lists.linux.it Hello, Petr Vorel writes: >> On Thu, May 27, 2021 at 12:19 PM Petr Vorel wrote: > >> > Hi Li, all, > >> > > > > https://github.com/pevik/ltp/wiki/Test-Writing-Guidelines >> > > > > https://github.com/pevik/ltp/wiki/C-Test-API > >> > > Seems we have a similar guideline "c-test-tutorial-simple.txt", >> > > maybe better to combine them together? The tutorial is a step-by-step guide which also includes general info, like how to use Git. The test writing guidelines are a reference specifically for LTP. So they are very different IMO. This reminds me though, that the tutorial probably needs updating. >> > I'd prefer to keep them separate. Because otherwise page gets long again. >> > But I'd consider to unify names ("LTP C Test API" vs. "C Test Case Tutorial" >> > - API vs. Case). > >> No problem, I'm OK with unifying names. > >> And yes, we can rename with the same prefix start on purposely to make >> them keep nearby in alphabetical sorting. +1 > > I'm not sure myself about renaming. But adding list of files generated by us in > HOME [1] and Developers corner [2] should help. > > Also I'd add some NOTE: See also links (eg. to C Test API at the top in C Test > Case Tutorial and vice versa, in Shell Test API to C Test API and vice > versa). +1 > >> > > > > https://github.com/pevik/ltp/wiki/Shell-Test-API > >> > > Forgot to mention, with the increased number of docs, do you think it >> > > necessary to create an index for including all documents in a sort? >> > There is list of pages on the right. But as it's sorted alphabetically, >> > it's not enough. Maybe we should add this list to README.md and to HOME wiki >> > page. > >> To HOME wiki sounds good, we can do a simple triage in there. > >> Thanks a lot for the documentation work! > Thanks for your review! > > Kind regards, > Petr > > [1] https://github.com/linux-test-project/ltp/wiki > [2] https://github.com/linux-test-project/ltp#developers-corner -- Thank you, Richard.