From 6879c0eb135c19307254047cc6d793f9434e3aea Mon Sep 17 00:00:00 2001
From: Paul Eggert
Date: Wed, 9 Nov 2016 15:17:04 -0800
Subject: [PROPOSED] Document the 'version' file
* README: Simplify and defer to tz-link.htm for details.
* Theory (Interface stability), tz-link.htm: Mention 'version'.
---
README | 25 +++----------------------
Theory | 3 +++
tz-link.htm | 9 ++++++---
3 files changed, 12 insertions(+), 25 deletions(-)
diff --git a/README b/README
index 8a09aa2..471fdf9 100644
--- a/README
+++ b/README
@@ -10,24 +10,9 @@ locations around the globe. It is updated periodically to reflect
changes made by political bodies to time zone boundaries, UTC offsets,
and daylight-saving rules.
-Here is a recipe for acquiring, building, installing, and testing the
-tz distribution on a GNU/Linux or similar host.
-
-To acquire the distribution, run the following shell commands:
-
- mkdir tz
- cd tz
- wget --retr-symlinks 'ftp://ftp.iana.org/tz/tz*-latest.tar.gz'
- gzip -dc tzcode-latest.tar.gz | tar -xf -
- gzip -dc tzdata-latest.tar.gz | tar -xf -
-
-Alternatively, the following shell commands acquire the same
-distribution, with extra data useful for regression testing:
-
- wget --retr-symlinks 'ftp://ftp.iana.org/tz/tzdb-latest.tar.lz'
- lzip -dc tzdb-latest.tar.lz | tar -xf -
-
-Be sure to read the comments in "Makefile" and make any changes needed
+See or the
+file tz-link.htm for how to acquire the code and data. Once acquired,
+read the comments in the file 'Makefile' and make any changes needed
to make things right for your system, especially if you are using some
platform other than GNU/Linux. Then run the following commands,
substituting your desired installation directory for "$HOME/tzdir":
@@ -60,10 +45,6 @@ Thanks in particular to Arthur David Olson, the project's founder and first
maintainer, to whom the time zone community owes the greatest debt of all.
None of them are responsible for remaining errors.
-Look in for updated versions of these files.
-
-Please send comments or information to tz@iana.org.
-
-----
This file is in the public domain, so clarified as of 2009-05-17 by
diff --git a/Theory b/Theory
index 07e449b..cc674e2 100644
--- a/Theory
+++ b/Theory
@@ -602,6 +602,9 @@ The tz code and data supply the following interfaces:
* The format of the country code file, documented in iso3166.tab.
+ * The version number of the code and data, as the first line of
+ the text file 'version' in each release.
+
Interface changes in a release attempt to preserve compatibility with
recent releases. For example, tz data files typically do not rely on
recently-added zic features, so that users can run older zic versions
diff --git a/tz-link.htm b/tz-link.htm
index 46be1ad..49fde11 100644
--- a/tz-link.htm
+++ b/tz-link.htm
@@ -10,7 +10,7 @@
content="Sources for time zone and daylight saving time data">
-
+
a through z,
then za through zz, then zza
through zzz, and so on).
+Since version 2016h, each release has contained a text file named
+"version" whose first (and currently only) line is the version.
The releases can also be obtained from the
Time Zone Database website
of the Internet Assigned Numbers
@@ -145,8 +147,9 @@ retrieved from GitHub via the shell
command:
git clone https://github.com/eggert/tz
-Since 2012, each release has been tagged in the development
-repository. Untagged commits are less well tested and probably contain
+
+Since version 2012e, each release has been tagged in development repositories.
+Untagged commits are less well tested and probably contain
more errors.
After obtaining the code and data files, see the
--
2.7.4