From: Petr Vorel <pvorel@suse.cz>
To: ltp@lists.linux.it
Subject: [LTP] [PATCH v2 05/11] syscalls: Add a few documentation comments
Date: Thu, 5 Nov 2020 13:48:42 +0100 [thread overview]
Message-ID: <20201105124842.GA24940@pevik> (raw)
In-Reply-To: <20201105124810.GC10395@yuki.lan>
Hi Cyril,
> > > + * [DESCRIPTION]
> > > + * Checks that process which called abort() gets killed by SIGIOT
> > > and dumps core.
> > ...
> > > +/*\
> > > + * [DOCUMENTATION]
> > > + * Verify that acct() returns proper errno on failure.
> > > +\*/
> > > +
> > I noticed that in some places the DESCRIPTION tag is used and in
> > another DOCUMENTATION. What is the difference between the two and which
> > should be used when?
> This is one of the open points at the moment. The exact format of the
> test description needs to be decided on and written down.
+1.
> However I wanted to get the code reviewed and included in upstream even
> though there are a few loose ends since it's complex enough as it is and
> the detail can be worked on later. Especially since I want to make use
> of the metadata for parallel test execution and the documentation part
> is not that important there.
+1. I also wouldn't want to block whole patchset because documentation
is not set.
Kind regards,
Petr
next prev parent reply other threads:[~2020-11-05 12:48 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-03 19:13 [LTP] [PATCH v2 00/11] Test metadata extraction Petr Vorel
2020-11-03 19:13 ` [LTP] [PATCH v2 01/11] make: Support compiling native build tools Petr Vorel
2020-11-03 19:13 ` [LTP] [PATCH v2 02/11] travis: Add git Petr Vorel
2020-11-03 19:13 ` [LTP] [PATCH v2 03/11] docparse: Add test documentation parser Petr Vorel
2020-11-04 7:30 ` Petr Vorel
2020-11-04 13:20 ` Li Wang
2020-11-04 16:37 ` Petr Vorel
2020-11-03 19:13 ` [LTP] [PATCH v2 04/11] docparse: Add README Petr Vorel
2020-11-03 19:13 ` [LTP] [PATCH v2 05/11] syscalls: Add a few documentation comments Petr Vorel
2020-11-04 11:34 ` Radoslav Kolev
2020-11-04 15:54 ` Petr Vorel
2020-11-05 12:48 ` Cyril Hrubis
2020-11-05 12:48 ` Petr Vorel [this message]
2020-11-03 19:13 ` [LTP] [PATCH v2 06/11] syscalls: Move needs_drivers inside of the tst_test struct Petr Vorel
2020-11-03 19:13 ` [LTP] [PATCH v2 07/11] make: Allow {INSTALL, MAKE}_TARGETS be a directory Petr Vorel
2020-11-03 19:13 ` [LTP] [PATCH v2 08/11] make: Allow CLEAN_TARGETS to remove directories Petr Vorel
2020-11-03 19:13 ` [LTP] [PATCH v2 09/11] travis: Install docparse dependencies Petr Vorel
2020-11-03 19:13 ` [LTP] [PATCH v2 10/11] docparse: Add configure options Petr Vorel
2020-11-03 19:13 ` [LTP] [PATCH v2 11/11] docparse: Generate html and pdf using asciidoc{, tor} Petr Vorel
2020-11-12 13:11 ` [LTP] [PATCH v2 00/11] Test metadata extraction Petr Vorel
2020-11-13 17:06 ` Petr Vorel
2020-11-16 6:21 ` Li Wang
2020-11-16 6:30 ` 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=20201105124842.GA24940@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.