linux-man.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: наб <nabijaczleweli@nabijaczleweli.xyz>
To: "Alejandro Colomar (man-pages)" <alx.manpages@gmail.com>
Cc: linux-man@vger.kernel.org
Subject: [PATCH v5 1/8] regex.3: Desoupify regcomp() description
Date: Thu, 20 Apr 2023 17:35:45 +0200	[thread overview]
Message-ID: <fcb8df21b1f734ef33a64fa7d0861984c133faea.1682004802.git.nabijaczleweli@nabijaczleweli.xyz> (raw)
In-Reply-To: <cover.1682004802.git.nabijaczleweli@nabijaczleweli.xyz>

[-- Attachment #1: Type: text/plain, Size: 1532 bytes --]

Behold:
  regerror() is passed the error code, errcode, the pattern buffer,
  preg, a pointer to a character string buffer, errbuf, and the size
  of the string buffer, errbuf_size.

Absolute soup. This reads to me like an ill-conceived copy from a very
early standard version. It looks fine in source form but is horrific to
read as running text.

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.

Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>
---
 man3/regex.3 | 22 +++++++---------------
 1 file changed, 7 insertions(+), 15 deletions(-)

diff --git a/man3/regex.3 b/man3/regex.3
index 129c42412..2f6ee816f 100644
--- a/man3/regex.3
+++ b/man3/regex.3
@@ -38,21 +38,13 @@ .SS Compilation
 .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.
+On success, the pattern buffer at
+.I *preg
+is initialized.
+.I regex
+is a null-terminated string.
+The locale must be the same when running
+.BR regexec ().
 .PP
 .I cflags
 is the
-- 
2.30.2


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

  reply	other threads:[~2023-04-20 15:35 UTC|newest]

Thread overview: 143+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-04-19 17:47 [PATCH 1/2] regex.3: note that pmatch is still used if REG_NOSUB if REG_STARTEND наб
2023-04-19 17:48 ` [PATCH 2/2] regex.3: improve REG_STARTEND наб
2023-04-19 20:23   ` Alejandro Colomar
2023-04-19 21:20     ` наб
2023-04-19 21:45       ` Alejandro Colomar
2023-04-19 23:23       ` [PATCH v2 1/9] regex.3: note that pmatch is still used if REG_NOSUB if REG_STARTEND наб
2023-04-20 11:21         ` Alejandro Colomar
2023-04-19 23:23       ` [PATCH v2 2/9] regex.3: improve REG_STARTEND наб
2023-04-20 10:00         ` G. Branden Robinson
2023-04-20 11:13           ` наб
2023-04-20 18:33             ` G. Branden Robinson
2023-04-20 22:29               ` Alejandro Colomar
2023-04-21  5:00                 ` G. Branden Robinson
2023-04-21  8:06                   ` a straw-man `SR` man(7) macro for (sub)section cross references (was: [PATCH v2 2/9] regex.3: improve REG_STARTEND) G. Branden Robinson
2023-04-21 11:07                   ` [PATCH v2 2/9] regex.3: improve REG_STARTEND Alejandro Colomar
2023-06-02  0:12         ` Alejandro Colomar
2023-06-02  0:49           ` наб
2023-06-03 17:30             ` Alejandro Colomar
2023-04-19 23:23       ` [PATCH v2 3/9] regex.3: ffix наб
2023-04-20 11:23         ` Alejandro Colomar
2023-04-19 23:23       ` [PATCH v2 4/9] regex.3: wfix наб
2023-04-20 11:27         ` Alejandro Colomar
2023-04-19 23:23       ` [PATCH v2 5/9] regex.3: ffix наб
2023-04-20 11:28         ` Alejandro Colomar
2023-04-20 12:12           ` [PATCH v3 5/9] adjtimex.2, clone.2, mprotect.2, open.2, syscall.2, regex.3: ffix, wfix наб
2023-04-20 12:52             ` Alejandro Colomar
2023-04-20 13:03               ` Alejandro Colomar
2023-04-20 14:13                 ` наб
2023-04-20 14:19                   ` Alejandro Colomar
2023-04-20 18:42                 ` G. Branden Robinson
2023-04-20 22:40                   ` Alejandro Colomar
2023-04-19 23:25       ` [PATCH v2 6/9] regex.3, regex_t.3type, regmatch_t.3type, regoff_t.3type: move in with regex.3 наб
2023-04-20 11:31         ` Alejandro Colomar
2023-04-20 13:02           ` [PATCH v4 1/6] regex.3: Fix subsection headings наб
2023-04-20 13:13             ` Alejandro Colomar
2023-04-20 13:24               ` наб
2023-04-20 13:35                 ` Alejandro Colomar
2023-04-20 15:35             ` [PATCH v5 0/8] regex.3 momento наб
2023-04-20 15:35               ` наб [this message]
2023-04-20 16:37                 ` [PATCH v5 1/8] regex.3: Desoupify regcomp() description Alejandro Colomar
2023-04-20 15:35               ` [PATCH v5 2/8] regex.3: Desoupify regexec() description наб
2023-04-20 15:35               ` [PATCH v5 3/8] regex.3: Desoupify regerror() description наб
2023-04-20 16:42                 ` Alejandro Colomar
2023-04-20 18:50                   ` наб
2023-04-20 16:50                 ` Alejandro Colomar
2023-04-20 17:23                 ` Alejandro Colomar
2023-04-20 18:46                   ` наб
2023-04-20 22:45                     ` Alejandro Colomar
2023-04-20 23:05                       ` наб
2023-04-20 15:35               ` [PATCH v5 4/8] regex.3: Improve REG_STARTEND наб
2023-04-20 17:29                 ` Alejandro Colomar
2023-04-20 19:30                   ` наб
2023-04-20 19:33                     ` наб
2023-04-20 23:01                     ` Alejandro Colomar
2023-04-21  0:13                       ` наб
2023-04-20 15:36               ` [PATCH v5 5/8] regex.3, regex_t.3type, regmatch_t.3type, regoff_t.3type: Move & link regex_t.3type into regex.3 наб
2023-04-20 15:36               ` [PATCH v5 6/8] regex.3: Finalise move of reg*.3type наб
2023-04-20 15:36               ` [PATCH v5 7/8] regex.3: Destandardeseify Match offsets наб
2023-04-20 15:36               ` [PATCH v5 8/8] regex.3: Further clarify the sole purpose of REG_NOSUB наб
2023-04-20 19:36               ` [PATCH v6 0/8] regex.3 momento наб
2023-04-20 19:36                 ` [PATCH v6 1/8] regex.3: Desoupify regexec() description наб
2023-04-20 23:24                   ` Alejandro Colomar
2023-04-21  0:33                     ` наб
2023-04-21  0:49                       ` Alejandro Colomar
2023-04-20 19:36                 ` [PATCH v6 2/8] regex.3: Desoupify regerror() description наб
2023-04-20 19:37                 ` [PATCH v6 3/8] regex.3: Desoupify regfree() description наб
2023-04-20 23:35                   ` Alejandro Colomar
2023-04-21  0:27                     ` наб
2023-04-21  0:37                       ` [PATCH v7 " наб
2023-04-21  0:58                       ` [PATCH v6 " Alejandro Colomar
2023-04-21  1:24                         ` [PATCH v7a " наб
2023-04-21  1:55                           ` Alejandro Colomar
2023-04-20 19:37                 ` [PATCH v6 4/8] regex.3: Improve REG_STARTEND наб
2023-04-20 23:15                   ` Alejandro Colomar
2023-04-21  0:39                     ` [PATCH v7 " наб
2023-04-21  1:42                       ` Alejandro Colomar
2023-04-21  2:16                         ` наб
2023-04-21  9:45                           ` Alejandro Colomar
2023-04-21 12:13                             ` наб
2023-04-21 12:21                               ` Alejandro Colomar
2023-04-21 12:23                               ` Alejandro Colomar
2023-04-21 10:19                           ` Jakub Wilk
2023-04-21 10:22                             ` Alejandro Colomar
2023-04-21 10:44                               ` Jakub Wilk
2023-04-21 11:16                                 ` Alejandro Colomar
2023-04-21 11:34                             ` наб
2023-04-21 12:46                               ` Jakub Wilk
2023-04-20 19:37                 ` [PATCH v6 5/8] regex.3, regex_t.3type, regmatch_t.3type, regoff_t.3type: Move & link regex_t.3type into regex.3 наб
2023-04-20 19:37                 ` [PATCH v6 6/8] regex.3: Finalise move of reg*.3type наб
2023-04-20 19:37                 ` [PATCH v6 7/8] regex.3: Destandardeseify Match offsets наб
2023-04-20 19:37                 ` [PATCH v6 8/8] regex.3: Further clarify the sole purpose of REG_NOSUB наб
2023-04-21  2:01                 ` [PATCH v6 0/8] regex.3 momento Alejandro Colomar
2023-04-21  2:48                   ` [PATCH v8 0/5] " наб
2023-04-21  2:48                     ` [PATCH v8 1/5] regex.3: Desoupify regerror() description наб
2023-04-21 10:06                       ` Alejandro Colomar
2023-04-21 12:03                         ` [PATCH v9] " наб
2023-04-21 12:26                           ` Alejandro Colomar
2023-04-21 12:27                             ` Alejandro Colomar
2023-04-21  2:48                     ` [PATCH v8 2/5] regex.3, regex_t.3type, regmatch_t.3type, regoff_t.3type: Move & link regex_t.3type into regex.3 наб
2023-04-21 11:55                       ` Alejandro Colomar
2023-04-21 11:57                         ` Alejandro Colomar
2023-04-21 11:57                           ` Alejandro Colomar
2023-04-21  2:48                     ` [PATCH v8 3/5] regex.3: Finalise move of reg*.3type наб
2023-04-21 10:33                       ` Alejandro Colomar
2023-04-21 10:34                         ` Alejandro Colomar
2023-04-21 11:26                           ` наб
2023-04-21 11:36                             ` Alejandro Colomar
2023-04-21 11:49                               ` наб
     [not found]                         ` <1d2d0aa8-cb28-2d7f-c48b-7a02f907cb5b@gmail.com>
2023-04-21 11:57                           ` Ralph Corderoy
2023-04-21 11:59                             ` Alejandro Colomar
2023-04-21 12:03                               ` Alejandro Colomar
2023-04-21 12:09                               ` Ralph Corderoy
2023-04-21 12:14                                 ` Alejandro Colomar
2023-04-21  2:49                     ` [PATCH v8 4/5] regex.3: Destandardeseify Match offsets наб
2023-04-21 10:36                       ` Alejandro Colomar
2023-04-21 12:55                         ` [PATCH v9] " наб
2023-04-21 13:15                           ` Alejandro Colomar
2023-04-21 13:29                             ` [PATCH v9a] " наб
2023-04-21 13:55                               ` Alejandro Colomar
2023-04-21  2:49                     ` [PATCH v8 5/5] regex.3: Further clarify the sole purpose of REG_NOSUB наб
2023-04-21 11:44                       ` Alejandro Colomar
2023-04-21 10:00                     ` [PATCH v8 0/5] regex.3 momento Alejandro Colomar
2023-04-20 13:02           ` [PATCH v4 2/6] regex.3: Desoupify function descriptions наб
2023-04-20 14:00             ` Alejandro Colomar
2023-04-20 14:37               ` наб
2023-04-20 13:02           ` [PATCH v4 3/6] regex.3: Improve REG_STARTEND наб
2023-04-20 14:04             ` Alejandro Colomar
2023-04-20 13:02           ` [PATCH v4 4/6] regex.3, regex_t.3type: Move regex_t.3type into regex.3 наб
2023-04-20 13:02           ` [PATCH v4 5/6] regex.3, regex_t.3type, regmatch_t.3type, regoff_t.3type: Move in with regex.3 наб
2023-04-20 14:07             ` Alejandro Colomar
2023-04-20 13:02           ` [PATCH v4 6/6] regex.3: Destandardeseify Match offsets наб
2023-04-20 14:10             ` Alejandro Colomar
2023-04-20 15:05               ` наб
2023-04-20 18:51                 ` G. Branden Robinson
2023-04-21 11:34                 ` Alejandro Colomar
2023-04-19 23:25       ` [PATCH v2 7/9] regex.3: destandardeseify Byte offsets наб
2023-04-19 23:26       ` [PATCH v2 8/9] regex.3: desoupify function descriptions наб
2023-04-20 11:15         ` [PATCH v3 " наб
2023-04-20 11:43           ` Alejandro Colomar
2023-04-20 11:50             ` наб
2023-04-19 23:26       ` [PATCH v2 9/9] regex.3: fix subsection headings наб
2023-04-20 11:17         ` [PATCH v3 " наб
2023-04-19 19:51 ` [PATCH 1/2] regex.3: note that pmatch is still used if REG_NOSUB if REG_STARTEND Alejandro Colomar

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=fcb8df21b1f734ef33a64fa7d0861984c133faea.1682004802.git.nabijaczleweli@nabijaczleweli.xyz \
    --to=nabijaczleweli@nabijaczleweli.xyz \
    --cc=alx.manpages@gmail.com \
    --cc=linux-man@vger.kernel.org \
    /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;
as well as URLs for NNTP newsgroup(s).