Re: [PATCH v3 1/2] tm.3type: describe tm_zone, tm_gmtoff

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi!

On Tue, Jul 19, 2022 at 10:33:34PM +0200, Alejandro Colomar wrote:
> On 7/19/22 20:38, наб wrote:
> > diff --git a/man3/tm.3type b/man3/tm.3type
> > index 78e05a41a..c23fc023e 100644
> > --- a/man3/tm.3type
> > +++ b/man3/tm.3type
> > @@ -25,8 +25,26 @@ Standard C library
> >   .BR "    int         tm_yday;" \
> >   "   /* Day of the year  [" 0 ", " 365 "] (Jan/01 = " 0 ") */"
> >   .BR "    int         tm_isdst;" "  /* Daylight savings flag */"
> > +
> 
> Use .PP.  See man-pages(7):
>    Formatting conventions (general)
>        Paragraphs should be separated by suitable markers  (usu‐
>        ally  either .PP or .IP).  Do not separate paragraphs us‐
>        ing blank lines, as this results  in  poor  rendering  in
>        some output formats (such as PostScript and PDF).

Too used to mdoc(7) in .Bd -literal mode where an empty line is correct
for these. Fixed for v4.

> > @@ -35,6 +53,16 @@ describes wether daylight saving time is in effect at the time described.
> >   The value is positive if daylight saving time is in effect,
> >   zero if it is not,
> >   and negative if the information is not available.
> > +.PP
> > +.I tm_gmtoff
> > +is the difference, in seconds, of the timezone represented by this broken-down time and UTC
> 
> Heh, as the old kernel coding style used to read,
> "The limit on the length of lines is 80 columns and this is a strongly
> preferred limit."
> 
> Rationale: I can keep the font size quite big, and still have 2 terminals in
> a FullHD screen side by side, with line numbers.
> 
> I can still see around 87 characters (a little more than 80),
> but that line is too much for me.  If eighty-few characters really improve
> readability, I can accept that, especially for SYNOPSIS, but in running
> text, 80-char is more of a strong limit.

Sure. Cracked before of for v4.

> > +.PP
> > +.BR timezone (3),
> > +as a variable, is an XSI extension: some systems provide the V7-compatible
> > +.\" FreeBSD
> > +.BR timezone ()
> 
> I've been thinking about if we should put there a section number.
> I think we should.  Actually, timezone(3) documents the function in NOTES.

Disagree: timezone() is /not/ timezone(3).

Our (and XSI) timezone(3) is
  extern long timezone;
whereas the V7-compatible timezone() is
  extern char *timezone(int zone, int dst);
cf. https://www.freebsd.org/cgi/man.cgi?query=timezone&apropos=0&sektion=0&manpath=FreeBSD+13.1-RELEASE+and+Ports&arch=default&format=html

That's why I Xred the first usage (which refers to the variable we
document) and not the second (which refers to a function we don't).

Thoughts?

Best,
наб

Attachment: signature.asc
Description: PGP signature


[Index of Archives]     [Kernel Documentation]     [Netdev]     [Linux Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux