Re: [PATCH v4 2/6] regex.3: Desoupify function descriptions

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi!

On Thu, Apr 20, 2023 at 04:00:40PM +0200, Alejandro Colomar wrote:
> On 4/20/23 15:02, наб wrote:
> > Instead, replace all of these with just the descriptions of what they do
> > with their arguments. What the arguments are is very clearly noted in
> > big bold in the prototypes.
> Please break this patch into smaller ones.
Cracked into one each for regcomp/regexec/regerror.

> > @@ -38,21 +38,13 @@ for subsequent
> >  .BR regexec ()
> >  searches.
> >  .PP
> > -.BR regcomp ()
> > -is supplied with
> > -.IR preg ,
> > -a pointer to a pattern buffer storage area;
> > -.IR regex ,
> > -a pointer to the null-terminated string and
> > -.IR cflags ,
> > -flags used to determine the type of compilation.
> > -.PP
> > -All regular expression searching must be done via a compiled pattern
> > -buffer, thus
> > -.BR regexec ()
> > -must always be supplied with the address of a
> > -.BR regcomp ()-initialized
> > -pattern buffer.
> > +The pattern buffer at
> > +.I *preg
> > +is initialized.
> I think I prefer avoiding passive voice here.  No?
> It initializes the pattern buffer at *preg?
I changed it to
  On success, the pattern buffer at *preg is initialized.
Which makes more sense as a post-condition,
and writing it the other way around would be weird
("If it succeeds, it initialises pattern buffer at *preg"?
 horrendous).

Best,

Attachment: signature.asc
Description: PGP signature


[Index of Archives]     [Kernel Documentation]     [Netdev]     [Linux Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux