Garbled text in zic(8) man page

Garbled text in zic(8) man page

[Jonathan Wakely]

Hi,

The description of the RULES field of a Zone line at:
https://man7.org/linux/man-pages/man8/zic.8.html#FILES
seems garbled:
"giving of the amount of time to be added to local standard time effect"

It looks like it might be a copy&paste error from the similar text for
the SAVE field of a Rule line. I think the first "of" and the "effect"
should be removed, but I'm not sure if that's correct.

Re: Garbled text in zic(8) man page

[Jonathan Wakely]

On Tue, 22 Nov 2022 at 12:58, Jonathan Wakely wrote:
>
> Hi,
>
> The description of the RULES field of a Zone line at:
> https://man7.org/linux/man-pages/man8/zic.8.html#FILES
> seems garbled:
> "giving of the amount of time to be added to local standard time effect"
>
> It looks like it might be a copy&paste error from the similar text for
> the SAVE field of a Rule line. I think the first "of" and the "effect"
> should be removed, but I'm not sure if that's correct.

This was introduced by
https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/commit/man8/zic.8?id=5355e20f816e1e0af93d6bb80439e86f2d1c7be7
so maybe it should be reported to tzdb upstream instead.

Re: Garbled text in zic(8) man page

[Jonathan Wakely]

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

On Tue, 22 Nov 2022 at 13:00, Jonathan Wakely wrote:
>
> On Tue, 22 Nov 2022 at 12:58, Jonathan Wakely wrote:
> >
> > Hi,
> >
> > The description of the RULES field of a Zone line at:
> > https://man7.org/linux/man-pages/man8/zic.8.html#FILES
> > seems garbled:
> > "giving of the amount of time to be added to local standard time effect"
> >
> > It looks like it might be a copy&paste error from the similar text for
> > the SAVE field of a Rule line. I think the first "of" and the "effect"
> > should be removed, but I'm not sure if that's correct.
>
> This was introduced by
> https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/commit/man8/zic.8?id=5355e20f816e1e0af93d6bb80439e86f2d1c7be7
> so maybe it should be reported to tzdb upstream instead.

It's already fixed upstream. The version in the tzdb-2022f package says:

       RULES The name of the rules that apply in the timezone or,
             alternatively, a field in the same format as a rule-line SAVE
             column, giving the amount of time to be added to local standard
             time and whether the resulting time is standard or daylight
             saving.  If this field is - then standard time always applies.
             When an amount of time is given, only the sum of standard time
             and this amount matters.

So here's a patch for the man page. There are lots of other changes in
the upstream page though, so another sync might be useful.

[-- Attachment #2: zic-8-man-page.txt --]
[-- Type: text/plain, Size: 979 bytes --]

commit 1c9a4d9bd240dfe2aaef396b5eb0788eeabf3791
Author: Jonathan Wakely <jwakely@redhat.com>
Date:   Tue Nov 22 13:10:55 2022 +0000

    zic.8: Fix garbled sentence
    
    This corrected text now matches the corresponding section of the
    upstream man page.
    
    Signed-off-by: Jonathan Wakely <jwakely@redhat.com>

diff --git a/man8/zic.8 b/man8/zic.8
index 79b06ae7c..d633ce7bb 100644
--- a/man8/zic.8
+++ b/man8/zic.8
@@ -502,8 +502,8 @@ begin the field with a minus sign if time must be subtracted from UT.
 .B RULES
 The name of the rules that apply in the timezone or,
 alternatively, a field in the same format as a rule-line SAVE column,
-giving of the amount of time to be added to local standard time
-effect, and whether the resulting time is standard or daylight saving.
+giving the amount of time to be added to local standard time
+and whether the resulting time is standard or daylight saving.
 If this field is
 .B \*-
 then standard time always applies.

Re: Garbled text in zic(8) man page

[Alejandro Colomar]

[-- Attachment #1.1: Type: text/plain, Size: 2407 bytes --]

Hi Jonathan,

On 11/22/22 14:13, Jonathan Wakely wrote:
> On Tue, 22 Nov 2022 at 13:00, Jonathan Wakely wrote:
>>
>> On Tue, 22 Nov 2022 at 12:58, Jonathan Wakely wrote:
>>>
>>> Hi,
>>>
>>> The description of the RULES field of a Zone line at:
>>> https://man7.org/linux/man-pages/man8/zic.8.html#FILES
>>> seems garbled:
>>> "giving of the amount of time to be added to local standard time effect"
>>>
>>> It looks like it might be a copy&paste error from the similar text for
>>> the SAVE field of a Rule line. I think the first "of" and the "effect"
>>> should be removed, but I'm not sure if that's correct.
>>
>> This was introduced by
>> https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/commit/man8/zic.8?id=5355e20f816e1e0af93d6bb80439e86f2d1c7be7
>> so maybe it should be reported to tzdb upstream instead.
> 
> It's already fixed upstream. The version in the tzdb-2022f package says:
> 
>         RULES The name of the rules that apply in the timezone or,
>               alternatively, a field in the same format as a rule-line SAVE
>               column, giving the amount of time to be added to local standard
>               time and whether the resulting time is standard or daylight
>               saving.  If this field is - then standard time always applies.
>               When an amount of time is given, only the sum of standard time
>               and this amount matters.
> 
> So here's a patch for the man page. There are lots of other changes in
> the upstream page though, so another sync might be useful.

As you said, a sync would be better.  However, I don't know how Michael did 
that.  If you know where the page comes from, could you please prepare a patch 
that does the sync, and document it in the commit message so that it's easier to 
do it in the future?

If you do that, please also sync tzfile(5) and zdump(8) in the commit.

Thanks,

Alex


---

$ cat MAINTAINER_NOTES
Externally generated pages
==========================

A few pages come from external sources. Fixes to the pages should really
go to the upstream source.

tzfile(5), zdump(8), and zic(8) come from the tz project
(https://www.iana.org/time-zones).

bpf-helpers(7) is autogenerated from the kernel sources using scripts.
See man-pages commits 53666f6c3 and 19c7f7839 for details.

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

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

Re: Garbled text in zic(8) man page

[Jonathan Wakely]

On Tue, 22 Nov 2022 at 19:22, Alejandro Colomar wrote:
>
> Hi Jonathan,
>
> On 11/22/22 14:13, Jonathan Wakely wrote:
> > On Tue, 22 Nov 2022 at 13:00, Jonathan Wakely wrote:
> >>
> >> On Tue, 22 Nov 2022 at 12:58, Jonathan Wakely wrote:
> >>>
> >>> Hi,
> >>>
> >>> The description of the RULES field of a Zone line at:
> >>> https://man7.org/linux/man-pages/man8/zic.8.html#FILES
> >>> seems garbled:
> >>> "giving of the amount of time to be added to local standard time effect"
> >>>
> >>> It looks like it might be a copy&paste error from the similar text for
> >>> the SAVE field of a Rule line. I think the first "of" and the "effect"
> >>> should be removed, but I'm not sure if that's correct.
> >>
> >> This was introduced by
> >> https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/commit/man8/zic.8?id=5355e20f816e1e0af93d6bb80439e86f2d1c7be7
> >> so maybe it should be reported to tzdb upstream instead.
> >
> > It's already fixed upstream. The version in the tzdb-2022f package says:
> >
> >         RULES The name of the rules that apply in the timezone or,
> >               alternatively, a field in the same format as a rule-line SAVE
> >               column, giving the amount of time to be added to local standard
> >               time and whether the resulting time is standard or daylight
> >               saving.  If this field is - then standard time always applies.
> >               When an amount of time is given, only the sum of standard time
> >               and this amount matters.
> >
> > So here's a patch for the man page. There are lots of other changes in
> > the upstream page though, so another sync might be useful.
>
> As you said, a sync would be better.  However, I don't know how Michael did
> that.

Paul Eggert did it last time.

> If you know where the page comes from, could you please prepare a patch
> that does the sync, and document it in the commit message so that it's easier to
> do it in the future?

Upstream is https://www.iana.org/time-zones


>
> If you do that, please also sync tzfile(5) and zdump(8) in the commit.
>
> Thanks,
>
> Alex
>
>
> ---
>
> $ cat MAINTAINER_NOTES
> Externally generated pages
> ==========================
>
> A few pages come from external sources. Fixes to the pages should really
> go to the upstream source.
>
> tzfile(5), zdump(8), and zic(8) come from the tz project
> (https://www.iana.org/time-zones).
>
> bpf-helpers(7) is autogenerated from the kernel sources using scripts.
> See man-pages commits 53666f6c3 and 19c7f7839 for details.
>
> --
> <http://www.alejandro-colomar.es/>

Re: Garbled text in zic(8) man page

[Alejandro Colomar]

[-- Attachment #1.1: Type: text/plain, Size: 3177 bytes --]

Hi Jonathan, Paul,

On 11/22/22 21:31, Jonathan Wakely wrote:
> On Tue, 22 Nov 2022 at 19:22, Alejandro Colomar wrote:
>>
>> Hi Jonathan,
>>
>> On 11/22/22 14:13, Jonathan Wakely wrote:
>>> On Tue, 22 Nov 2022 at 13:00, Jonathan Wakely wrote:
>>>>
>>>> On Tue, 22 Nov 2022 at 12:58, Jonathan Wakely wrote:
>>>>>
>>>>> Hi,
>>>>>
>>>>> The description of the RULES field of a Zone line at:
>>>>> https://man7.org/linux/man-pages/man8/zic.8.html#FILES
>>>>> seems garbled:
>>>>> "giving of the amount of time to be added to local standard time effect"
>>>>>
>>>>> It looks like it might be a copy&paste error from the similar text for
>>>>> the SAVE field of a Rule line. I think the first "of" and the "effect"
>>>>> should be removed, but I'm not sure if that's correct.
>>>>
>>>> This was introduced by
>>>> https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/commit/man8/zic.8?id=5355e20f816e1e0af93d6bb80439e86f2d1c7be7
>>>> so maybe it should be reported to tzdb upstream instead.
>>>
>>> It's already fixed upstream. The version in the tzdb-2022f package says:
>>>
>>>          RULES The name of the rules that apply in the timezone or,
>>>                alternatively, a field in the same format as a rule-line SAVE
>>>                column, giving the amount of time to be added to local standard
>>>                time and whether the resulting time is standard or daylight
>>>                saving.  If this field is - then standard time always applies.
>>>                When an amount of time is given, only the sum of standard time
>>>                and this amount matters.
>>>
>>> So here's a patch for the man page. There are lots of other changes in
>>> the upstream page though, so another sync might be useful.
>>
>> As you said, a sync would be better.  However, I don't know how Michael did
>> that.
> 
> Paul Eggert did it last time.

Thanks!

> 
>> If you know where the page comes from, could you please prepare a patch
>> that does the sync, and document it in the commit message so that it's easier to
>> do it in the future?
> 
> Upstream is https://www.iana.org/time-zones

Ahh, I remember last time I wanted to check the source code I desisted because 
there's no git repository, and I didn't want to be messing with tarballs.  But 
getting the pages from the tarball seems easy, so I'll do that.

Paul, do you have a public git (or whatever) repository that I can check out?

Thanks,

Alex

> 
> 
>>
>> If you do that, please also sync tzfile(5) and zdump(8) in the commit.
>>
>> Thanks,
>>
>> Alex
>>
>>
>> ---
>>
>> $ cat MAINTAINER_NOTES
>> Externally generated pages
>> ==========================
>>
>> A few pages come from external sources. Fixes to the pages should really
>> go to the upstream source.
>>
>> tzfile(5), zdump(8), and zic(8) come from the tz project
>> (https://www.iana.org/time-zones).
>>
>> bpf-helpers(7) is autogenerated from the kernel sources using scripts.
>> See man-pages commits 53666f6c3 and 19c7f7839 for details.
>>
>> --
>> <http://www.alejandro-colomar.es/>
> 

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

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

Re: Garbled text in zic(8) man page

[Jonathan Wakely]

On Tue, 22 Nov 2022 at 20:37, Alejandro Colomar <alx.manpages@gmail.com> wrote:
>
> Hi Jonathan, Paul,
>
> On 11/22/22 21:31, Jonathan Wakely wrote:
> > On Tue, 22 Nov 2022 at 19:22, Alejandro Colomar wrote:
> >>
> >> Hi Jonathan,
> >>
> >> On 11/22/22 14:13, Jonathan Wakely wrote:
> >>> On Tue, 22 Nov 2022 at 13:00, Jonathan Wakely wrote:
> >>>>
> >>>> On Tue, 22 Nov 2022 at 12:58, Jonathan Wakely wrote:
> >>>>>
> >>>>> Hi,
> >>>>>
> >>>>> The description of the RULES field of a Zone line at:
> >>>>> https://man7.org/linux/man-pages/man8/zic.8.html#FILES
> >>>>> seems garbled:
> >>>>> "giving of the amount of time to be added to local standard time effect"
> >>>>>
> >>>>> It looks like it might be a copy&paste error from the similar text for
> >>>>> the SAVE field of a Rule line. I think the first "of" and the "effect"
> >>>>> should be removed, but I'm not sure if that's correct.
> >>>>
> >>>> This was introduced by
> >>>> https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/commit/man8/zic.8?id=5355e20f816e1e0af93d6bb80439e86f2d1c7be7
> >>>> so maybe it should be reported to tzdb upstream instead.
> >>>
> >>> It's already fixed upstream. The version in the tzdb-2022f package says:
> >>>
> >>>          RULES The name of the rules that apply in the timezone or,
> >>>                alternatively, a field in the same format as a rule-line SAVE
> >>>                column, giving the amount of time to be added to local standard
> >>>                time and whether the resulting time is standard or daylight
> >>>                saving.  If this field is - then standard time always applies.
> >>>                When an amount of time is given, only the sum of standard time
> >>>                and this amount matters.
> >>>
> >>> So here's a patch for the man page. There are lots of other changes in
> >>> the upstream page though, so another sync might be useful.
> >>
> >> As you said, a sync would be better.  However, I don't know how Michael did
> >> that.
> >
> > Paul Eggert did it last time.
>
> Thanks!
>
> >
> >> If you know where the page comes from, could you please prepare a patch
> >> that does the sync, and document it in the commit message so that it's easier to
> >> do it in the future?
> >
> > Upstream is https://www.iana.org/time-zones
>
> Ahh, I remember last time I wanted to check the source code I desisted because
> there's no git repository, and I didn't want to be messing with tarballs.  But
> getting the pages from the tarball seems easy, so I'll do that.
>
> Paul, do you have a public git (or whatever) repository that I can check out?


It looks like there are a few local changes such as replacing
"degrees" with the degrees symbol, which should probably be preserved
rather than overwritten by a sync. So it's not just as simple as
overwriting with the upstream copy. I can try to look into it, but it
won't be very soon.

Re: Garbled text in zic(8) man page

[Alejandro Colomar]

[-- Attachment #1.1: Type: text/plain, Size: 1007 bytes --]

Hi Jonathan, Paul,

On 11/22/22 21:39, Jonathan Wakely wrote:
>>> Upstream is https://www.iana.org/time-zones
>>
>> Ahh, I remember last time I wanted to check the source code I desisted because
>> there's no git repository, and I didn't want to be messing with tarballs.  But
>> getting the pages from the tarball seems easy, so I'll do that.
>>
>> Paul, do you have a public git (or whatever) repository that I can check out?
> 
> 
> It looks like there are a few local changes such as replacing
> "degrees" with the degrees symbol, which should probably be preserved
> rather than overwritten by a sync. So it's not just as simple as
> overwriting with the upstream copy. I can try to look into it, but it
> won't be very soon.

Yes, that's why I wanted to get the upstream git repo the other time.  Paul, I 
have a few fixes for the upstream pages that I'm interested in sending you.  A 
git repo would be nice :)

Cheers,

Alex

> 

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

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

Re: Garbled text in zic(8) man page

[Jakub Wilk]

* Alejandro Colomar <alx.manpages@gmail.com>, 2022-11-22 21:37:
>>Upstream is https://www.iana.org/time-zones
>
>Ahh, I remember last time I wanted to check the source code I desisted 
>because there's no git repository, and I didn't want to be messing with 
>tarballs.  But getting the pages from the tarball seems easy, so I'll 
>do that.
>
>Paul, do you have a public git (or whatever) repository that I can 
>check out?

The home page points to <https://data.iana.org/time-zones/tz-link.html>, 
which says:

     git clone https://github.com/eggert/tz

-- 
Jakub Wilk

Re: Garbled text in zic(8) man page

[Alejandro Colomar]

[-- Attachment #1.1: Type: text/plain, Size: 744 bytes --]

Hi Jakub,

On 11/22/22 22:00, Jakub Wilk wrote:
> * Alejandro Colomar <alx.manpages@gmail.com>, 2022-11-22 21:37:
>>> Upstream is https://www.iana.org/time-zones
>>
>> Ahh, I remember last time I wanted to check the source code I desisted because 
>> there's no git repository, and I didn't want to be messing with tarballs.  But 
>> getting the pages from the tarball seems easy, so I'll do that.
>>
>> Paul, do you have a public git (or whatever) repository that I can check out?
> 
> The home page points to <https://data.iana.org/time-zones/tz-link.html>, which 
> says:
> 
>      git clone https://github.com/eggert/tz

Thanks!

I sent a few patches.

Cheers,

Alex


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

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