Skip to contentSkip to conversation

Document regmatch_t (and a ffix)

PATCH In review Alejandro Colomar 2 participants 8 messages Sep 18, 2020 Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

lore
Share & tools
lore
#0 lore raw

cover Document regmatch_t (and a ffix)

Hi Michael,

Documentation for regmatch_t + a ffix patch.
(apply after regoff_t patches).

Thanks,

Alex

Alejandro Colomar (3):
system_data_types.7: ffix
system_data_types.7: Document regmatch_t
regmatch_t.3: New page for new documented type in system_data_types(7)

 man3/regmatch_t.3        |  1 +
 man7/system_data_types.7 | 27 +++++++++++++++++++++++----
 2 files changed, 24 insertions(+), 4 deletions(-)
 create mode 100644 man3/regmatch_t.3
Signature · 1 line
2.28.0
#1 lore raw

PATCH 1/3 system_data_types.7: ffix

---
 man7/system_data_types.7 | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
man7/system_data_types.7 +2 -2
index 16dcb7d66..2ccbfe817 100644
@@ -65,7 +65,7 @@ system_data_types \- overview of system data types
 .I ptrdiff_t
 .IP
 Include:
-.I <stddef.h>.
+.IR <stddef.h> .
 .IP
 Used for a count of elements, and array indices.
 It is the result of subtracting two pointers.
@@ -85,7 +85,7 @@ types in this page.
 .I regoff_t
 .IP
 Include:
-.I <regex.h>.
+.IR <regex.h> .
 .IP
 According to POSIX, it shall be a signed integer type
 capable of storing the largest value that can be stored in either a
Signature · 1 line
2.28.0
#2 lore raw

Re: [PATCH 1/3] system_data_types.7: ffix

Quoted 1 line · Alejandro Colomar

Thanks, Alex. Patch applied.

Cheers,

Michael

Quoted 27 lines
---
 man7/system_data_types.7 | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
man7/system_data_types.7 +2 -2
index 16dcb7d66..2ccbfe817 100644
@@ -65,7 +65,7 @@ system_data_types \- overview of system data types
 .I ptrdiff_t
 .IP
 Include:
-.I <stddef.h>.
+.IR <stddef.h> .
 .IP
 Used for a count of elements, and array indices.
 It is the result of subtracting two pointers.
@@ -85,7 +85,7 @@ types in this page.
 .I regoff_t
 .IP
 Include:
-.I <regex.h>.
+.IR <regex.h> .
 .IP
 According to POSIX, it shall be a signed integer type
 capable of storing the largest value that can be stored in either a
Signature · 3 lines
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
#3 lore raw

PATCH 2/3 system_data_types.7: Document regmatch_t

In reply to Alejandro Colomar
---
 man7/system_data_types.7 | 23 +++++++++++++++++++++--
 1 file changed, 21 insertions(+), 2 deletions(-)
man7/system_data_types.7 +21 -2
index 2ccbfe817..d3dee2747 100644
@@ -82,6 +82,25 @@ and
 .I ssize_t
 types in this page.
 .TP
+.I regmatch_t
+.IP
+Include:
+.IR <regex.h> .
+.IP
+.EX
+typedef struct {
+    regoff_t    rm_so; /* Byte offset from start of string
+                        * to start of substring */
+    regoff_t    rm_eo; /* Byte offset from start of string of the
+                        * first character after the end of substring */
+} regmatch_t;
+.EE
+.IP
+Conforming to: POSIX.1-2001 and later.
+.IP
+See also:
+.BR regexec (3)
+.TP
 .I regoff_t
 .IP
 Include:
@@ -104,8 +123,8 @@ type or a
 type.
 .IP
 See also the
-.\".I regmatch_t	FIXME
-.\"structure and the
+.I regmatch_t
+structure and the
 .I ptrdiff_t
 and
 .I ssize_t
Signature · 1 line
2.28.0
#4 lore raw

Re: [PATCH 2/3] system_data_types.7: Document regmatch_t

Quoted 3 lines · Alejandro Colomar
 man7/system_data_types.7 | 23 +++++++++++++++++++++--
 1 file changed, 21 insertions(+), 2 deletions(-)

Thanks, Alex. Patch applied.

Cheers,

Michael

Quoted 42 lines
man7/system_data_types.7 +21 -2
index 2ccbfe817..d3dee2747 100644
@@ -82,6 +82,25 @@ and
 .I ssize_t
 types in this page.
 .TP
+.I regmatch_t
+.IP
+Include:
+.IR <regex.h> .
+.IP
+.EX
+typedef struct {
+    regoff_t    rm_so; /* Byte offset from start of string
+                        * to start of substring */
+    regoff_t    rm_eo; /* Byte offset from start of string of the
+                        * first character after the end of substring */
+} regmatch_t;
+.EE
+.IP
+Conforming to: POSIX.1-2001 and later.
+.IP
+See also:
+.BR regexec (3)
+.TP
 .I regoff_t
 .IP
 Include:
@@ -104,8 +123,8 @@ type or a
 type.
 .IP
 See also the
-.\".I regmatch_t	FIXME
-.\"structure and the
+.I regmatch_t
+structure and the
 .I ptrdiff_t
 and
 .I ssize_t
Signature · 3 lines
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
#5 lore raw

PATCH 3/3 regmatch_t.3: New page for new documented type in system_data_types(7)

In reply to Alejandro Colomar
---
 man3/regmatch_t.3 | 1 +
 1 file changed, 1 insertion(+)
 create mode 100644 man3/regmatch_t.3
man3/regmatch_t.3 new file +1 -0
new file mode 100644
index 000000000..db50c0f09
@@ -0,0 +1 @@
+.so man7/system_data_types.7
Signature · 1 line
2.28.0
#6 lore raw

Re: [PATCH 3/3] regmatch_t.3: New page for new documented type in system_data_types(7)

Quoted 1 line · Alejandro Colomar

Thanks, Alex. Patch applied. But title should say "New link...", rather than "New page..." (I fixed it).

Cheers,

Michael

Quoted 13 lines
---
 man3/regmatch_t.3 | 1 +
 1 file changed, 1 insertion(+)
 create mode 100644 man3/regmatch_t.3
man3/regmatch_t.3 new file +1 -0
new file mode 100644
index 000000000..db50c0f09
@@ -0,0 +1 @@
+.so man7/system_data_types.7
Signature · 3 lines
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
#7 lore raw

Re: [PATCH 3/3] regmatch_t.3: New page for new documented type in system_data_types(7)

Quoted 17 lines · Michael Kerrisk (man-pages)
Quoted 1 line · Alejandro Colomar

Thanks, Alex. Patch applied. But title should say "New link...", rather than "New page..." (I fixed it).

Cheers,

Michael

Quoted 5 lines
---
  man3/regmatch_t.3 | 1 +
  1 file changed, 1 insertion(+)

create mode 100644 man3/regmatch_t.3

Quoted 10 lines

man3/regmatch_t.3 line 1

Quoted 8 lines
man3/regmatch_t.3 new file +1 -0
new file mode 100644
index 000000000..db50c0f09
@@ -0,0 +1 @@
+.so man7/system_data_types.7

Oops! Typo.

Thanks,

Alex