[PATCH 0/3] Document regmatch_t (and a ffix)

[PATCH 0/3] Document regmatch_t (and a ffix)

[Alejandro Colomar]

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

-- 
2.28.0

[PATCH 1/3] system_data_types.7: ffix

[Alejandro Colomar]

Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
 man7/system_data_types.7 | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
index 16dcb7d66..2ccbfe817 100644
--- a/man7/system_data_types.7
+++ b/man7/system_data_types.7
@@ -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
-- 
2.28.0

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

[Michael Kerrisk (man-pages)]

On 9/18/20 3:29 PM, Alejandro Colomar wrote:
> Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>

Thanks, Alex. Patch applied.

Cheers,

Michael


> ---
>  man7/system_data_types.7 | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
> index 16dcb7d66..2ccbfe817 100644
> --- a/man7/system_data_types.7
> +++ b/man7/system_data_types.7
> @@ -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
> 


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/

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

[Alejandro Colomar]

Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
 man7/system_data_types.7 | 23 +++++++++++++++++++++--
 1 file changed, 21 insertions(+), 2 deletions(-)

diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
index 2ccbfe817..d3dee2747 100644
--- a/man7/system_data_types.7
+++ b/man7/system_data_types.7
@@ -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
-- 
2.28.0

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

[Michael Kerrisk (man-pages)]

On 9/18/20 3:29 PM, Alejandro Colomar wrote:
> Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com> ---
>  man7/system_data_types.7 | 23 +++++++++++++++++++++--
>  1 file changed, 21 insertions(+), 2 deletions(-)


Thanks, Alex. Patch applied.

Cheers,

Michael


> diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
> index 2ccbfe817..d3dee2747 100644
> --- a/man7/system_data_types.7
> +++ b/man7/system_data_types.7
> @@ -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
> 


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/

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

[Alejandro Colomar]

Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
 man3/regmatch_t.3 | 1 +
 1 file changed, 1 insertion(+)
 create mode 100644 man3/regmatch_t.3

diff --git a/man3/regmatch_t.3 b/man3/regmatch_t.3
new file mode 100644
index 000000000..db50c0f09
--- /dev/null
+++ b/man3/regmatch_t.3
@@ -0,0 +1 @@
+.so man7/system_data_types.7
-- 
2.28.0

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

[Michael Kerrisk (man-pages)]

On 9/18/20 3:29 PM, Alejandro Colomar wrote:
> Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>


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

Cheers,

Michael


> ---
>  man3/regmatch_t.3 | 1 +
>  1 file changed, 1 insertion(+)
>  create mode 100644 man3/regmatch_t.3
> 
> diff --git a/man3/regmatch_t.3 b/man3/regmatch_t.3
> new file mode 100644
> index 000000000..db50c0f09
> --- /dev/null
> +++ b/man3/regmatch_t.3
> @@ -0,0 +1 @@
> +.so man7/system_data_types.7
> 


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/

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

[Alejandro Colomar]

On 2020-09-18 22:45, Michael Kerrisk (man-pages) wrote:
> On 9/18/20 3:29 PM, Alejandro Colomar wrote:
>> Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
> 
> 
> Thanks, Alex. Patch applied. But title should say "New link...",
> rather than "New page..." (I fixed it).
> 
> Cheers,
> 
> Michael
> 
> 
>> ---
>>   man3/regmatch_t.3 | 1 +
>>   1 file changed, 1 insertion(+)
>>   create mode 100644 man3/regmatch_t.3
>>
>> diff --git a/man3/regmatch_t.3 b/man3/regmatch_t.3
>> new file mode 100644
>> index 000000000..db50c0f09
>> --- /dev/null
>> +++ b/man3/regmatch_t.3
>> @@ -0,0 +1 @@
>> +.so man7/system_data_types.7
>>
> 
> 


Oops! Typo.

Thanks,

Alex