Issue in man page tzfile.5

Issue in man page tzfile.5

[Helge Kreutzmann]

Without further ado, the following was found:

Issue:    timezone → B<timezone>(3)

"It seems that timezone uses B<tzfile> internally, but glibc refuses to "
"expose it to userspace.  This is most likely because the standardised "
"functions are more useful and portable, and actually documented by glibc.  "
"It may only be in glibc just to support the non-glibc-maintained timezone "
"data (which is maintained by some other entity)."

Re: Issue in man page tzfile.5

[Alejandro Colomar]

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

Hi Helge,

On Sun, Nov 17, 2024 at 10:46:25AM GMT, Helge Kreutzmann wrote:
> Without further ado, the following was found:
> 
> Issue:    timezone → B<timezone>(3)
> 
> "It seems that timezone uses B<tzfile> internally, but glibc refuses to "
> "expose it to userspace.  This is most likely because the standardised "
> "functions are more useful and portable, and actually documented by glibc.  "
> "It may only be in glibc just to support the non-glibc-maintained timezone "
> "data (which is maintained by some other entity)."

You're right, but this is a Debian patch.  I've CCed Tobias.
I suggest transforming

	+It seems that timezone uses

into

	+It seems that
	+.BR timezone (1)
	+uses

Reported-by: Helge Kreutzmann <debian@helgefjell.de>
Reported-by: Alejandro Colomar <alx@kernel.org>
Suggested-by: Alejandro Colomar <alx@kernel.org>

Cheers,
Alex



alx@debian:~/src/debian/doc/manpages/debian/latest/debian/patches$ cat ./0010-tzfile.5.patch
From: "Dr. Tobias Quathamer" <toddy@debian.org>
Date: Sat, 6 Feb 2016 01:25:30 +0100
Subject: tzfile.5

---
 man/man5/tzfile.5 | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/man/man5/tzfile.5 b/man/man5/tzfile.5
index 4aa3f6c..d0cefa9 100644
--- a/man/man5/tzfile.5
+++ b/man/man5/tzfile.5
@@ -210,6 +210,22 @@ if either
 .B tzh_timecnt
 is zero or the time argument is less than the first transition time recorded
 in the file.
+.\" http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=122906#47
+.\" Reviewed by upstream and rejected, May 2012
+.SH NOTES
+This manual page documents
+.I <tzfile.h>
+in the glibc source archive, see
+.IR timezone/tzfile.h .
+.PP
+It seems that timezone uses
+.B tzfile
+internally, but glibc refuses to expose it to userspace.  This is most
+likely because the standardised functions are more useful and
+portable, and actually documented by glibc.  It may only be in glibc
+just to support the non-glibc-maintained timezone data (which is
+maintained by some other entity).
+.\" End of patch
 .SS Version 2 format
 For version-2-format timezone files,
 the above header and data are followed by a second header and data,


-- 
<https://www.alejandro-colomar.es/>

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

Re: Issue in man page tzfile.5

[Alejandro Colomar]

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

On Sun, Nov 17, 2024 at 03:55:26PM GMT, Alejandro Colomar wrote:
> Hi Helge,
> 
> On Sun, Nov 17, 2024 at 10:46:25AM GMT, Helge Kreutzmann wrote:
> > Without further ado, the following was found:
> > 
> > Issue:    timezone → B<timezone>(3)
> > 
> > "It seems that timezone uses B<tzfile> internally, but glibc refuses to "
> > "expose it to userspace.  This is most likely because the standardised "
> > "functions are more useful and portable, and actually documented by glibc.  "
> > "It may only be in glibc just to support the non-glibc-maintained timezone "
> > "data (which is maintained by some other entity)."
> 
> You're right, but this is a Debian patch.  I've CCed Tobias.
> I suggest transforming
> 
> 	+It seems that timezone uses
> 
> into
> 
> 	+It seems that
> 	+.BR timezone (1)

d'oh!  s/1/3/

> 	+uses
> 
> Reported-by: Helge Kreutzmann <debian@helgefjell.de>
> Reported-by: Alejandro Colomar <alx@kernel.org>
> Suggested-by: Alejandro Colomar <alx@kernel.org>
> 
> Cheers,
> Alex
> 
> 
> 
> alx@debian:~/src/debian/doc/manpages/debian/latest/debian/patches$ cat ./0010-tzfile.5.patch
> From: "Dr. Tobias Quathamer" <toddy@debian.org>
> Date: Sat, 6 Feb 2016 01:25:30 +0100
> Subject: tzfile.5
> 
> ---
>  man/man5/tzfile.5 | 16 ++++++++++++++++
>  1 file changed, 16 insertions(+)
> 
> diff --git a/man/man5/tzfile.5 b/man/man5/tzfile.5
> index 4aa3f6c..d0cefa9 100644
> --- a/man/man5/tzfile.5
> +++ b/man/man5/tzfile.5
> @@ -210,6 +210,22 @@ if either
>  .B tzh_timecnt
>  is zero or the time argument is less than the first transition time recorded
>  in the file.
> +.\" http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=122906#47
> +.\" Reviewed by upstream and rejected, May 2012
> +.SH NOTES
> +This manual page documents
> +.I <tzfile.h>
> +in the glibc source archive, see
> +.IR timezone/tzfile.h .
> +.PP
> +It seems that timezone uses
> +.B tzfile
> +internally, but glibc refuses to expose it to userspace.  This is most
> +likely because the standardised functions are more useful and
> +portable, and actually documented by glibc.  It may only be in glibc
> +just to support the non-glibc-maintained timezone data (which is
> +maintained by some other entity).
> +.\" End of patch
>  .SS Version 2 format
>  For version-2-format timezone files,
>  the above header and data are followed by a second header and data,
> 
> 
> -- 
> <https://www.alejandro-colomar.es/>



-- 
<https://www.alejandro-colomar.es/>

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

Re: Issue in man page tzfile.5

[Dr. Tobias Quathamer]

Am 17.11.24 um 15:56 schrieb Alejandro Colomar:
>> You're right, but this is a Debian patch.  I've CCed Tobias.
>> I suggest transforming
>>
>> 	+It seems that timezone uses
>>
>> into
>>
>> 	+It seems that
>> 	+.BR timezone (1)
> 
> d'oh!  s/1/3/

Fixed, thanks!

Regards,
Tobias