From: Petr Vorel <pvorel@suse.cz>
To: ltp@lists.linux.it
Subject: [LTP] [RFC PATCH 1/1] doc: Split test-writing-guidelines
Date: Thu, 27 May 2021 08:02:10 +0200 [thread overview]
Message-ID: <YK814g7TF3JDy37G@pevik> (raw)
In-Reply-To: <CAEemH2doGFdk395L5t7cGBKT63AzORNjEU4=H6qQFbXjO2xCTA@mail.gmail.com>
> On Thu, May 27, 2021 at 12:19 PM Petr Vorel <pvorel@suse.cz> 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?
> > 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.
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).
> > > > > 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
next prev parent reply other threads:[~2021-05-27 6:02 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-26 15:49 [LTP] [RFC PATCH 1/1] doc: Split test-writing-guidelines Petr Vorel
2021-05-27 3:31 ` Li Wang
2021-05-27 3:49 ` Li Wang
2021-05-27 4:00 ` Xie Ziyao
2021-05-27 4:19 ` Petr Vorel
2021-05-27 4:51 ` Li Wang
2021-05-27 6:02 ` Petr Vorel [this message]
2021-05-27 6:56 ` Richard Palethorpe
2021-05-27 12:28 ` Cyril Hrubis
2021-05-27 14:44 ` Petr Vorel
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=YK814g7TF3JDy37G@pevik \
--to=pvorel@suse.cz \
--cc=ltp@lists.linux.it \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox