Debian Codegraph @

internal/NOTES

raw
1 The files in this directory are for primary use by me, the author
2 of Date::Manip to prepare a new release.
3
4 There is no reason for an end user to need to do this. However, it
5 is documented for the sake of completeness, and to remind me of the
6 steps I need to do.
7
8 It's also available in case someone ever chooses to fork the
9 module (though I hope that won't be necessary).
10
11 #########################################################################
12 Update the windows zones.
13
14 (cd internal; ./windows.compare)
15
16 Make the changes in data.alias.pl .
17
18 #########################################################################
19 Get the newest tzdata package.
20
21 The tzdata/tzcode archives are obtained from
22
23 ftp://ftp.iana.org/tz/
24
25 In order to create the appropriate Date::Manip modules, run the
26 following commands:
27
28 export CC='gcc -std=c99'
29 ./internal/tzdata -f : to download the packages
30 ./internal/tzdata -b : to build the package
31
32 Some timezones store information about time changes quite a ways in advance. We
33 need to make sure that we're storing enough information to get to a 'lastrule'.
34
35 Run the following:
36
37 cd tzdata
38 grep Rule africa antarctica asia australasia europe northamerica \
39 southamerica | \
40 awk '{print $3}' | sort -u | grep -E '^[1-9]' | sort -n | tail -1
41 cd ..
42
43 Make sure that the value for $keep_years (in internal/data.misc.pl) is greater
44 than (MAX_YEAR - CURR_YEAR) where MAX_YEAR is the output from the line above and
45 CURR_YEAR is the current year.
46
47 ./internal/tzdata -l : to get a list of all the zones that need modules
48 *** see NOTE 4 below ***
49 ./internal/tzdata -d : to dump all zones
50 ./internal/tzdata -m : to create the individual zone modules
51 *** see NOTE 2 below ***
52 ./internal/tzdata -o : to create the individual offset modules
53 *** see NOTE 3 below ***
54 ./internal/tzdata -z : to create the main Zone module
55 *** see NOTE 3 below ***
56
57 Run the following to double check every timezone in zoneinfo against the
58 Date::Manip version:
59
60 ./internal/dumps
61
62 Run the two tzdata tests:
63
64 (cd t; ./runtests tzdata)
65
66 Then clean up:
67
68 ./internal/tzdata -c
69
70
71 NOTE 1: although the tzdata script runs on my computer, it is quite possible
72 that it will not run on other systems due to differences in what tools are
73 available.
74
75 Since the tzdata script is designed only to create the modules which are
76 then distributed as part of Date::Manip, there is no reason for anyone other
77 than me to run the above commands. If you DO choose to run them, please do
78 not report problems due to differences in operating systems, or packages that
79 are installed on your system. If you discover a bug in tzdata, I am interested
80 in knowing about it however.
81
82 NOTE 2: If you get a LAST RULE in Jan/Dec line, check it out. A zone
83 is doing time changes in Jan or Dec. Make sure it won't cause any
84 problems. Provided it's not early in the day of Jan 1 or late in the day
85 of Dec 31, it'll be fine.
86
87 Currently, the following warn (but have been cleared as safe):
88 Pacific/Fiji
89
90 NOTE 3: These steps often require manual intervention described
91 below. After the intervention, rerun the command to make sure no
92 output is produced.
93
94 The old values of data are stored in the internal/data.* files. This is
95 so that I am explicitly notified of every change to the zoneinfo data
96 which could impact Date::Manip. Any output reflects potential changes
97 so every entry should be checked to ensure that it acceptable. Then,
98 the output needs to be added to the appropriate data.* file, replacing
99 any previous value for the entry. It is especially important that the entries
100 for 'important' values remain unchanged unless there is good reason
101 to change it.
102
103 If the '-o' option produces any output, the entries need to be verified and
104 added to the data.offset.pl file.
105
106 If the '-z' option produces any output, the entries need to be verified and
107 added to the data.alias.pl or data.abbrev.pl file.
108
109 After adding a new value, rerun the command to make sure there are no more
110 problems.
111
112 NOTE 4: If you see an error:
113 [do_list] unknown alias [ZONE: Alias]
114 removed the key/value pair in data.alias.pl
115
116 #########################################################################
117 Clean up stuff that shouldn't be in the manifest
118
119 In internal/benchmarks directory
120 rm -f nytprof.out parse-1.in
121 rm -rf nytprof
122
123 #########################################################################
124 Before every release, spellcheck the documents:
125
126 for i in `find lib -type f -name \*.pod | grep -E -v 'Lang/' |
127 grep -E -v Zones.pod` ;do
128 pod2text $i > $i.txt
129 ispell -p internal/module.isp $i.txt
130 rm -f $i.txt $i.txt.bak
131 done
132
133 internal/langpod
134
135 pod2text ./lib/Date/Manip/Lang/english.pod > english.txt
136 ispell -p internal/module.isp english.txt
137 rm -f english.txt english.txt.bak
138
139 #########################################################################
140 Update the copyright
141
142 y=`date '+%Y'`
143 for i in `find . -type f | grep -E -v '.git' | xargs grep -E -l "Copyright \(c\) ....-.... Sullivan Beck"` ;do
144 sed -e "s,\(Copyright (c) ....\)\-.... \(Sullivan Beck\),\1-$y \2," $i > z
145 mv z $i
146 done
147 chmod +x internal/tzdata internal/gen_dm5abbrevs examples/dm_* internal/langpod internal/windows.compare
148
149 #########################################################################
150 Switch the system timezone to America/Central and run the tests.
151
152 #########################################################################
153 Update the Changes5/Changes6 docs with the date.
154
155 ../support/pod_to_changes > Changes
156
157 #########################################################################
158 Install the module. Then run the following:
159
160 ./internal/gen_dm5abbrevs > lib/Date/Manip/DM5abbrevs.pm
161
162 #########################################################################
163 Make sure that the test suite covers everything
164
165 . ../0
166 cover -delete
167 cover -test
168 # make sure everything is 100%
169 cover -delete
170 make distclean
171
172 #########################################################################
173 Regenerate the MANIFEST and run the kwalitee tests
174
175 find . -name \*.swp
176
177 #########################################################################
178 Run the internal/leak.pl whenever a new version of perl is available to
179 see if the leak persists. When it's fixed, note this in the known problems
180 section.
181
182 A patch for this went in on Dec 13, 2011 when the following versions of
183 perl are active:
184 5.16.0 FIXED
185 5.15.6 FIXED
186 5.14.2 maint
187 5.12.4 maint
188 5.10.1 unmaint
189
190 so look for it to be corrected in newer versions than this (not sure if
191 it'll be applied to the maintenance versions).
192