From: Petr Vorel <pvorel@suse.cz>
To: ltp@lists.linux.it
Subject: [LTP] [PATCH v2 05/11] syscalls: Add a few documentation comments
Date: Wed, 4 Nov 2020 16:54:58 +0100 [thread overview]
Message-ID: <20201104155458.GB12971@pevik> (raw)
In-Reply-To: <d0e937e67108585af4423e9f688941cb194476ba.camel@suse.com>
Hi Rado, all,
> Hello Petr,
> On Tue, 2020-11-03 at 20:13 +0100, Petr Vorel wrote:
> > + * [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?
I'd suggest to use [DESCRIPTION] and drop [DOCUMENTATION] (whole metadata are
documentation).
It'd be good to document that in README.md
Kind regards,
Petr
next prev parent reply other threads:[~2020-11-04 15:54 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 [this message]
2020-11-05 12:48 ` Cyril Hrubis
2020-11-05 12:48 ` Petr Vorel
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=20201104155458.GB12971@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