- renamed Changelog to ChangeLog in preparation for autoconf
[barry.git] / ChangeLog
blobf5ebc1d8fe7308a7b5e1ff9586ec83057700e9e7
1 Release: version 0.0.2 - 2005/??/??
2 ------------------------------------------------------------------------------
3 2006/05/18
4         - make clean cleans up tests properly now
5 2006/03/31
6         - turned source code browsing on in Doxyfile
7         - added LoadDatabaseByName() and LoadDatabaseByType() template members
8                 to the Controller class
9                 - new file: controllertmpl.h
10         - documentation fixes in builder.h
11         - added static GetDBName() functions to all record classes, in
12                 support of the template Controller functions
13         - fleshed out DatabaseDatabase::GetDBNumber() and GetDBName(),
14                 returning errors properly
15         - documented sample btool.cc code better, and added example
16                 of Controller template member usage
17 2006/03/29
18         - copyright dates updated for 2006
19 2006/01/05
20         - backed out update to latest libusb DEVEL tree, since it is buggy.
21                 Stick with libusb 2005/11/26
22 2005/12/30
23         - added clean target to convenience Makefile
24         - added Boost to list of dependencies in README
25         - fixed minor compile warnings in base64.cc
26         - fixed new USB discovery code, and changed endpoint usage to use
27                 it, instead of the READ_ENDPOINT and WRITE_ENDPOINT
28                 constants... constants are now removed
29                 common.h, controller.cc, probe.cc, probe.h, usbwrap.cc
30         - added ClearHalt() to Usb::Device (usbwrap.cc)
31         - updated usbwrap.h to match latest libusb CVS devel tree
32         - updated README to refer to 2005/12/30 libusb CVS devel tree
33         - added roadmap to Todo list
34 2005/12/29
35         - added convenience Makefile in root directory
36         - added Hacking document
37         - minor touchups to README
38         - added caution warning to README, since this release will support
39                 delete / overwrite / upload functionality
40         - minor compile order change in Makefile (speed reasons)
41         - added dynamic endpoint discovery to probe.cc
42         - changed claim_interface/set_configuration() function call order in
43                 probe.cc based on feedback on the libusb mailing list
44         - added USB discovery code to usbwrap.{h,cc}
45 2005/12/23
46         - fixed packing bug in new upload header struct
47         - renamed CommonField union from data to u to be consistent
48         - added return_code field to DBAccess struct, for error checking
49         - added response checking during upload: if response is non-zero
50                 throw exception in controller.cc
51         - added sorting operators to record parser classes... when writing
52                 contact data to the device, it may be important to write
53                 group link items last, since they reference other contacts...
54                 This needs to be tested, and if not required, removed.
55         - added GROUP_FLAG field code to Contact parser class
56         - fixed offset bug in Contact and Calendar Build() functions
57         - fixed name bug in Contact::Build(), now output only with data
58         - added appointment type flag support to Calendar record parser
59                 class, and "all day event" flag support
60 2005/12/22
61         - added autoconf to Todo list
62         - refactored the protocol structures so that record structs can
63                 be reused for upload and download
64         - with new protostructs, more header control is handled by
65                 controller.cc instead of record.cc parsers and builders
66         - parser code now accepts an offset, to govern start of record data
67         - changed Data sizes from int to size_t and removed casts
68         - removed unneeded Parser::GetHeaderSize() (new protostructs make
69                 this obsolete)
70         - added Calendar::Build() for calendar uploads
71 2005/12/10
72         - added s11n-boost.h serialization templates for boost::serialization
73         - added boost::serialization to build
74         - minor change in usbwrap.cc to display error codes in decimal
75         - added SizePacket special case code to Socket::Send()... this is
76                 required when uploaded packet size is a multiple of 0x40,
77                 a special 3 byte size packet is sent
78         - moved some record class variables to public: so they can be
79                 properly serialized
80         - fixed variable name but in RecordBuilder template
81         - added -f switch to btool, for saving and loading of record data
82         - added -s switch to btool, for uploading saved data back to handheld
83         - added Controller::SaveDatabase()
84 2005/12/08
85         - fixed potential casting / pointer bug in controller.cc
86         - added builder.h, to support uploading
87         - minor comment fixes in parser.h
88         - added preliminary Contact protocol record building support
89         - fixed field order bug in ContactRecord protocol struct
90         - Contact record.h class now saves unknown Group Link field,
91                 for later saving
92 2005/12/07
93         - added -fno-strict-aliasing to compiler flags so gcc-4.0.x won't
94                 optimize away protocol struct casts
95                 see: 
96                 http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25235
97                 http://mail-index.netbsd.org/tech-kern/2003/08/11/0001.html
98                 http://groups.google.ca/group/comp.lang.c++.moderated/ \
99                         browse_thread/thread/e7bf096832526f8e/5714701b \
100                         02a2a3cc?hl=en#5714701b02a2a3cc
101         - changed headers so that any low level protocol-specific sizes and
102                 structs are completely hidden in the library...
103                 this adds library-only header: protostructs.h
105 Release: version 0.0.1 - 2005/11/25
106 ------------------------------------------------------------------------------
107 2005/11/25
108         - added barry.h for documentation purposes and application usage
109         - updated README for release
110         - renamed SBError exception class to BError
111         - updated Doxyfile to version 1.4.5
112         - added more doxygen comments
113 2005/11/24
114         - added conversion routines (and tests) between time_t and min1900_t
115         - added -v option to btool to dynamically control protocol dumping
116         - removed duplicated database database table display in controller.cc
117         - minor spelling corrections
118         - added copyright to usbwrap.{h,cc} as per earlier meeting
119         - added support for Old protocol Calendar entries
120 2005/11/20
121         - added legal.txt, to save typing when adding new source files
122         - ignore test-base64 file (cvsignore)
123         - added contact-to-ldif generation, and updated supporting code
124         - added argument to btool to support contact-to-ldif operation
125         - added Contact::GetPostalAddress()
126         - added README documentation in preparation for future release
127 2005/11/19
128         - added parser.{h,cc} virtual wrapper to generalize LoadDatabase()
129         - added code to socket.cc's Packet() command to re-receive on
130                 reception of empty packets... this seems to be a signal
131                 from the device that it needs more time for long transfers
132                 Current limit: 10 blank packets before exception is thrown
133                 Observed maximum blank count: 1
134         - added MessageRecord and OldMessageRecord to protocol.h
135         - changed common record field structs to one CommonField struct
136         - increased default USB timeout to 10 seconds (some loaded devices
137                 seem to need more time...)
138         - reorganized record.{h,cc} to try to reduce the code duplication
139         - record.h classes now "know" the sizes of their corresponding
140                 protocol structs... this may cause trouble down the line
141                 with Python, if used(?)
142         - added Message class for Email records
143         - removed the "Get*" database functions and replaced with
144                 general LoadDatabase() call, which loads any database
145                 available, and parses it with a Parser object
146         - added GetDBID() for searching for database numbers via name
147         - added test code to retrieve and display all email
148         - cleaned up comments
149         - renamed blackberry.{h,cc} to controller.{h,cc}
150         - renamed bbtool.cc to btool.cc
151         - added Makefile.conf
152         - added copyright notices to source files
153         - added COPYING file with GPL
154         - put parser in Barry namespace, and added auto_ptr-like mode for
155                 store object pointers
156         - added doxygen docs
157         - added header comments to convo.awk script
158         - removed Test() function in Controller object, and made class
159                 better suited to its general API purpose
160         - changed OpenMode() so it loads command table and DBDB... it is now
161                 a public API function
162         - moved Controller test code to btool.cc and made tool more
163                 generically useful... can now download any DB by name on
164                 the command line
165         - added mode checks to Controller
166         - added -t and -d command line options to btool
167         - added base64 routines from John Walker / Fourmilab and Citadel/UX
168         - converted base64 routines into an API, instead of hardcoded
169                 file based
170 2005/11/18
171         - changed project name to Barry, including namespaces
172         - renamed sbcommon.* to common.*
173         - increased USB default timeout to 2 seconds
174         - fixed formatting bug in Data operator<< output
175         - cleaned up the protocol packet structs, getting rid of the
176                 confusing param/simple split... param is now the tableCmd
177                 from the Command Table
178         - moved protocol structs from record.h to protocol.h
179         - added support for older version of the USB protocol, which matches
180                 the Cassis spec more closely
181         - fixed the hardcoded offsets in blackberry.cc's protocol parsing
182         - fixed Socket::Close() so on error, socket flags are reset.
183                 This stops Close() from being called twice on exception
184                 destructors
185 2005/11/17
186         - added Doxyfile to the project
187         - tuned Makefile
188         - added mode selection support to Blackberry class (RIM Desktop,
189                 RIM Bypass, and RIM_JavaLoader)
190                 Mode selection governs which socket is used in subsequent
191                 data transfers.
192         - added Command Table parsing and protocol support
193                 Blackberry class, and CommandTable record class
194         - added Database database parsing and protocol support
195                 Blackberry class and DatabaseDatabase record class
196         - added Address book retrieval support - dumps data to stdout for now
197         - fixed bug in CopyOnWrite mode in Data class, where could allocate
198                 less buffer than data copied
199         - added "easy exception" debug output macro
200         - fixed minor spelling error in protocol.cc
201         - fixed ModeSelectCommand protocol structure - it is not a parameter
202                 command, but uses the unknown slots for socket and flag
203                 data
204         - removed hardcoded socket numbers from protocol.h
205         - fixed bug in socket.cc:Open() where packet size was not properly
206                 saved
207         - implemented socket::Close()
208         - fixed sequence number checks, so it is reset properly on socket 0
209         - added Socket::NextRecord() for multiple record data transfers
210         - fixed input handling bug in translate.cc
211 2005/11/11
212         - added .cvsignore files to project
213         - added README notes to document the source architecture
214         - added dbsetup data script, which shows how to get into database
215                 mode, using the RIM Desktop mode, and open a socket
216         - added blackberry.{h,cc} class
217         - added command line parameters to bbtool.cc
218                 -l = list only
219                 -p = specify pin of blackberry device
220         - added blackberry test code in bbtool.cc - debugging the initial
221                 opening protocol: sockets, modes, etc... see dbsetup for
222                 results
223         - added copy-on-write functionality to Data class, so it can be used
224                 with plain data buffers with little performance impact
225         - added eout() and ddout() debugging - to separate:
226                 - regular debug output
227                 - exception debug output (should probably be logged to
228                         syslog someday, and never turned off)
229                 - raw data dump output
230         - changed errno SBError exception handler to try to decode the error
231                 numbers into english (limited success)
232         - fixed probe and socket USB Bulk message handling, so they don't
233                 use PollCompletions(), but use IO::Wait() (libusb_io_wait())
234         - added common packet size checker in protocol.cc
235         - fixed unpacked protocol packet structs... using gcc's
236                 __attribute__ ((packed)) ... see protocol.h
237         - added ModeSelectCommand structure (protocol.h)
238         - finished Socket::Open() call  (Close() not yet implemented)
239         - moved Socket::Send/Receive() out of private, as they can be used
240                 for socket 0 operations.
241         - cleaned up pointer management with macros:
242                 MAKE_PACKET()
243                 COMMAND()
244                 IS_COMMAND()
245         - added IO::Wait() and IO::Cancel() to correspond with libusb API
246         - added datadumping in usbwrap for easy protocol capture
247         - added preliminary record.{h,cc} classes
248         - added Contact record parsing, and test code
249 2005/10/20
250         - syncberry tree started