|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r56507 - trunk/libs/date_time/xmldoc
From: andrey.semashev_at_[hidden]
Date: 2009-10-01 16:22:05
Author: andysem
Date: 2009-10-01 16:22:04 EDT (Thu, 01 Oct 2009)
New Revision: 56507
URL: http://svn.boost.org/trac/boost/changeset/56507
Log:
Docs updated according to fixes for tickets #1861 and #2213.
Text files modified:
trunk/libs/date_time/xmldoc/changes.xml | 130 ++++++++++++++++++++++++---------------
trunk/libs/date_time/xmldoc/posix_time_zone.xml | 32 ++++----
2 files changed, 95 insertions(+), 67 deletions(-)
Modified: trunk/libs/date_time/xmldoc/changes.xml
==============================================================================
--- trunk/libs/date_time/xmldoc/changes.xml (original)
+++ trunk/libs/date_time/xmldoc/changes.xml 2009-10-01 16:22:04 EDT (Thu, 01 Oct 2009)
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
+<!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
"../../../tools/boostbook/dtd/boostbook.dtd">
<!-- Copyright (c) 2001-2006 CrystalClear Software, Inc.
- Subject to the Boost Software License, Version 1.0.
+ Subject to the Boost Software License, Version 1.0.
(See accompanying file LICENSE_1_0.txt or http://www.boost.org/LICENSE_1_0.txt)
-->
@@ -12,7 +12,7 @@
<!-- if each new change tgroup has a "Bug Fix" as the first "Type", the columns will line up nicely -->
- <bridgehead renderas="sect3">Changes from Boost 1.38 to 1.40 (date_time 1.06 to 1.07)</bridgehead>
+ <bridgehead renderas="sect3">Changes from Boost 1.40 to 1.41 (date_time 1.07 to 1.08)</bridgehead>
<informaltable frame="all">
<tgroup cols="2">
<thead>
@@ -22,13 +22,41 @@
</row>
</thead>
<tbody>
-<!--
+
<row>
- <entry>Feature</entry>
+ <entry>Change</entry>
<entry>
+ The default format for time durations is now "%-%O:%M:%S%F" instead of "%-%H:%M:%S%F" that was used previously. In order to retain the old behavior, the format string has to be specified explicitly during the time IO facet construction (<ulink url="https://svn.boost.org/trac/boost/ticket/1861">#1861</ulink>).
</entry>
</row>
--->
+
+ <row>
+ <entry>Bug fix</entry>
+ <entry>
+ Gregorian dates now use 32-bit integer type internally on 64-bit platforms (<ulink url="https://svn.boost.org/trac/boost/ticket/3308">#3308</ulink>).
+ </entry>
+ </row>
+ <row>
+ <entry>Bug fix</entry>
+ <entry>
+ Adjusted UTC time zone offset boundaries in order to allow offsets up to +14 hours (<ulink url="https://svn.boost.org/trac/boost/ticket/2213">#2213</ulink>).
+ </entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+ <bridgehead renderas="sect3">Changes from Boost 1.38 to 1.40 (date_time 1.06 to 1.07)</bridgehead>
+ <informaltable frame="all">
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Type</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
<row>
<entry>Bug fix</entry>
@@ -186,12 +214,12 @@
<row>
<entry>Feature</entry>
<entry>
- Updated the data in the date_time_zonespec.csv file to reflect new US/Canada
+ Updated the data in the date_time_zonespec.csv file to reflect new US/Canada
daylight savings time rules for 2007. If you upgrade to the new file, be aware
that the library will only give correct answers for current/future date
- conversions. So if you are converting dates from earlier years the answers
- will reflect current time zone rules not past rules. The library doesn't support
- historic timezone rules presently.
+ conversions. So if you are converting dates from earlier years the answers
+ will reflect current time zone rules not past rules. The library doesn't support
+ historic timezone rules presently.
</entry>
</row>
<row>
@@ -235,15 +263,15 @@
</row>
<row>
<entry>Bug Fix</entry>
- <entry>Fix regression errors that showed up under FreeBSD with GCC and the
- LANG environment set to russian -- changed parser to use classic
+ <entry>Fix regression errors that showed up under FreeBSD with GCC and the
+ LANG environment set to russian -- changed parser to use classic
locale instead of blank locale.
</entry>
</row>
<row>
<entry>Bug Fix</entry>
- <entry>Changes for tracker issue 1178092 -- change in convert_to_lower to make
+ <entry>Changes for tracker issue 1178092 -- change in convert_to_lower to make
local a const static and speed up parsing.
</entry>
</row>
@@ -256,9 +284,9 @@
<row>
<entry>Feature</entry>
- <entry>Reduce the usage of basic_stringstream as much a possible to work around
- a bug in the VC8 standard library. See
- <ulink url="http://lists.boost.org/Archives/boost/2006/02/101122.php">mailing list archive</ulink>
+ <entry>Reduce the usage of basic_stringstream as much a possible to work around
+ a bug in the VC8 standard library. See
+ <ulink url="http://lists.boost.org/Archives/boost/2006/02/101122.php">mailing list archive</ulink>
for more information.
</entry>
</row>
@@ -327,7 +355,7 @@
</row>
<row>
<entry>Feature</entry>
- <entry>Input and output facets have been re-written to support format-based
+ <entry>Input and output facets have been re-written to support format-based
redefinition of formats (see <link linkend="date_time.date_time_io">Date Time IO</link> for complete details).
</entry>
</row>
@@ -354,16 +382,16 @@
<row>
<entry>Feature</entry>
<entry>Date-time now uses reentrant POSIX functions on those platforms that
- support them when BOOST_HAS_THREADS is defined.
+ support them when BOOST_HAS_THREADS is defined.
</entry>
</row>
<row>
<entry>Bug Fix</entry>
- <entry>Fixed a bug in serialization code where special values
+ <entry>Fixed a bug in serialization code where special values
(not-a-date-time, infinities, etc) for
- ptime, time_duration would not read back correctly from an archive.
+ ptime, time_duration would not read back correctly from an archive.
The output serialization code wrote subfields such
- as time_duration.seconds() which are invalid for special values and
+ as time_duration.seconds() which are invalid for special values and
thus undefined values. Thus when read back the values could cause
strange behavior including execeptions on construction.
</entry>
@@ -421,16 +449,16 @@
<tbody>
<row>
<entry>Bug Fix</entry>
- <entry>Snap to end of month behavior corrected for year_functor. Previously, starting
- from 2000-Feb-28 (leap year and not end of month) and iterating through the next
- leap year would result in 2004-Feb-29 instead of 2004-Feb-28. This behavior has
- been corrected to produce the correct result of 2004-Feb-28. Thanks to Bart Garst
+ <entry>Snap to end of month behavior corrected for year_functor. Previously, starting
+ from 2000-Feb-28 (leap year and not end of month) and iterating through the next
+ leap year would result in 2004-Feb-29 instead of 2004-Feb-28. This behavior has
+ been corrected to produce the correct result of 2004-Feb-28. Thanks to Bart Garst
for this change.
</entry>
</row>
<row>
<entry>Feature</entry>
- <entry>Free function for creating a ptime object from a FILETIME struct. This function
+ <entry>Free function for creating a ptime object from a FILETIME struct. This function
is only available on platforms that define BOOST_HAS_FTIME.
</entry>
</row>
@@ -442,24 +470,24 @@
</row>
<row>
<entry>Feature</entry>
- <entry>Use of the boost::serialization library is now available with most of the
- date_time classes. Classes capable of serialization are: date_generator classes,
+ <entry>Use of the boost::serialization library is now available with most of the
+ date_time classes. Classes capable of serialization are: date_generator classes,
date, days, date_period, greg_month, greg_weekday, greg_day, ptime, time_duration,
and time_period. Thanks to Bart Garst for this change.
</entry>
</row>
<row>
<entry>Feature</entry>
- <entry>Functions added to convert date and time classes to wstring. The library now
- provides to_*_wstring as well as to_*_string functions for: simple, iso,
- iso_extended, and sql for dates and compilers that support wstrings. Thanks to
+ <entry>Functions added to convert date and time classes to wstring. The library now
+ provides to_*_wstring as well as to_*_string functions for: simple, iso,
+ iso_extended, and sql for dates and compilers that support wstrings. Thanks to
Bart Garst for this change.
</entry>
</row>
<row>
<entry>Feature</entry>
- <entry>Period classes now handle zero length and NULL periods correctly. A NULL period
- is a period with a negative length. Thanks to Frank Wolf and Bart Garst for this
+ <entry>Period classes now handle zero length and NULL periods correctly. A NULL period
+ is a period with a negative length. Thanks to Frank Wolf and Bart Garst for this
change.
</entry>
</row>
@@ -477,7 +505,7 @@
</row>
<row>
<entry>Feature</entry>
- <entry>New names added for some date classes. Original names are still valid but may
+ <entry>New names added for some date classes. Original names are still valid but may
some day be deprecated. Changes are:
<simplelist type='horiz' columns='3'>
<member>date_duration</member>
@@ -513,13 +541,13 @@
</row>
<row>
<entry>Feature</entry>
- <entry>New experimental duration types added for months, years, and weeks. These classes
+ <entry>New experimental duration types added for months, years, and weeks. These classes
also provide mathematical operators for use with date and time classes. Be aware
- that adding of months or years a time or date past the 28th of a month may show
- non-normal mathematical properties. This is a result of 'end-of-month'
- snapping used in the calculation. The last example below illustrates the
- issue.
-
+ that adding of months or years a time or date past the 28th of a month may show
+ non-normal mathematical properties. This is a result of 'end-of-month'
+ snapping used in the calculation. The last example below illustrates the
+ issue.
+
<screen>months m(12);
years y(1);
m == y; // true
@@ -531,7 +559,7 @@
date d(2004,Jan,30);
d += months(1); //2004-Feb-29
d -= months(1); //2004-Jan-29</screen>
- Input streaming is not yet implemented for these types.
+ Input streaming is not yet implemented for these types.
Thanks to Bart Garst for this change.
</entry>
</row>
@@ -542,8 +570,8 @@
</row>
<row>
<entry>Feature</entry>
- <entry>Added constructors for date and ptime that allow for default construction (both)
- and special values construction (ptime, both now support this). Default
+ <entry>Added constructors for date and ptime that allow for default construction (both)
+ and special values construction (ptime, both now support this). Default
constructors initialize the objects to not_a_date_time (NADT).
<screen>ptime p_nadt(not_a_date_time);
ptime p_posinf(pos_infin);
@@ -577,21 +605,21 @@
<entry> Fixed bug in duration_from_string() where a string formatted with
less than full amount of fractional digits created an incorrect
time_duration. With microsecond resolution for time durations
- the string "1:01:01.010" created a time duration of
+ the string "1:01:01.010" created a time duration of
01:01:01.000010 instead of 01:01:01.010000
</entry>
</row>
<row>
<entry>Bug Fix</entry>
- <entry>Fixed the special value constructor for gregorian::date and posix_time::ptime
- when constructing with min_date_time or max_date_time. The wrong value was
+ <entry>Fixed the special value constructor for gregorian::date and posix_time::ptime
+ when constructing with min_date_time or max_date_time. The wrong value was
constructed for these.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
-
+
<bridgehead renderas="sect3">Changes from Boost 1.30 to 1.31 (date_time 1.01 to 1.02)</bridgehead>
<informaltable frame="all">
<tgroup cols="2">
@@ -644,8 +672,8 @@
</row>
<row>
<entry>Feature</entry>
- <entry>Added a function to time_duration to get the total number of seconds in a
- duration truncating any fractional seconds. In addition, other resolutions
+ <entry>Added a function to time_duration to get the total number of seconds in a
+ duration truncating any fractional seconds. In addition, other resolutions
were added to allow for easy conversions. For example
<screen>seconds(1).total_milliseconds() == 1000
seconds(1).total_microseconds() == 1000000
@@ -680,10 +708,10 @@
</tbody>
</tgroup>
</informaltable>
-
+
<bridgehead renderas="sect3">Changes from Boost 1.29 to 1.30 (date_time 1.00 to 1.01)</bridgehead>
<para>
- Notice: The interface to the partial_date class (see <link linkend="date_time.gregorian.date_algorithms">date_algorithms</link>) was changed. The order of construction parameters was changed which will cause some code to fail execution. This change was made to facilitate more generic local time adjustment code. Thus instead of specifying partial_date pd(Dec,25) the code needs to be changed to partial_date pd(25, Dec);
+ Notice: The interface to the partial_date class (see <link linkend="date_time.gregorian.date_algorithms">date_algorithms</link>) was changed. The order of construction parameters was changed which will cause some code to fail execution. This change was made to facilitate more generic local time adjustment code. Thus instead of specifying partial_date pd(Dec,25) the code needs to be changed to partial_date pd(25, Dec);
</para>
<informaltable frame="all">
<tgroup cols="2">
Modified: trunk/libs/date_time/xmldoc/posix_time_zone.xml
==============================================================================
--- trunk/libs/date_time/xmldoc/posix_time_zone.xml (original)
+++ trunk/libs/date_time/xmldoc/posix_time_zone.xml 2009-10-01 16:22:04 EDT (Thu, 01 Oct 2009)
@@ -28,21 +28,21 @@
<para>
A posix_time_zone is unique in that the object is created from a Posix time zone string (IEEE Std 1003.1). A POSIX time zone string takes the form of:
<literallayout>
- "std offset dst [offset],start[/time],end[/time]" (w/no spaces).</literallayout>'std' specifies the abbrev of the time zone. 'offset' is the offset from UTC. 'dst' specifies the abbrev of the time zone during daylight savings time. The second offset is how many hours changed during DST. 'start' and 'end' are the dates when DST goes into (and out of) effect. 'offset' takes the form of:
+ "std offset dst [offset],start[/time],end[/time]" (w/no spaces).</literallayout>'std' specifies the abbrev of the time zone. 'offset' is the offset from UTC. 'dst' specifies the abbrev of the time zone during daylight savings time. The second offset is how many hours changed during DST. 'start' and 'end' are the dates when DST goes into (and out of) effect. 'offset' takes the form of:
<literallayout>
- [+|-]hh[:mm[:ss]] {h=0-23, m/s=0-59}</literallayout>'time' and 'offset' take the same form. 'start' and 'end' can be one of three forms:
+ [+|-]hh[:mm[:ss]] {h=0-23, m/s=0-59}</literallayout>'time' and 'offset' take the same form. 'start' and 'end' can be one of three forms:
<literallayout>
- Mm.w.d {month=1-12, week=1-5 (5 is always last), day=0-6}
- Jn {n=1-365 Feb29 is never counted}
+ Mm.w.d {month=1-12, week=1-5 (5 is always last), day=0-6}
+ Jn {n=1-365 Feb29 is never counted}
n {n=0-365 Feb29 is counted in leap years}</literallayout>
</para>
<para>
- Exceptions will be thrown under the following conditions:
+ Exceptions will be thrown under the following conditions:
<itemizedlist>
<listitem>An exception will be thrown for an invalid date spec (see <link linkend="date_time.gregorian.date_class">date class</link>).</listitem>
<listitem>A boost::local_time::bad_offset exception will be thrown for:</listitem>
<listitem>A DST start or end offset that is negative or more than 24 hours.</listitem>
- <listitem>A UTC zone that is greater than +12 or less than -12 hours.</listitem>
+ <listitem>A UTC zone that is greater than +14 or less than -12 hours.</listitem>
<listitem>A boost::local_time::bad_adjustment exception will be thrown for a DST adjustment that is 24 hours or more (positive or negative)</listitem>
</itemizedlist>
</para>
@@ -66,13 +66,13 @@
leap_day.dst_local_start_time(2003); // Exception thrown</programlisting>
</para>
<para>
- The posix_time_zone objects are used via a boost::shared_ptr<local_time::time_zone_base>. As a convenience, a typedef for boost::shared_ptr<local_time::time_zone_base> is provided:
+ The posix_time_zone objects are used via a boost::shared_ptr<local_time::time_zone_base>. As a convenience, a typedef for boost::shared_ptr<local_time::time_zone_base> is provided:
<programlisting>typedef boost::shared_ptr<time_zone_base> local_time::time_zone_ptr;</programlisting>
</para>
<para>
See <link linkend="date_time.examples.simple_time_zone">Simple time zone</link> for a side by side example of time_zone and posix_time_zone usage.
</para>
-
+
<anchor id="posix_time_zone_notes" />
<bridgehead renderas="sect3">Important Notes</bridgehead>
<itemizedlist>
@@ -133,7 +133,7 @@
<row>
<entry><screen>nyc_zone_sh_ptr->dst_zone_abbrev(); // "EDT"</screen></entry>
</row>
-
+
<row>
<entry valign="top" morerows="1"><screen>std::string std_zone_abbrev()</screen></entry>
<entry>Returns the standard abbreviation for the represented time zone.</entry>
@@ -141,7 +141,7 @@
<row>
<entry><screen>nyc_zone_sh_ptr->std_zone_abbrev(); // "EST"</screen></entry>
</row>
-
+
<row>
<entry valign="top" morerows="1"><screen>std::string dst_zone_name()</screen></entry>
<entry>Returns the daylight savings ABBREVIATION for the represented time zone.</entry>
@@ -149,7 +149,7 @@
<row>
<entry><screen>nyc_zone_sh_ptr->dst_zone_name(); // "EDT"</screen></entry>
</row>
-
+
<row>
<entry valign="top" morerows="1"><screen>std::string std_zone_name()</screen></entry>
<entry>Returns the standard ABBREVIATION for the represented time zone.</entry>
@@ -157,7 +157,7 @@
<row>
<entry><screen>nyc_zone_sh_ptr->std_zone_name(); // "EST"</screen></entry>
</row>
-
+
<row>
<entry valign="top" morerows="1"><screen>bool has_dst()</screen></entry>
<entry>Returns true when time_zone's shared_ptr to dst_calc_rules is not NULL.</entry>
@@ -167,7 +167,7 @@
phx_zone_sh_ptr->has_dst(); // false</screen>
</entry>
</row>
-
+
<row>
<entry valign="top" morerows="1"><screen>
ptime dst_local_start_time(greg_year)</screen></entry>
@@ -177,7 +177,7 @@
<entry><screen>nyc_zone_sh_ptr->dst_local_start_time(2004);
// 2004-Apr-04 02:00</screen></entry>
</row>
-
+
<row>
<entry valign="top" morerows="1"><screen>
ptime dst_local_end_time(greg_year)</screen></entry>
@@ -187,7 +187,7 @@
<entry><screen>nyc_zone_sh_ptr->dst_local_end_time(2004);
// 2004-Oct-31 02:00</screen></entry>
</row>
-
+
<row>
<entry valign="top" morerows="1"><screen>
time_duration base_utc_offset()</screen></entry>
@@ -204,7 +204,7 @@
<row>
<entry><screen>nyc_zone_sh_ptr->dst_offset(); // 01:00</screen></entry>
</row>
-
+
<row>
<entry valign="top" morerows="1"><screen>std::string to_posix_string()</screen></entry>
<entry>Returns a posix time zone string representation of this time_zone_base object. Depending on how the time_zone object was created, the date-spec format of the string will be in either 'M' notation or 'n' notation. Every possible date-spec that can be represented in 'J' notation can also be represented in 'n' notation. The reverse is not true so only 'n' notation is used for these types of date-specs. For a detailed description of a posix time zone string see <link linkend="date_time.local_time.posix_time_zone">posix_time_zone</link>.</entry>
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk