From: Petr Vorel <pvorel@suse.cz>
To: ltp@lists.linux.it
Subject: [LTP] [RFC PATCH 1/1] doc: Add Maintainer Patch Review Checklist
Date: Wed, 17 Mar 2021 11:51:45 +0100 [thread overview]
Message-ID: <YFHfQeFg0Uzwl3kH@pevik> (raw)
In-Reply-To: <YFHPbD132yWLMqK8@yuki.lan>
Hi all,
Cyril, Li, Jan, thanks for your tips, I'll use them for v2.
Few notes to some of Cyril's tips.
> > +### C tests
> > +* use new https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#22-writing-a-test-in-c[C API]
> > +* record in `.gitignore`
> > +* check coding style with `checkpatch.pl`
> Checkpatch is distributed with linux kernel source code, please also use
> reasonably recent one.
I'd prefer not duplicate the info, that's why I linked it docs, which already
mention this. Thus I'd prefer add "reasonably recent one" to
doc/test-writing-guidelines.txt.
> > +(more in https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#131-c-coding-style[C coding style])
> > +* docparse documentation
> + proper documentation comment
> -- this should be explained somewhere and linked here
Agree, but I'll probably skip this one.
> + If a test is a regression test it should include tags
> -- this should be explained somewhere as well and linked here
+1
> > +### Shell tests
> > +* use new https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#23-writing-a-testcase-in-shell[shell API]
> > +* check coding style with `checkbashism.pl`
> I guess that we should add the link to debian devscripts here
Again, I wanted to remove duplicity, but just repeating link here does no harm.
Kind regards,
Petr
next prev parent reply other threads:[~2021-03-17 10:51 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-17 8:33 [LTP] [RFC PATCH 1/1] doc: Add Maintainer Patch Review Checklist Petr Vorel
2021-03-17 8:35 ` Petr Vorel
2021-03-17 9:16 ` Petr Vorel
2021-03-17 9:24 ` Li Wang
2021-03-17 9:44 ` Cyril Hrubis
2021-03-17 10:51 ` Petr Vorel [this message]
2021-03-17 9:52 ` Jan Stancek
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=YFHfQeFg0Uzwl3kH@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.