Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

localtime docs #7779

Closed
p5pRT opened this issue Jan 31, 2005 · 6 comments
Closed

localtime docs #7779

p5pRT opened this issue Jan 31, 2005 · 6 comments

Comments

@p5pRT
Copy link

p5pRT commented Jan 31, 2005

Migrated from rt.perl.org#34010 (status was 'resolved')

Searchable as RT34010$

@p5pRT
Copy link
Author

p5pRT commented Jan 31, 2005

From rirans@comcast.net

Created by rirans@comcast.net

The localtime documentation is misleading. The header
should indicate both prototypes.

That is the header is​:

  localtime EXPR

but should be​:

  localtime EXPR
  localtime

Thanks,
Be well,
rir

Perl Info

Flags:
    category=docs
    severity=low

Site configuration information for perl v5.8.4:

Configured by Debian Project at Sun Sep 26 12:11:30 CEST 2004.

Summary of my perl5 (revision 5 version 8 subversion 4) configuration:
  Platform:
    osname=linux, osvers=2.6.8-1-686, archname=i386-linux-thread-multi
    uname='linux cachaca 2.6.8-1-686 #1 sat aug 28 14:11:39 edt 2004 i686 gnulinux '
    config_args='-Dusethreads -Duselargefiles -Dccflags=-DDEBIAN -Dcccdlflags=-fPIC -Darchname=i386-linux -Dprefix=/usr -Dprivlib=/usr/share/perl/5.8 -Darchlib=/usr/lib/perl/5.8 -Dvendorprefix=/usr -Dvendorlib=/usr/share/perl5 -Dvendorarch=/usr/lib/perl5 -Dsiteprefix=/usr/local -Dsitelib=/usr/local/share/perl/5.8.4 -Dsitearch=/usr/local/lib/perl/5.8.4 -Dman1dir=/usr/share/man/man1 -Dman3dir=/usr/share/man/man3 -Dsiteman1dir=/usr/local/man/man1 -Dsiteman3dir=/usr/local/man/man3 -Dman1ext=1 -Dman3ext=3perl -Dpager=/usr/bin/sensible-pager -Uafs -Ud_csh -Uusesfio -Uusenm -Duseshrplib -Dlibperl=libperl.so.5.8.4 -Dd_dosuid -des'
    hint=recommended, useposix=true, d_sigaction=define
    usethreads=define use5005threads=undef useithreads=define usemultiplicity=define
    useperlio=define d_sfio=undef uselargefiles=define usesocks=undef
    use64bitint=undef use64bitall=undef uselongdouble=undef
    usemymalloc=n, bincompat5005=undef
  Compiler:
    cc='cc', ccflags ='-D_REENTRANT -D_GNU_SOURCE -DTHREADS_HAVE_PIDS -DDEBIAN -fno-strict-aliasing -I/usr/local/include -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64',
    optimize='-O2',
    cppflags='-D_REENTRANT -D_GNU_SOURCE -DTHREADS_HAVE_PIDS -DDEBIAN -fno-strict-aliasing -I/usr/local/include'
    ccversion='', gccversion='3.3.4 (Debian 1:3.3.4-12)', gccosandvers=''
    intsize=4, longsize=4, ptrsize=4, doublesize=8, byteorder=1234
    d_longlong=define, longlongsize=8, d_longdbl=define, longdblsize=12
    ivtype='long', ivsize=4, nvtype='double', nvsize=8, Off_t='off_t', lseeksize=8
    alignbytes=4, prototype=define
  Linker and Libraries:
    ld='cc', ldflags =' -L/usr/local/lib'
    libpth=/usr/local/lib /lib /usr/lib
    libs=-lgdbm -lgdbm_compat -ldb -ldl -lm -lpthread -lc -lcrypt
    perllibs=-ldl -lm -lpthread -lc -lcrypt
    libc=/lib/libc-2.3.2.so, so=so, useshrplib=true, libperl=libperl.so.5.8.4
    gnulibc_version='2.3.2'
  Dynamic Linking:
    dlsrc=dl_dlopen.xs, dlext=so, d_dlsymun=undef, ccdlflags='-Wl,-E'
    cccdlflags='-fPIC', lddlflags='-shared -L/usr/local/lib'

Locally applied patches:
    


@INC for perl v5.8.4:
    .
    /home/rir/Rbks/Lib/
    /home/rir/Rbks/Lib/Tk
    /home/rir/Rbks/Lib/Auto
    /home/rir/lib
    /etc/perl
    /usr/local/lib/perl/5.8.4
    /usr/local/share/perl/5.8.4
    /usr/lib/perl5
    /usr/share/perl5
    /usr/lib/perl/5.8
    /usr/share/perl/5.8
    /usr/local/lib/site_perl
    .


Environment for perl v5.8.4:
    HOME=/home/rir
    LANG (unset)
    LANGUAGE (unset)
    LD_LIBRARY_PATH (unset)
    LOGDIR (unset)
    PATH=/home/rir/Bin:/usr/local/bin:/usr/bin:/bin:/usr/bin/X11:/usr/games:/home/sather/bin
    PERL5LIB=.:/home/rir/Rbks/Lib/:/home/rir/Rbks/Lib/Tk:/home/rir/Rbks/Lib/Auto:/home/rir/lib
    PERL_BADLANG (unset)
    SHELL=/bin/bash

@p5pRT
Copy link
Author

p5pRT commented Feb 1, 2005

From @petdance

On Mon, Jan 31, 2005 at 10​:21​:29PM -0000, rirans @​ comcast. net (perlbug-followup@​perl.org) wrote​:

The localtime documentation is misleading. The header
should indicate both prototypes.

Fixed, plus some other cleanup on the text to make it easier for the
reader to pick out the field meanings.

xoxo,
Andy

--
Andy Lester => andy@​petdance.com => www.petdance.com => AIM​:petdance

@p5pRT
Copy link
Author

p5pRT commented Feb 1, 2005

From @petdance

perlfunc.patch
--- pod/perlfunc.pod	2004-12-10 16:30:06.000000000 -0600
+++ perlfunc.pod	2005-01-31 21:11:39.208826147 -0600
@@ -2519,36 +2519,44 @@
 
 =item localtime EXPR
 
+=item localtime
+
 Converts a time as returned by the time function to a 9-element list
 with the time analyzed for the local time zone.  Typically used as
 follows:
 
     #  0    1    2     3     4    5     6     7     8
     ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) =
-						localtime(time);
+                                                localtime(time);
 
 All list elements are numeric, and come straight out of the C `struct
-tm'.  $sec, $min, and $hour are the seconds, minutes, and hours of the
-specified time.  $mday is the day of the month, and $mon is the month
-itself, in the range C<0..11> with 0 indicating January and 11
-indicating December.  $year is the number of years since 1900.  That
-is, $year is C<123> in year 2023.  $wday is the day of the week, with
-0 indicating Sunday and 3 indicating Wednesday.  $yday is the day of
-the year, in the range C<0..364> (or C<0..365> in leap years.)  $isdst
-is true if the specified time occurs during daylight savings time,
-false otherwise.
-
-Note that the $year element is I<not> simply the last two digits of
-the year.  If you assume it is, then you create non-Y2K-compliant
-programs--and you wouldn't want to do that, would you?
+tm'.  C<$sec>, C<$min>, and C<$hour> are the seconds, minutes, and hours
+of the specified time.
+
+C<$mday> is the day of the month, and C<$mon> is the month itself, in
+the range C<0..11> with 0 indicating January and 11 indicating December.
+This makes it easy to get a month name from a list:
+
+    my @abbr = qw( Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec );
+    print "$abbr[$mon] $mday";
+    # $mon=9, $mday=18 gives "Oct 18"
+
+C<$year> is the number of years since 1900, not just the last two digits
+of the year.  That is, C<$year> is C<123> in year 2023.  The proper way
+to get a complete 4-digit year is simply:
+
+    $year += 1900;
 
-The proper way to get a complete 4-digit year is simply:
+To get the last two digits of the year (e.g., '01' in 2001) do:
 
-	$year += 1900;
+    $year = sprintf("%02d", $year % 100);
 
-And to get the last two digits of the year (e.g., '01' in 2001) do:
+C<$wday> is the day of the week, with 0 indicating Sunday and 3 indicating
+Wednesday.  C<$yday> is the day of the year, in the range C<0..364>
+(or C<0..365> in leap years.)
 
-	$year = sprintf("%02d", $year % 100);
+C<$isdst> is true if the specified time occurs during Daylight Saving
+Time, false otherwise.
 
 If EXPR is omitted, C<localtime()> uses the current time (C<localtime(time)>).
 

@p5pRT
Copy link
Author

p5pRT commented Feb 1, 2005

The RT System itself - Status changed from 'new' to 'open'

@p5pRT
Copy link
Author

p5pRT commented Feb 1, 2005

From @rgs

Andy Lester wrote​:

On Mon, Jan 31, 2005 at 10​:21​:29PM -0000, rirans @​ comcast. net (perlbug-followup@​perl.org) wrote​:

The localtime documentation is misleading. The header
should indicate both prototypes.

Fixed, plus some other cleanup on the text to make it easier for the
reader to pick out the field meanings.

Thanks, applied as #23916 to BleadPerl.

@p5pRT p5pRT closed this as completed Feb 1, 2005
@p5pRT
Copy link
Author

p5pRT commented Feb 1, 2005

@rgs - Status changed from 'open' to 'resolved'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant