blob: 5d11940b3117b1e99d7f4dff4386e1228343fa76 [file] [log] [blame]
Adam Cozzette48cb18e2018-07-27 11:19:52 -070012018-07-27 version 3.6.1 (C++/Java/Python/PHP/Objective-C/C#/Ruby/JavaScript)
2
3 C++
4 * Introduced workaround for Windows issue with std::atomic and std::once_flag
5 initialization (#4777, #4773).
6
7 PHP
8 * Added compatibility with PHP 7.3 (#4898).
9
10 Ruby
11 * Fixed Ruby crash involving Any encoding (#4718).
12
Adam Cozzetteadf84b42018-06-01 13:58:09 -0700132018-06-01 version 3.6.0 (C++/Java/Python/PHP/Objective-C/C#/Ruby/JavaScript)
14
15 C++
16 * Starting from this release, we now require C++11. For those we cannot yet
17 upgrade to C++11, we will try to keep the 3.5.x branch updated with
18 critical bug fixes only. If you have any concerns about this, please
19 comment on issue #2780.
20 * Moved to C++11 types like std::atomic and std::unique_ptr and away from our
21 old custom-built equivalents.
22 * Added support for repeated message fields in lite protos using implicit
23 weak fields. This is an experimental feature that allows the linker to
24 strip out more unused messages than previously was possible.
25 * Fixed SourceCodeInfo for interpreted options and extension range options.
26 * Fixed always_print_enums_as_ints option for JSON serialization.
27 * Added support for ignoring unknown enum values when parsing JSON.
28 * Create std::string in Arena memory.
29 * Fixed ValidateDateTime to correctly check the day.
30 * Fixed bug in ZeroCopyStreamByteSink.
31 * Various other cleanups and fixes.
32
33 Java
34 * Dropped support for Java 6.
35 * Added a UTF-8 decoder that uses Unsafe to directly decode a byte buffer.
36 * Added deprecation annotations to generated code for deprecated oneof
37 fields.
38 * Fixed map field serialization in DynamicMessage.
39 * Cleanup and documentation for Java Lite runtime.
40 * Various other fixes and cleanups
41 * Fixed unboxed arraylists to handle an edge case
42 * Improved performance for copying between unboxed arraylists
43 * Fixed lite protobuf to avoid Java compiler warnings
44 * Improved test coverage for lite runtime
45 * Performance improvements for lite runtime
46
47 Python
48 * Fixed bytes/string map key incompatibility between C++ and pure-Python
49 implementations (issue #4029)
50 * Added __init__.py files to compiler and util subpackages
51 * Use /MT for all Windows versions
52 * Fixed an issue affecting the Python-C++ implementation when used with
53 Cython (issue #2896)
54 * Various text format fixes
55 * Various fixes to resolve behavior differences between the pure-Python and
56 Python-C++ implementations
57
58 PHP
59 * Added php_metadata_namespace to control the file path of generated metadata
60 file.
61 * Changed generated classes of nested message/enum. E.g., Foo.Bar, which
62 previously generates Foo_Bar, now generates Foo/Bar
63 * Added array constructor. When creating a message, users can pass a php
64 array whose content is field name to value pairs into constructor. The
65 created message will be initialized according to the array. Note that
66 message field should use a message value instead of a sub-array.
67 * Various bug fixes.
68
69 Objective-C
70 * We removed some helper class methods from GPBDictionary to shrink the size
71 of the library, the functionary is still there, but you may need to do some
72 specific +alloc / -init… methods instead.
73 * Minor improvements in the performance of object field getters/setters by
74 avoiding some memory management overhead.
75 * Fix a memory leak during the raising of some errors.
76 * Make header importing completely order independent.
77 * Small code improvements for things the undefined behaviors compiler option
78 was flagging.
79
80 Ruby
81 * Added ruby_package file option to control the module of generated class.
82 * Various bug fixes.
83
84 Javascript
85 * Allow setting string to int64 field.
86
87 Csharp
88 * Unknown fields are now parsed and then sent back on the wire. They can be
89 discarded at parse time via a CodedInputStream option.
90 * Movement towards working with .NET 3.5 and Unity
91 * Expression trees are no longer used
92 * AOT generics issues in Unity/il2cpp have a workaround (see this commit for
93 details)
94 * Floating point values are now compared bitwise (affects NaN value
95 comparisons)
96 * The default size limit when parsing is now 2GB rather than 64MB
97 * MessageParser now supports parsing from a slice of a byte array
98 * JSON list parsing now accepts null values where the underlying proto
99 representation does
100
Jisi Liu7bf1e192017-12-20 10:59:22 -08001012017-12-20 version 3.5.1 (C++/Java/Python/PHP/Objective-C/C#/Ruby/JavaScript)
Jisi Liu7bd16062017-12-19 11:28:30 -0800102 Planned Future Changes
103 * Make C++ implementation C++11 only: we plan to require C++11 to build
104 protobuf code starting from 3.6.0 release. Please join this github issue:
Feng Xiaoafe98de2018-08-22 11:55:30 -0700105 https://github.com/protocolbuffers/protobuf/issues/2780 to provide your feedback.
Jisi Liu7bd16062017-12-19 11:28:30 -0800106
Jisi Liu62616e12017-12-19 15:22:18 -0800107 protoc
108 * Fixed a bug introduced in 3.5.0 and protoc in Windows now accepts non-ascii
109 characters in paths again.
110
Jisi Liu7bd16062017-12-19 11:28:30 -0800111 C++
Jisi Liu62616e12017-12-19 15:22:18 -0800112 * Removed several usages of C++11 features in the code base.
Jisi Liu7bd16062017-12-19 11:28:30 -0800113 * Fixed some compiler warnings.
114
115 PHP
116 * Fixed memory leak in C-extension implementation.
117 * Added discardUnknokwnFields API.
118 * Removed duplicatd typedef in C-extension headers.
119 * Avoided calling private php methods (timelib_update_ts).
120 * Fixed Any.php to use fully-qualified name for DescriptorPool.
121
122 Ruby
123 * Added Google_Protobuf_discard_unknown for discarding unknown fields in
124 messages.
125
126 C#
127 * Unknown fields are now preserved by default.
Jisi Liu62616e12017-12-19 15:22:18 -0800128 * Floating point values are now bitwise compared, affecting message equality
129 check and Contains() API in map and repeated fields.
Jisi Liu7bd16062017-12-19 11:28:30 -0800130
131
Jisi Liu44935952017-11-13 10:47:48 -08001322017-11-13 version 3.5.0 (C++/Java/Python/PHP/Objective-C/C#/Ruby/JavaScript)
Jisi Liuce2d5282017-11-08 13:50:25 -0800133 Planned Future Changes
134 * Make C++ implementation C++11 only: we plan to require C++11 to build
135 protobuf code starting from 3.6.0 release. Please join this github issue:
Feng Xiaoafe98de2018-08-22 11:55:30 -0700136 https://github.com/protocolbuffers/protobuf/issues/2780 to provide your feedback.
Jisi Liuce2d5282017-11-08 13:50:25 -0800137
138 General
139 * Unknown fields are now preserved in proto3 for most of the language
140 implementations for proto3 by default. See the per-language section for
141 details.
142 * reserve keyword are now supported in enums
143
144 C++
145 * Proto3 messages are now preserving unknown fields by default. If you rely on
146 unknowns fields being dropped. Please use DiscardUnknownFields() explicitly.
147 * Deprecated the unsafe_arena_release_* and unsafe_arena_add_allocated_*
148 methods for string fields.
149 * Added move constructor and move assignment to RepeatedField,
150 RepeatedPtrField and google::protobuf::Any.
151 * Added perfect forwarding in Arena::CreateMessage
152 * In-progress experimental support for implicit weak fields with lite protos.
153 This feature allows the linker to strip out more unused messages and reduce
154 binary size.
155 * Various performance optimizations.
156
157 Java
158 * Proto3 messages are now preserving unknown fields by default. If you’d like
Jisi Liu44935952017-11-13 10:47:48 -0800159 to drop unknown fields, please use the DiscardUnknownFieldsParser API. For
Jisi Liuce2d5282017-11-08 13:50:25 -0800160 example:
Jisi Liu8a3c5cc2017-11-08 13:55:55 -0800161 Parser<Foo> parser = DiscardUnknownFieldsParser.wrap(Foo.parser());
162 Foo foo = parser.parseFrom(input);
Jisi Liuce2d5282017-11-08 13:50:25 -0800163 * Added a new CodedInputStream decoder for Iterable<ByteBuffer> with direct
164 ByteBuffers.
165 * TextFormat now prints unknown length-delimited fields as messages if
166 possible.
167 * FieldMaskUtil.merge() no longer creates unnecessary empty messages when a
168 message field is unset in both source message and destination message.
169 * Various performance optimizations.
170
171 Python
172 * Proto3 messages are now preserving unknown fields by default. Use
173 message.DiscardUnknownFields() to drop unknown fields.
174 * Add FieldDescriptor.file in generated code.
175 * Add descriptor pool FindOneofByName in pure python.
176 * Change unknown enum values into unknown field set .
177 * Add more Python dict/list compatibility for Struct/ListValue.
178 * Add utf-8 support for text_format.Merge()/Parse().
179 * Support numeric unknown enum values for proto3 JSON format.
180 * Add warning for Unexpected end-group tag in cpp extension.
181
182 PHP
183 * Proto3 messages are now preserving unknown fields.
184 * Provide well known type messages in runtime.
185 * Add prefix ‘PB’ to generated class of reserved names.
186 * Fixed all conformance tests for encode/decode json in php runtime. C
187 extension needs more work.
188
189 Objective-C
190 * Fixed some issues around copying of messages with unknown fields and then
191 mutating the unknown fields in the copy.
192
193 C#
194 * Added unknown field support in JsonParser.
195 * Fixed oneof message field merge.
Jan Tattermusch07df2302017-11-10 18:37:33 +0100196 * Simplify parsing messages from array slices.
Jisi Liuce2d5282017-11-08 13:50:25 -0800197
198 Ruby
199 * Unknown fields are now preserved by default.
200 * Fixed several bugs for segment fault.
201
202 Javascript
203 * Decoder can handle both paced and unpacked data no matter how the proto is
204 defined.
205 * Decoder now accept long varint for 32 bit integers.
206
207
Jisi Liu3ae8c4c2017-08-14 14:32:48 -07002082017-08-14 version 3.4.0 (C++/Java/Python/PHP/Objective-C/C#/Ruby/JavaScript)
Jisi Liu8a5208f2017-08-01 15:47:26 -0700209 Planned Future Changes
210 * There are some changes that are not included in this release but are planned
211 for the near future
212 - Preserve unknown fields in proto3: We are going to bring unknown fields
213 back into proto3. In this release, some languages start to support
214 preserving unknown fields in proto3, controlled by flags/options. Some
Jisi Liu3ae8c4c2017-08-14 14:32:48 -0700215 languages also introduce explicit APIs to drop unknown fields for
Jisi Liu8a5208f2017-08-01 15:47:26 -0700216 migration. Please read the change log sections by languages for details.
217 For general timeline and plan:
218
219 https://docs.google.com/document/d/1KMRX-G91Aa-Y2FkEaHeeviLRRNblgIahbsk4wA14gRk/view
220
221 For issues and discussions:
222
Feng Xiaoafe98de2018-08-22 11:55:30 -0700223 https://github.com/protocolbuffers/protobuf/issues/272
Jisi Liu8a5208f2017-08-01 15:47:26 -0700224
225 - Make C++ implementation C++11 only: we plan to require C++11 to build
226 protobuf code starting from 3.5.0 or 3.6.0 release, after unknown fields
227 semantic changes are finished. Please join this
228 github issue:
229
Feng Xiaoafe98de2018-08-22 11:55:30 -0700230 https://github.com/protocolbuffers/protobuf/issues/2780
Jisi Liu8a5208f2017-08-01 15:47:26 -0700231
232 to provide your feedback.
233
234 General
235 * Extension ranges now accept options and are customizable.
236 * "reserve" keyword now supports “max” in field number ranges,
237 e.g. reserve 1000 to max;
238
239 C++
240 * Proto3 messages are now able to preserve unknown fields. The default
241 behavior is still to drop unknowns, which will be flipped in a future
242 release. If you rely on unknowns fields being dropped. Please use
Jisi Liu39a91d32017-08-03 11:15:47 -0700243 Message::DiscardUnknownFields() explicitly.
Jisi Liu8a5208f2017-08-01 15:47:26 -0700244 * Packable proto3 fields are now packed by default in serialization.
245 * Following C++11 features are introduced when C++11 is available:
246 - move-constructor and move-assignment are introduced to messages
247 - Repeated fields constructor now takes std::initializer_list
248 - rvalue setters are introduced for string fields
249 * Experimental Table-Driven parsing and serialization available to test. To
250 enable it, pass in table_driven_parsing table_driven_serialization protoc
251 generator flags for C++
252
253 $ protoc --cpp_out=table_driven_parsing,table_driven_serialization:./ \
254 test.proto
Jisi Liu3ae8c4c2017-08-14 14:32:48 -0700255
Jisi Liu8a5208f2017-08-01 15:47:26 -0700256 * lite generator parameter supported by the generator. Once set, all generated
257 files, use lite runtime regardless of the optimizer_for setting in the
258 .proto file.
259 * Various optimizations to make C++ code more performant on PowerPC platform
260 * Fixed maps data corruption when the maps are modified by both reflection API
261 and generated API.
262 * Deterministic serialization on maps reflection now uses stable sort.
263 * file() accessors are introduced to various *Descriptor classes to make
264 writing template function easier.
265 * ByteSize() and SpaceUsed() are deprecated.Use ByteSizeLong() and
266 SpaceUsedLong() instead
267 * Consistent hash function is used for maps in DEBUG and NDEBUG build.
268 * "using namespace std" is removed from stubs/common.h
269 * Various performance optimizations and bug fixes
270
271 Java
272 * Introduced new parser API DiscardUnknownFieldsParser in preparation of
273 proto3 unknown fields preservation change. Users who want to drop unknown
274 fields should migrate to use this new parser API. For example:
275
276 Parser<Foo> parser = DiscardUnknownFieldsParser.wrap(Foo.parser());
277 Foo foo = parser.parseFrom(input);
278
279 * Introduced new TextFormat API printUnicodeFieldValue() that prints field
280 value without escaping unicode characters.
281 * Added Durations.compare(Duration, Duration) and
282 Timestamps.compare(Timestamp, Timestamp).
283 * JsonFormat now accepts base64url encoded bytes fields.
284 * Optimized CodedInputStream to do less copies when parsing large bytes
285 fields.
286 * Optimized TextFormat to allocate less memory when printing.
287
288 Python
289 * SerializeToString API is changed to SerializeToString(self, **kwargs),
290 deterministic parameter is accepted for deterministic serialization.
291 * Added sort_keys parameter in json format to make the output deterministic.
292 * Added indent parameter in json format.
293 * Added extension support in json format.
294 * Added __repr__ support for repeated field in cpp implementation.
295 * Added file in FieldDescriptor.
296 * Added pretty-print filter to text format.
297 * Services and method descriptors are always printed even if generic_service
298 option is turned off.
Jie Luod1484cd2017-08-16 14:40:59 -0700299 * Note: AppEngine 2.5 is deprecated on June 2017 that AppEngine 2.5 will
300 never update protobuf runtime. Users who depend on AppEngine 2.5 should use
301 old protoc.
Jisi Liu44935952017-11-13 10:47:48 -0800302
Jisi Liu8a5208f2017-08-01 15:47:26 -0700303 PHP
304 * Support PHP generic services. Specify file option php_generic_service=true
305 to enable generating service interface.
306 * Message, repeated and map fields setters take value instead of reference.
307 * Added map iterator in c extension.
308 * Support json  encode/decode.
309 * Added more type info in getter/setter phpdoc
310 * Fixed the problem that c extension and php implementation cannot be used
311 together.
312 * Added file option php_namespace to use custom php namespace instead of
313 package.
314 * Added fluent setter.
315 * Added descriptor API in runtime for custom encode/decode.
316 * Various bug fixes.
317
318 Objective-C
319 * Fix for GPBExtensionRegistry copying and add tests.
320 * Optimize GPBDictionary.m codegen to reduce size of overall library by 46K
321 per architecture.
322 * Fix some cases of reading of 64bit map values.
323 * Properly error on a tag with field number zero.
324 * Preserve unknown fields in proto3 syntax files.
325 * Document the exceptions on some of the writing apis.
326
327 C#
328 * Implemented IReadOnlyDictionary<K,V> in MapField<K,V>
329 * Added TryUnpack method for Any message in addition to Unpack.
330 * Converted C# projects to MSBuild (csproj) format.
331
332 Ruby
333 * Several bug fixes.
334
335 Javascript
336 * Added support of field option js_type. Now one can specify the JS type of a
337 64-bit integer field to be string in the generated code by adding option
338 [jstype = JS_STRING] on the field.
339
Feng Xiao80f0c0a2017-04-05 17:26:46 -07003402017-04-05 version 3.3.0 (C++/Java/Python/PHP/Objective-C/C#/Ruby/JavaScript)
341 Planned Future Changes
342 * There are some changes that are not included in this release but are
343 planned for the near future:
344 - Preserve unknown fields in proto3: please read this doc:
345
346 https://docs.google.com/document/d/1KMRX-G91Aa-Y2FkEaHeeviLRRNblgIahbsk4wA14gRk/view
347
348 for the timeline and follow up this github issue:
349
Feng Xiaoafe98de2018-08-22 11:55:30 -0700350 https://github.com/protocolbuffers/protobuf/issues/272
Feng Xiao80f0c0a2017-04-05 17:26:46 -0700351
352 for discussion.
353 - Make C++ implementation C++11 only: we plan to require C++11 to build
354 protobuf code starting from 3.4.0 or 3.5.0 release. Please join this
355 github issue:
356
Feng Xiaoafe98de2018-08-22 11:55:30 -0700357 https://github.com/protocolbuffers/protobuf/issues/2780
Feng Xiao80f0c0a2017-04-05 17:26:46 -0700358
359 to provide your feedback.
360
361 C++
362 * Fixed map fields serialization of DynamicMessage to correctly serialize
363 both key and value regardless of their presence.
364 * Parser now rejects field number 0 correctly.
365 * New API Message::SpaceUsedLong() that’s equivalent to
366 Message::SpaceUsed() but returns the value in size_t.
367 * JSON support
368 - New flag always_print_enums_as_ints in JsonPrintOptions.
369 - New flag preserve_proto_field_names in JsonPrintOptions. It will instruct
370 the JSON printer to use the original field name declared in the .proto
371 file instead of converting them to lowerCamelCase when printing JSON.
372 - JsonPrintOptions.always_print_primtive_fields now works for oneof message
373 fields.
374 - Fixed a bug that doesn’t allow different fields to set the same json_name
375 value.
376 - Fixed a performance bug that causes excessive memory copy when printing
377 large messages.
378 * Various performance optimizations.
379
380 Java
381 * Map field setters eagerly validate inputs and throw NullPointerExceptions
382 as appropriate.
383 * Added ByteBuffer overloads to the generated parsing methods and the Parser
384 interface.
385 * proto3 enum's getNumber() method now throws on UNRECOGNIZED values.
386 * Output of JsonFormat is now locale independent.
387
388 Python
389 * Added FindServiceByName() in the pure-Python DescriptorPool. This works only
390 for descriptors added with DescriptorPool.Add(). Generated descriptor_pool
391 does not support this yet.
392 * Added a descriptor_pool parameter for parsing Any in text_format.Parse().
393 * descriptor_pool.FindFileContainingSymbol() now is able to find nested
394 extensions.
395 * Extending empty [] to repeated field now sets parent message presence.
396
397 PHP
398 * Added file option php_class_prefix. The prefix will be prepended to all
399 generated classes defined in the file.
400 * When encoding, negative int32 values are sign-extended to int64.
401 * Repeated/Map field setter accepts a regular PHP array. Type checking is
402 done on the array elements.
403 * encode/decode are renamed to serializeToString/mergeFromString.
404 * Added mergeFrom, clear method on Message.
405 * Fixed a bug that oneof accessor didn’t return the field name that is
406 actually set.
407 * C extension now works with php7.
408 * This is the first GA release of PHP. We guarantee that old generated code
409 can always work with new runtime and new generated code.
410
411 Objective-C
412 * Fixed help for GPBTimestamp for dates before the epoch that contain
413 fractional seconds.
414 * Added GPBMessageDropUnknownFieldsRecursively() to remove unknowns from a
415 message and any sub messages.
416 * Addressed a threading race in extension registration/lookup.
417 * Increased the max message parsing depth to 100 to match the other languages.
418 * Removed some use of dispatch_once in favor of atomic compare/set since it
419 needs to be heap based.
420 * Fixes for new Xcode 8.3 warnings.
421
422 C#
423 * Fixed MapField.Values.CopyTo, which would throw an exception unnecessarily
424 if provided exactly the right size of array to copy to.
425 * Fixed enum JSON formatting when multiple names mapped to the same numeric
426 value.
427 * Added JSON formatting option to format enums as integers.
428 * Modified RepeatedField<T> to implement IReadOnlyList<T>.
429 * Introduced the start of custom option handling; it's not as pleasant as it
430 might be, but the information is at least present. We expect to extend code
431 generation to improve this in the future.
432 * Introduced ByteString.FromStream and ByteString.FromStreamAsync to
433 efficiently create a ByteString from a stream.
434 * Added whole-message deprecation, which decorates the class with [Obsolete].
435
436 Ruby
437 * Fixed Message#to_h for messages with map fields.
438 * Fixed memcpy() in binary gems to work for old glibc, without breaking the
439 build for non-glibc libc’s like musl.
440
441 Javascript
442 * Added compatibility tests for version 3.0.0.
443 * Added conformance tests.
444 * Fixed serialization of extensions: we need to emit a value even if it is
445 falsy (like the number 0).
446 * Use closurebuilder.py in favor of calcdeps.py for compiling JavaScript.
447
Paul Yang7f3e2372017-01-31 09:17:32 -08004482017-01-23 version 3.2.0 (C++/Java/Python/PHP/Ruby/Objective-C/C#/JavaScript/Lite)
449 General
450 * Added protoc version number to protoc plugin protocol. It can be used by
451 protoc plugin to detect which version of protoc is used with the plugin and
452 mitigate known problems in certain version of protoc.
453
454 C++
455 * The default parsing byte size limit has been raised from 64MB to 2GB.
456 * Added rvalue setters for non-arena string fields.
457 * Enabled debug logging for Android.
458 * Fixed a double-free problem when using Reflection::SetAllocatedMessage()
459 with extension fields.
460 * Fixed several deterministic serialization bugs:
461 * MessageLite::SerializeAsString() now respects the global deterministic
462 serialization flag.
463 * Extension fields are serialized deterministically as well. Fixed protocol
464 compiler to correctly report importing-self as an error.
465 * Fixed FileDescriptor::DebugString() to print custom options correctly.
466 * Various performance/codesize optimizations and cleanups.
467
468 Java
469 * The default parsing byte size limit has been raised from 64MB to 2GB.
470 * Added recursion limit when parsing JSON.
471 * Fixed a bug that enumType.getDescriptor().getOptions() doesn't have custom
472 options.
473 * Fixed generated code to support field numbers up to 2^29-1.
474
475 Python
476 * You can now assign NumPy scalars/arrays (np.int32, np.int64) to protobuf
477 fields, and assigning other numeric types has been optimized for
478 performance.
479 * Pure-Python: message types are now garbage-collectable.
480 * Python/C++: a lot of internal cleanup/refactoring.
481
482 PHP (Alpha)
483 * For 64-bit integers type (int64/uint64/sfixed64/fixed64/sint64), use PHP
484 integer on 64-bit environment and PHP string on 32-bit environment.
485 * PHP generated code also conforms to PSR-4 now.
486 * Fixed ZTS build for c extension.
487 * Fixed c extension build on Mac.
488 * Fixed c extension build on 32-bit linux.
489 * Fixed the bug that message without namespace is not found in the descriptor
490 pool. (#2240)
491 * Fixed the bug that repeated field is not iterable in c extension.
492 * Message names Empty will be converted to GPBEmpty in generated code.
493 * Added phpdoc in generated files.
494 * The released API is almost stable. Unless there is large problem, we won't
495 change it. See
496 https://developers.google.com/protocol-buffers/docs/reference/php-generated
497 for more details.
498
499 Objective-C
500 * Added support for push/pop of the stream limit on CodedInputStream for
501 anyone doing manual parsing.
502
503 C#
504 * No changes.
505
506 Ruby
507 * Message objects now support #respond_to? for field getters/setters.
508 * You can now compare “message == non_message_object” and it will return false
509 instead of throwing an exception.
510 * JRuby: fixed #hashCode to properly reflect the values in the message.
511
512 Javascript
513 * Deserialization of repeated fields no longer has quadratic performance
514 behavior.
515 * UTF-8 encoding/decoding now properly supports high codepoints.
516 * Added convenience methods for some well-known types: Any, Struct, and
517 Timestamp. These make it easier to convert data between native JavaScript
518 types and the well-known protobuf types.
519
Paul Yang17cc42a2016-09-23 18:33:25 -07005202016-09-23 version 3.1.0 (C++/Java/Python/PHP/Ruby/Objective-C/C#/JavaScript/Lite)
521 General
522 * Proto3 support in PHP (alpha).
523 * Various bug fixes.
524
525 C++
526 * Added MessageLite::ByteSizeLong() that’s equivalent to
527 MessageLite::ByteSize() but returns the value in size_t. Useful to check
528 whether a message is over the 2G size limit that protobuf can support.
529 * Moved default_instances to global variables. This allows default_instance
530 addresses to be known at compile time.
531 * Adding missing generic gcc 64-bit atomicops.
532 * Restore New*Callback into google::protobuf namespace since these are used
533 by the service stubs code
534 * JSON support.
535 * Fixed some conformance issues.
536 * Fixed a JSON serialization bug for bytes fields.
537
538 Java
539 * Fixed a bug in TextFormat that doesn’t accept empty repeated fields (i.e.,
540 “field: [ ]”).
541 * JSON support
542 * Fixed JsonFormat to do correct snake_case-to-camelCase conversion for
543 non-style-conforming field names.
544 * Fixed JsonFormat to parse empty Any message correctly.
545 * Added an option to JsonFormat.Parser to ignore unknown fields.
546 * Experimental API
547 * Added UnsafeByteOperations.unsafeWrap(byte[]) to wrap a byte array into
548 ByteString without copy.
549
550 Python
551 * JSON support
552 * Fixed some conformance issues.
553
554 PHP (Alpha)
555 * We have added the proto3 support for PHP via both a pure PHP package and a
556 native c extension. The pure PHP package is intended to provide usability
557 to wider range of PHP platforms, while the c extension is intended to
558 provide higher performance. Both implementations provide the same runtime
559 APIs and share the same generated code. Users don’t need to re-generate
560 code for the same proto definition when they want to switch the
561 implementation later. The pure PHP package is included in the php/src
Paul Yang7f3e2372017-01-31 09:17:32 -0800562 directory, and the c extension is included in the php/ext directory.
563
Paul Yang17cc42a2016-09-23 18:33:25 -0700564 Both implementations provide idiomatic PHP APIs:
565 * All messages and enums are defined as PHP classes.
566 * All message fields can only be accessed via getter/setter.
567 * Both repeated field elements and map elements are stored in containers
568 that act like a normal PHP array.
Paul Yang7f3e2372017-01-31 09:17:32 -0800569
Paul Yang17cc42a2016-09-23 18:33:25 -0700570 Unlike several existing third-party PHP implementations for protobuf, our
571 implementations are built on a "strongly-typed" philosophy: message fields
572 and array/map containers will throw exceptions eagerly when values of the
573 incorrect type (not including those that can be type converted, e.g.,
574 double <-> integer <-> numeric string) are inserted.
Paul Yang7f3e2372017-01-31 09:17:32 -0800575
Paul Yang17cc42a2016-09-23 18:33:25 -0700576 Currently, pure PHP runtime supports php5.5, 5.6 and 7 on linux. C
577 extension runtime supports php5.5 and 5.6 on linux.
Paul Yang7f3e2372017-01-31 09:17:32 -0800578
Paul Yang17cc42a2016-09-23 18:33:25 -0700579 See php/README.md for more details about installment. See
580 https://developers.google.com/protocol-buffers/docs/phptutorial for more
581 details about APIs.
582
583 Objective-C
584 * Helpers are now provided for working the the Any well known type (see
585 GPBWellKnownTypes.h for the api additions).
586 * Some improvements in startup code (especially when extensions aren’t used).
587
588 Javascript
589 * Fixed missing import of jspb.Map
590 * Fixed valueWriterFn variable name
591
592 Ruby
593 * Fixed hash computation for JRuby's RubyMessage
594 * Make sure map parsing frames are GC-rooted.
595 * Added API support for well-known types.
596
597 C#
598 * Removed check on dependency in the C# reflection API.
599
Jisi Liue298ce52016-09-06 14:37:35 -07006002016-09-06 version 3.0.2 (C++/Java/Python/Ruby/Objective-C/C#/JavaScript/Lite)
Jisi Liu4041ed42016-09-02 11:24:58 -0700601 General
602 * Various bug fixes.
603
604 Objective C
605 * Fix for oneofs in proto3 syntax files where fields were set to the zero
606 value.
607 * Fix for embedded null character in strings.
608 * CocoaDocs support
609
610 Ruby
Jisi Liu0c9999f2016-09-02 11:40:58 -0700611 * Fixed memory corruption bug in parsing that could occur under GC pressure.
Jisi Liu4041ed42016-09-02 11:24:58 -0700612
613 Javascript
Jisi Liu0c9999f2016-09-02 11:40:58 -0700614 * jspb.Map is now properly exported to CommonJS modules.
615
616 C#
617 * Removed legacy_enum_values flag.
618
Jisi Liu4041ed42016-09-02 11:24:58 -0700619
Jisi Liue0d817e2016-07-27 12:08:01 -07006202016-07-27 version 3.0.0 (C++/Java/Python/Ruby/Objective-C/C#/JavaScript/Lite)
621 General
622 * This log only contains changes since the beta-4 release. Summarized change
623 log since the last stable release (v2.6.1) can be found in the github
624 release page.
625
626 Compatibility Notice
627 * v3.0.0 is the first API stable release of the v3.x series. We do not expect
628 any future API breaking changes.
629 * For C++, Java Lite and Objective-C, source level compatibility is
630 guaranteed. Upgrading from v3.0.0 to newer minor version releases will be
631 source compatible. For example, if your code compiles against protobuf
632 v3.0.0, it will continue to compile after you upgrade protobuf library to
633 v3.1.0.
634 * For other languages, both source level compatibility and binary level
635 compatibility are guaranteed. For example, if you have a Java binary built
636 against protobuf v3.0.0. After switching the protobuf runtime binary to
637 v3.1.0, your built binary should continue to work.
638 * Compatibility is only guaranteed for documented API and documented
639 behaviors. If you are using undocumented API (e.g., use anything in the C++
640 internal namespace), it can be broken by minor version releases in an
641 undetermined manner.
642
643 Ruby
644 * When you assign a string field `a.string_field = "X"`, we now call
645 #encode(UTF-8) on the string and freeze the copy. This saves you from
646 needing to ensure the string is already encoded as UTF-8. It also prevents
647 you from mutating the string after it has been assigned (this is how we
648 ensure it stays valid UTF-8).
649 * The generated file for `foo.proto` is now `foo_pb.rb` instead of just
650 `foo.rb`. This makes it easier to see which imports/requires are from
651 protobuf generated code, and also prevents conflicts with any `foo.rb` file
652 you might have written directly in Ruby. It is a backward-incompatible
653 change: you will need to update all of your `require` statements.
654 * For package names like `foo_bar`, we now translate this to the Ruby module
655 `FooBar`. This is more idiomatic Ruby than what we used to do (`Foo_bar`).
656
657 JavaScript
658 * Scalar fields like numbers and boolean now return defaults instead of
659 `undefined` or `null` when they are unset. You can test for presence
660 explicitly by calling `hasFoo()`, which we now generate for scalar fields.
661
662 Java Lite
663 * Java Lite is now implemented as a separate plugin, maintained in the
664 `javalite` branch. Both lite runtime and protoc artifacts will be available
665 in Maven.
666
667 C#
668 * Target platforms now .NET 4.5, selected portable subsets and .NET Core.
669 * legacy_enum_values option is no longer supported.
670
Feng Xiao1349fb82016-07-15 12:19:15 -07006712016-07-15 version 3.0.0-beta-4 (C++/Java/Python/Ruby/Objective-C/C#/JavaScript)
672 General
Feng Xiao82b43d12016-07-18 10:36:04 -0700673 * Added a deterministic serialization API for C++. The deterministic
Feng Xiao1349fb82016-07-15 12:19:15 -0700674 serialization guarantees that given a binary, equal messages will be
675 serialized to the same bytes. This allows applications like MapReduce to
676 group equal messages based on the serialized bytes. The deterministic
677 serialization is, however, NOT canonical across languages; it is also
678 unstable across different builds with schema changes due to unknown fields.
679 Users who need canonical serialization, e.g. persistent storage in a
680 canonical form, fingerprinting, etc, should define their own
681 canonicalization specification and implement the serializer using reflection
682 APIs rather than relying on this API.
683 * Added OneofOptions. You can now define custom options for oneof groups.
684 import "google/protobuf/descriptor.proto";
685 extend google.protobuf.OneofOptions {
686 optional int32 my_oneof_extension = 12345;
687 }
688 message Foo {
689 oneof oneof_group {
690 (my_oneof_extension) = 54321;
691 ...
692 }
693 }
694
695 C++ (beta)
696 * Introduced a deterministic serialization API in
697 CodedOutputStream::SetSerializationDeterministic(bool). See the notes about
698 deterministic serialization in the General section.
699 * Added google::protobuf::Map::swap() to swap two map fields.
700 * Fixed a memory leak when calling Reflection::ReleaseMessage() on a message
701 allocated on arena.
702 * Improved error reporting when parsing text format protos.
703 * JSON
704 - Added a new parser option to ignore unknown fields when parsing JSON.
705 - Added convenient methods for message to/from JSON conversion.
706 * Various performance optimizations.
707
708 Java (beta)
Feng Xiao1349fb82016-07-15 12:19:15 -0700709 * File option "java_generate_equals_and_hash" is now deprecated. equals() and
710 hashCode() methods are generated by default.
711 * Added a new JSON printer option "omittingInsignificantWhitespace" to produce
712 a more compact JSON output. The printer will pretty-print by default.
713 * Updated Java runtime to be compatible with 2.5.0/2.6.1 generated protos.
714
715 Python (beta)
716 * Added support to pretty print Any messages in text format.
717 * Added a flag to ignore unknown fields when parsing JSON.
718 * Bugfix: "@type" field of a JSON Any message is now correctly put before
719 other fields.
720
721 Objective-C (beta)
722 * Updated the code to support compiling with more compiler warnings
723 enabled. (Issue 1616)
724 * Exposing more detailed errors for parsing failures. (PR 1623)
725 * Small (breaking) change to the naming of some methods on the support classes
726 for map<>. There were collisions with the system provided KVO support, so
727 the names were changed to avoid those issues. (PR 1699)
728 * Fixed for proper Swift bridging of error handling during parsing. (PR 1712)
729 * Complete support for generating sources that will go into a Framework and
730 depend on generated sources from other Frameworks. (Issue 1457)
731
732 C# (beta)
733 * RepeatedField optimizations.
734 * Support for .NET Core.
735 * Minor bug fixes.
736 * Ability to format a single value in JsonFormatter (advanced usage only).
737 * Modifications to attributes applied to generated code.
738
739 Javascript (alpha)
740 * Maps now have a real map API instead of being treated as repeated fields.
741 * Well-known types are now provided in the google-protobuf package, and the
742 code generator knows to require() them from that package.
743 * Bugfix: non-canonical varints are correctly decoded.
744
745 Ruby (alpha)
746 * Accessors for oneof fields now return default values instead of nil.
747
Feng Xiao3d9726f2016-07-15 15:26:44 -0700748 Java Lite
749 * Java lite support is removed from protocol compiler. It will be supported
750 as a protocol compiler plugin in a separate code branch.
751
Jisi Liu0ec34bf2016-05-16 11:20:33 -07007522016-05-16 version 3.0.0-beta-3 (C++/Java/Python/Ruby/Nano/Objective-C/C#/JavaScript)
Jisi Liu0e4d1ea2016-05-10 17:32:35 -0700753 General
754 * Supported Proto3 lite-runtime in C++/Java for mobile platforms.
755 * Any type now supports APIs to specify prefixes other than
756 type.googleapis.com
Jisi Liu0ec34bf2016-05-16 11:20:33 -0700757 * Removed javanano_use_deprecated_package option; Nano will always has its own
758 ".nano" package.
Jisi Liu0e4d1ea2016-05-10 17:32:35 -0700759
760 C++ (Beta)
Jisi Liu034867f2016-05-13 16:16:14 -0700761 * Improved hash maps.
762 - Improved hash maps comments. In particular, please note that equal hash
763 maps will not necessarily have the same iteration order and
764 serialization.
765 - Added a new hash maps implementation that will become the default in a
766 later release.
Jisi Liu0e4d1ea2016-05-10 17:32:35 -0700767 * Arenas
768 - Several inlined methods in Arena were moved to out-of-line to improve
769 build performance and code size.
770 - Added SpaceAllocatedAndUsed() to report both space used and allocated
771 - Added convenient class UnsafeArenaAllocatedRepeatedPtrFieldBackInserter
772 * Any
Jisi Liuede9cc42016-05-11 15:30:21 -0700773 - Allow custom type URL prefixes in Any packing.
Jisi Liu0e4d1ea2016-05-10 17:32:35 -0700774 - TextFormat now expand the Any type rather than printing bytes.
775 * Performance optimizations and various bug fixes.
776
777 Java (Beta)
778 * Introduced an ExperimentalApi annotation. Annotated APIs are experimental
779 and are subject to change in a backward incompatible way in future releases.
Jisi Liuede9cc42016-05-11 15:30:21 -0700780 * Introduced zero-copy serialization as an ExperimentalApi
781 - Introduction of the `ByteOutput` interface. This is similar to
782 `OutputStream` but provides semantics for lazy writing (i.e. no
783 immediate copy required) of fields that are considered to be immutable.
784 - `ByteString` now supports writing to a `ByteOutput`, which will directly
785 expose the internals of the `ByteString` (i.e. `byte[]` or `ByteBuffer`)
786 to the `ByteOutput` without copying.
787 - `CodedOutputStream` now supports writing to a `ByteOutput`. `ByteString`
788 instances that are too large to fit in the internal buffer will be
789 (lazily) written to the `ByteOutput` directly.
790 - This allows applications using large `ByteString` fields to avoid
791 duplication of these fields entirely. Such an application can supply a
792 `ByteOutput` that chains together the chunks received from
793 `CodedOutputStream` before forwarding them onto the IO system.
794 * Other related changes to `CodedOutputStream`
795 - Additional use of `sun.misc.Unsafe` where possible to perform fast
796 access to `byte[]` and `ByteBuffer` values and avoiding unnecessary
797 range checking.
798 - `ByteBuffer`-backed `CodedOutputStream` now writes directly to the
799 `ByteBuffer` rather than to an intermediate array.
Jisi Liu0ec34bf2016-05-16 11:20:33 -0700800 * Improved lite-runtime.
801 - Lite protos now implement deep equals/hashCode/toString
802 - Significantly improved the performance of Builder#mergeFrom() and
803 Builder#mergeDelimitedFrom()
Jisi Liu0e4d1ea2016-05-10 17:32:35 -0700804 * Various bug fixes and small feature enhancement.
805 - Fixed stack overflow when in hashCode() for infinite recursive oneofs.
806 - Fixed the lazy field parsing in lite to merge rather than overwrite.
807 - TextFormat now supports reporting line/column numbers on errors.
Jisi Liu0ec34bf2016-05-16 11:20:33 -0700808 - Updated to add appropriate @Override for better compiler errors.
Jisi Liu0e4d1ea2016-05-10 17:32:35 -0700809
810 Python (Beta)
Jie Luoe4ca6942016-05-11 16:39:50 -0700811 * Added JSON format for Any, Struct, Value and ListValue
812 * [ ] is now accepted for both repeated scalar fields and repeated message
813 fields in text format parser.
814 * Numerical field name is now supported in text format.
815 * Added DiscardUnknownFields API for python protobuf message.
Jisi Liu0e4d1ea2016-05-10 17:32:35 -0700816
817 Objective-C (Beta)
Jisi Liuede9cc42016-05-11 15:30:21 -0700818 * Proto comments now come over as HeaderDoc comments in the generated sources
819 so Xcode can pick them up and display them.
820 * The library headers have been updated to use HeaderDoc comments so Xcode can
821 pick them up and display them.
822 * The per message and per field overhead in both generated code and runtime
823 object sizes was reduced.
824 * Generated code now include deprecated annotations when the proto file
825 included them.
Jisi Liu0e4d1ea2016-05-10 17:32:35 -0700826
827 C# (Beta)
Jisi Liuede9cc42016-05-11 15:30:21 -0700828 In general: some changes are breaking, which require regenerating messages.
829 Most user-written code will not be impacted *except* for the renaming of enum
830 values.
831
832 * Allow custom type URL prefixes in `Any` packing, and ignore them when
833 unpacking
834 * `protoc` is now in a separate NuGet package (Google.Protobuf.Tools)
835 * New option: `internal_access` to generate internal classes
836 * Enum values are now PascalCased, and if there's a prefix which matches the
837 name of the enum, that is removed (so an enum `COLOR` with a value
838 `COLOR_BLUE` would generate a value of just `Blue`). An option
839 (`legacy_enum_values`) is temporarily available to disable this, but the
840 option will be removed for GA.
841 * `json_name` option is now honored
842 * If group tags are encountered when parsing, they are validated more
843 thoroughly (although we don't support actual groups)
844 * NuGet dependencies are better specified
845 * Breaking: `Preconditions` is renamed to `ProtoPreconditions`
846 * Breaking: `GeneratedCodeInfo` is renamed to `GeneratedClrTypeInfo`
847 * `JsonFormatter` now allows writing to a `TextWriter`
848 * New interface, `ICustomDiagnosticMessage` to allow more compact
849 representations from `ToString`
850 * `CodedInputStream` and `CodedOutputStream` now implement `IDisposable`,
851 which simply disposes of the streams they were constructed with
852 * Map fields no longer support null values (in line with other languages)
853 * Improvements in JSON formatting and parsing
Jisi Liu0e4d1ea2016-05-10 17:32:35 -0700854
855 Javascript (Alpha)
Josh Habermand346f492016-05-12 17:55:56 -0700856 * Better support for "bytes" fields: bytes fields can be read as either a
857 base64 string or UInt8Array (in environments where TypedArray is supported).
858 * New support for CommonJS imports. This should make it easier to use the
859 JavaScript support in Node.js and tools like WebPack. See js/README.md for
860 more information.
861 * Some significant internal refactoring to simplify and modularize the code.
862
863 Ruby (Alpha)
864 * JSON serialization now properly uses camelCased names, with a runtime option
865 that will preserve original names from .proto files instead.
866 * Well-known types are now included in the distribution.
867 * Release now includes binary gems for Windows, Mac, and Linux instead of just
868 source gems.
869 * Bugfix for serializing oneofs.
Jisi Liu0e4d1ea2016-05-10 17:32:35 -0700870
871 C++/Java Lite (Alpha)
872 A new "lite" generator parameter was introduced in the protoc for C++ and
Jisi Liu5668e2e2016-05-11 14:57:06 -0700873 Java for Proto3 syntax messages. Example usage:
Jisi Liu0e4d1ea2016-05-10 17:32:35 -0700874
875 ./protoc --cpp_out=lite:$OUTPUT_PATH foo.proto
876
877 The protoc will treat the current input and all the transitive dependencies
878 as LITE. The same generator parameter must be used to generate the
879 dependencies.
880
881 In Proto3 syntax files, "optimized_for=LITE_RUNTIME" is no longer supported.
882
883
Josh Haberman81e75c12015-12-30 14:03:49 -08008842015-12-30 version 3.0.0-beta-2 (C++/Java/Python/Ruby/Nano/Objective-C/C#/JavaScript)
Feng Xiaod5fb4082015-12-21 14:36:30 -0800885 General
Dongjoon Hyun7b08d492016-01-11 14:52:01 -0800886 * Introduced a new language implementation: JavaScript.
Feng Xiaod5fb4082015-12-21 14:36:30 -0800887 * Added a new field option "json_name". By default proto field names are
888 converted to "lowerCamelCase" in proto3 JSON format. This option can be
889 used to override this behavior and specify a different JSON name for the
890 field.
891 * Added conformance tests to ensure implementations are following proto3 JSON
892 specification.
893
894 C++ (Beta)
895 * Various bug fixes and improvements to the JSON support utility:
896 - Duplicate map keys in JSON are now rejected (i.e., translation will
897 fail).
898 - Fixed wire-format for google.protobuf.Value/ListValue.
899 - Fixed precision loss when converting google.protobuf.Timestamp.
900 - Fixed a bug when parsing invalid UTF-8 code points.
901 - Fixed a memory leak.
902 - Reduced call stack usage.
903
904 Java (Beta)
905 * Cleaned up some unused methods on CodedOutputStream.
906 * Presized lists for packed fields during parsing in the lite runtime to
907 reduce allocations and improve performance.
908 * Improved the performance of unknown fields in the lite runtime.
909 * Introduced UnsafeByteStrings to support zero-copy ByteString creation.
910 * Various bug fixes and improvements to the JSON support utility:
911 - Fixed a thread-safety bug.
912 - Added a new option “preservingProtoFieldNames” to JsonFormat.
913 - Added a new option “includingDefaultValueFields” to JsonFormat.
914 - Updated the JSON utility to comply with proto3 JSON specification.
915
916 Python (Beta)
917 * Added proto3 JSON format utility. It includes support for all field types
918 and a few well-known types except for Any and Struct.
919 * Added runtime support for Any, Timestamp, Duration and FieldMask.
920 * [ ] is now accepted for repeated scalar fields in text format parser.
Josh Haberman81e75c12015-12-30 14:03:49 -0800921 * Map fields now have proper O(1) performance for lookup/insert/delete
922 when using the Python/C++ implementation. They were previously using O(n)
923 search-based algorithms because the C++ reflection interface didn't
924 support true map operations.
Feng Xiaod5fb4082015-12-21 14:36:30 -0800925
926 Objective-C (Beta)
927 * Various bug-fixes and code tweaks to pass more strict compiler warnings.
928 * Now has conformance test coverage and is passing all tests.
929
930 C# (Beta)
931 * Various bug-fixes.
932 * Code generation: Files generated in directories based on namespace.
933 * Code generation: Include comments from .proto files in XML doc
934 comments (naively)
935 * Code generation: Change organization/naming of "reflection class" (access
936 to file descriptor)
937 * Code generation and library: Add Parser property to MessageDescriptor,
938 and introduce a non-generic parser type.
939 * Library: Added TypeRegistry to support JSON parsing/formatting of Any.
940 * Library: Added Any.Pack/Unpack support.
941 * Library: Implemented JSON parsing.
942
943 Javascript (Alpha)
944 * Added proto3 support for JavaScript. The runtime is written in pure
945 JavaScript and works in browsers and in Node.js. To generate JavaScript
946 code for your proto, invoke protoc with "--js_out". See js/README.md
947 for more build instructions.
948
Feng Xiaocc607532015-08-26 16:31:30 -07009492015-08-26 version 3.0.0-beta-1 (C++/Java/Python/Ruby/Nano/Objective-C/C#)
950 About Beta
951 * This is the first beta release of protobuf v3.0.0. Not all languages
952 have reached beta stage. Languages not marked as beta are still in
953 alpha (i.e., be prepared for API breaking changes).
954
955 General
956 * Proto3 JSON is supported in several languages (fully supported in C++
957 and Java, partially supported in Ruby/C#). The JSON spec is defined in
958 the proto3 language guide:
959
960 https://developers.google.com/protocol-buffers/docs/proto3#json
961
962 We will publish a more detailed spec to define the exact behavior of
963 proto3-conformant JSON serializers and parsers. Until then, do not rely
964 on specific behaviors of the implementation if it’s not documented in
965 the above spec. More specifically, the behavior is not yet finalized for
966 the following:
967 - Parsing invalid JSON input (e.g., input with trailing commas).
968 - Non-camelCase names in JSON input.
969 - The same field appears multiple times in JSON input.
970 - JSON arrays contain “null” values.
971 - The message has unknown fields.
972
973 * Proto3 now enforces strict UTF-8 checking. Parsing will fail if a string
974 field contains non UTF-8 data.
975
976 C++ (Beta)
977 * Introduced new utility functions/classes in the google/protobuf/util
978 directory:
979 - MessageDifferencer: compare two proto messages and report their
980 differences.
981 - JsonUtil: support converting protobuf binary format to/from JSON.
982 - TimeUtil: utility functions to work with well-known types Timestamp
983 and Duration.
984 - FieldMaskUtil: utility functions to work with FieldMask.
985
986 * Performance optimization of arena construction and destruction.
987 * Bug fixes for arena and maps support.
988 * Changed to use cmake for Windows Visual Studio builds.
989 * Added Bazel support.
990
991 Java (Beta)
992 * Introduced a new util package that will be distributed as a separate
993 artifact in maven. It contains:
994 - JsonFormat: convert proto messages to/from JSON.
995 - TimeUtil: utility functions to work with Timestamp and Duration.
996 - FieldMaskUtil: utility functions to work with FieldMask.
997
998 * The static PARSER in each generated message is deprecated, and it will
999 be removed in a future release. A static parser() getter is generated
1000 for each message type instead.
1001 * Performance optimizations for String fields serialization.
1002 * Performance optimizations for Lite runtime on Android:
1003 - Reduced allocations
1004 - Reduced method overhead after ProGuarding
1005 - Reduced code size after ProGuarding
1006
1007 Python (Alpha)
1008 * Removed legacy Python 2.5 support.
1009 * Moved to a single Python 2.x/3.x-compatible codebase, instead of using 2to3.
1010 * Fixed build/tests on Python 2.6, 2.7, 3.3, and 3.4.
1011 - Pure-Python works on all four.
1012 - Python/C++ implementation works on all but 3.4, due to changes in the
1013 Python/C++ API in 3.4.
1014 * Some preliminary work has been done to allow for multiple DescriptorPools
1015 with Python/C++.
1016
1017 Ruby (Alpha)
1018 * Many bugfixes:
1019 - fixed parsing/serialization of bytes, sint, sfixed types
1020 - other parser bugfixes
1021 - fixed memory leak affecting Ruby 2.2
1022
1023 JavaNano (Alpha)
1024 * JavaNano generated code now will be put in a nano package by default to
1025 avoid conflicts with Java generated code.
1026
1027 Objective-C (Alpha)
1028 * Added non-null markup to ObjC library. Requires SDK 8.4+ to build.
1029 * Many bugfixes:
1030 - Removed the class/enum filter.
1031 - Renamed some internal types to avoid conflicts with the well-known types
1032 protos.
1033 - Added missing support for parsing repeated primitive fields in packed or
1034 unpacked forms.
1035 - Added *Count for repeated and map<> fields to avoid auto-create when
1036 checking for them being set.
1037
1038 C# (Alpha)
1039 * Namespace changed to Google.Protobuf (and NuGet package will be named
1040 correspondingly).
1041 * Target platforms now .NET 4.5 and selected portable subsets only.
1042 * Removed lite runtime.
1043 * Reimplementation to use mutable message types.
1044 * Null references used to represent "no value" for message type fields.
1045 * Proto3 semantics supported; proto2 files are prohibited for C# codegen.
1046 Most proto3 features supported:
1047 - JSON formatting (a.k.a. serialization to JSON), including well-known
1048 types (except for Any).
1049 - Wrapper types mapped to nullable value types (or string/ByteString
1050 allowing nullability). JSON parsing is not supported yet.
1051 - maps
1052 - oneof
1053 - enum unknown value preservation
1054
Bo Yang8908cf12015-05-26 14:37:47 -070010552015-05-25 version 3.0.0-alpha-3 (Objective-C/C#):
1056 General
1057 * Introduced two new language implementations (Objective-C, C#) to proto3.
Bo Yang3e2c8a52015-05-28 14:52:44 -07001058 * Explicit "optional" keyword are disallowed in proto3 syntax, as fields are
1059 optional by default.
1060 * Group fields are no longer supported in proto3 syntax.
Bo Yang8908cf12015-05-26 14:37:47 -07001061 * Changed repeated primitive fields to use packed serialization by default in
1062 proto3 (implemented for C++, Java, Python in this release). The user can
1063 still disable packed serialization by setting packed to false for now.
1064 * Added well-known type protos (any.proto, empty.proto, timestamp.proto,
1065 duration.proto, etc.). Users can import and use these protos just like
Dongjoon Hyun7b08d492016-01-11 14:52:01 -08001066 regular proto files. Additional runtime support will be added for them in
Bo Yang8908cf12015-05-26 14:37:47 -07001067 future releases (in the form of utility helper functions, or having them
1068 replaced by language specific types in generated code).
1069 * Added a "reserved" keyword in both proto2 and proto3 syntax. User can use
1070 this keyword to declare reserved field numbers and names to prevent them
1071 from being reused by other fields in the same message.
1072
1073 To reserve field numbers, add a reserved declaration in your message:
1074
1075 message TestMessage {
1076 reserved 2, 15, 9 to 11, 3;
1077 }
1078
1079 This reserves field numbers 2, 3, 9, 10, 11 and 15. If a user uses any of
1080 these as field numbers, the protocol buffer compiler will report an error.
1081
1082 Field names can also be reserved:
1083
1084 message TestMessage {
1085 reserved "foo", "bar";
1086 }
1087
1088 * Various bug fixes since 3.0.0-alpha-2
1089
1090 Objective-C
1091 Objective-C includes a code generator and a native objective-c runtime
1092 library. By adding “--objc_out” to protoc, the code generator will generate
1093 a header(*.pbobjc.h) and an implementation file(*.pbobjc.m) for each proto
1094 file.
1095
1096 In this first release, the generated interface provides: enums, messages,
1097 field support(single, repeated, map, oneof), proto2 and proto3 syntax
1098 support, parsing and serialization. It’s compatible with ARC and non-ARC
1099 usage. Besides, user can also access it via the swift bridging header.
1100
1101 See objectivec/README.md for details.
1102
1103 C#
1104 * C# protobufs are based on project
1105 https://github.com/jskeet/protobuf-csharp-port. The original project was
1106 frozen and all the new development will happen here.
1107 * Codegen plugin for C# was completely rewritten to C++ and is now an
Dongjoon Hyun7b08d492016-01-11 14:52:01 -08001108 integral part of protoc.
Bo Yang8908cf12015-05-26 14:37:47 -07001109 * Some refactorings and cleanup has been applied to the C# runtime library.
1110 * Only proto2 is supported in C# at the moment, proto3 support is in
1111 progress and will likely bring significant breaking changes to the API.
1112
1113 See csharp/README.md for details.
1114
1115 C++
1116 * Added runtime support for Any type. To use Any in your proto file, first
1117 import the definition of Any:
1118
1119 // foo.proto
1120 import "google/protobuf/any.proto";
1121 message Foo {
1122 google.protobuf.Any any_field = 1;
1123 }
1124 message Bar {
1125 int32 value = 1;
1126 }
1127
1128 Then in C++ you can access the Any field using PackFrom()/UnpackTo()
1129 methods:
1130
1131 Foo foo;
1132 Bar bar = ...;
1133 foo.mutable_any_field()->PackFrom(bar);
1134 ...
1135 if (foo.any_field().IsType<Bar>()) {
1136 foo.any_field().UnpackTo(&bar);
1137 ...
1138 }
1139 * In text format, entries of a map field will be sorted by key.
1140
1141 Java
1142 * Continued optimizations on the lite runtime to improve performance for
1143 Android.
1144
1145 Python
1146 * Added map support.
1147 - maps now have a dict-like interface (msg.map_field[key] = value)
1148 - existing code that modifies maps via the repeated field interface
1149 will need to be updated.
1150
1151 Ruby
1152 * Improvements to RepeatedField's emulation of the Ruby Array API.
1153 * Various speedups and internal cleanups.
1154
Josh Haberman7d5cf8d2015-02-25 23:47:09 -080011552015-02-26 version 3.0.0-alpha-2 (Python/Ruby/JavaNano):
Jisi Liu32f5d012015-02-20 14:45:45 -08001156 General
Josh Haberman7d5cf8d2015-02-25 23:47:09 -08001157 * Introduced three new language implementations (Ruby, JavaNano, and
1158 Python) to proto3.
Jisi Liu32f5d012015-02-20 14:45:45 -08001159 * Various bug fixes since 3.0.0-alpha-1
1160
Josh Haberman31e8c202015-02-25 23:06:35 -08001161 Python:
1162 Python has received several updates, most notably support for proto3
1163 semantics in any .proto file that declares syntax="proto3".
1164 Messages declared in proto3 files no longer represent field presence
1165 for scalar fields (number, enums, booleans, or strings). You can
1166 no longer call HasField() for such fields, and they are serialized
1167 based on whether they have a non-zero/empty/false value.
1168
1169 One other notable change is in the C++-accelerated implementation.
1170 Descriptor objects (which describe the protobuf schema and allow
1171 reflection over it) are no longer duplicated between the Python
1172 and C++ layers. The Python descriptors are now simple wrappers
1173 around the C++ descriptors. This change should significantly
1174 reduce the memory usage of programs that use a lot of message
1175 types.
1176
Jisi Liu32f5d012015-02-20 14:45:45 -08001177 Ruby:
Chris Fallin1d4f3212015-02-20 17:32:06 -08001178 We have added proto3 support for Ruby via a native C extension.
1179
1180 The Ruby extension itself is included in the ruby/ directory, and details on
1181 building and installing the extension are in ruby/README.md. The extension
1182 will also be published as a Ruby gem. Code generator support is included as
1183 part of `protoc` with the `--ruby_out` flag.
1184
1185 The Ruby extension implements a user-friendly DSL to define message types
1186 (also generated by the code generator from `.proto` files). Once a message
1187 type is defined, the user may create instances of the message that behave in
1188 ways idiomatic to Ruby. For example:
1189
1190 - Message fields are present as ordinary Ruby properties (getter method
1191 `foo` and setter method `foo=`).
1192 - Repeated field elements are stored in a container that acts like a native
1193 Ruby array, and map elements are stored in a container that acts like a
1194 native Ruby hashmap.
1195 - The usual well-known methods, such as `#to_s`, `#dup`, and the like, are
1196 present.
1197
1198 Unlike several existing third-party Ruby extensions for protobuf, this
1199 extension is built on a "strongly-typed" philosophy: message fields and
1200 array/map containers will throw exceptions eagerly when values of the
1201 incorrect type are inserted.
1202
1203 See ruby/README.md for details.
Jisi Liu32f5d012015-02-20 14:45:45 -08001204
1205 JavaNano:
1206 JavaNano is a special code generator and runtime library designed especially
1207 for resource-restricted systems, like Android. It is very resource-friendly
1208 in both the amount of code and the runtime overhead. Here is an an overview
1209 of JavaNano features compared with the official Java protobuf:
1210
1211 - No descriptors or message builders.
1212 - All messages are mutable; fields are public Java fields.
1213 - For optional fields only, encapsulation behind setter/getter/hazzer/
1214 clearer functions is opt-in, which provide proper 'has' state support.
1215 - For proto2, if not opted in, has state (field presence) is not available.
1216 Serialization outputs all fields not equal to their defaults.
1217 The behavior is consistent with proto3 semantics.
1218 - Required fields (proto2 only) are always serialized.
1219 - Enum constants are integers; protection against invalid values only
1220 when parsing from the wire.
1221 - Enum constants can be generated into container interfaces bearing
1222 the enum's name (so the referencing code is in Java style).
1223 - CodedInputByteBufferNano can only take byte[] (not InputStream).
1224 - Similarly CodedOutputByteBufferNano can only write to byte[].
1225 - Repeated fields are in arrays, not ArrayList or Vector. Null array
1226 elements are allowed and silently ignored.
1227 - Full support for serializing/deserializing repeated packed fields.
1228 - Support extensions (in proto2).
1229 - Unset messages/groups are null, not an immutable empty default
1230 instance.
1231 - toByteArray(...) and mergeFrom(...) are now static functions of
1232 MessageNano.
1233 - The 'bytes' type translates to the Java type byte[].
1234
1235 See javanano/README.txt for details.
1236
Feng Xiao9104da32014-12-09 11:57:52 -080012372014-12-01 version 3.0.0-alpha-1 (C++/Java):
1238
1239 General
1240 * Introduced Protocol Buffers language version 3 (aka proto3).
1241
1242 When protobuf was initially opensourced it implemented Protocol Buffers
1243 language version 2 (aka proto2), which is why the version number
1244 started from v2.0.0. From v3.0.0, a new language version (proto3) is
1245 introduced while the old version (proto2) will continue to be supported.
1246
1247 The main intent of introducing proto3 is to clean up protobuf before
1248 pushing the language as the foundation of Google's new API platform.
1249 In proto3, the language is simplified, both for ease of use and to
1250 make it available in a wider range of programming languages. At the
1251 same time a few features are added to better support common idioms
1252 found in APIs.
1253
1254 The following are the main new features in language version 3:
1255
1256 1. Removal of field presence logic for primitive value fields, removal
1257 of required fields, and removal of default values. This makes proto3
1258 significantly easier to implement with open struct representations,
1259 as in languages like Android Java, Objective C, or Go.
1260 2. Removal of unknown fields.
1261 3. Removal of extensions, which are instead replaced by a new standard
1262 type called Any.
1263 4. Fix semantics for unknown enum values.
1264 5. Addition of maps.
1265 6. Addition of a small set of standard types for representation of time,
1266 dynamic data, etc.
1267 7. A well-defined encoding in JSON as an alternative to binary proto
1268 encoding.
1269
1270 This release (v3.0.0-alpha-1) includes partial proto3 support for C++ and
1271 Java. Items 6 (well-known types) and 7 (JSON format) in the above feature
Dongjoon Hyun7b08d492016-01-11 14:52:01 -08001272 list are not implemented.
Feng Xiao9104da32014-12-09 11:57:52 -08001273
1274 A new notion "syntax" is introduced to specify whether a .proto file
1275 uses proto2 or proto3:
1276
1277 // foo.proto
1278 syntax = "proto3";
1279 message Bar {...}
1280
1281 If omitted, the protocol compiler will generate a warning and "proto2" will
1282 be used as the default. This warning will be turned into an error in a
1283 future release.
1284
1285 We recommend that new Protocol Buffers users use proto3. However, we do not
1286 generally recommend that existing users migrate from proto2 from proto3 due
1287 to API incompatibility, and we will continue to support proto2 for a long
1288 time.
1289
1290 * Added support for map fields (implemented in C++/Java for both proto2 and
1291 proto3).
1292
1293 Map fields can be declared using the following syntax:
1294
1295 message Foo {
1296 map<string, string> values = 1;
1297 }
1298
1299 Data of a map field will be stored in memory as an unordered map and it
1300 can be accessed through generated accessors.
1301
1302 C++
1303 * Added arena allocation support (for both proto2 and proto3).
1304
1305 Profiling shows memory allocation and deallocation constitutes a significant
1306 fraction of CPU-time spent in protobuf code and arena allocation is a
1307 technique introduced to reduce this cost. With arena allocation, new
1308 objects will be allocated from a large piece of preallocated memory and
1309 deallocation of these objects is almost free. Early adoption shows 20% to
1310 50% improvement in some Google binaries.
1311
1312 To enable arena support, add the following option to your .proto file:
1313
1314 option cc_enable_arenas = true;
1315
1316 Protocol compiler will generate additional code to make the generated
1317 message classes work with arenas. This does not change the existing API
1318 of protobuf messages and does not affect wire format. Your existing code
1319 should continue to work after adding this option. In the future we will
1320 make this option enabled by default.
1321
1322 To actually take advantage of arena allocation, you need to use the arena
1323 APIs when creating messages. A quick example of using the arena API:
1324
1325 {
1326 google::protobuf::Arena arena;
1327 // Allocate a protobuf message in the arena.
1328 MyMessage* message = Arena::CreateMessage<MyMessage>(&arena);
1329 // All submessages will be allocated in the same arena.
1330 if (!message->ParseFromString(data)) {
1331 // Deal with malformed input data.
1332 }
1333 // Must not delete the message here. It will be deleted automatically
1334 // when the arena is destroyed.
1335 }
1336
1337 Currently arena does not work with map fields. Enabling arena in a .proto
1338 file containing map fields will result in compile errors in the generated
1339 code. This will be addressed in a future release.
1340
Feng Xiaobba83652014-10-20 17:06:06 -070013412014-10-20 version 2.6.1:
Feng Xiao57b86722014-10-09 11:20:08 -07001342
1343 C++
1344 * Added atomicops support for Solaris.
1345 * Released memory allocated by InitializeDefaultRepeatedFields() and
1346 GetEmptyString(). Some memory sanitizers reported them as memory leaks.
1347
1348 Java
1349 * Updated DynamicMessage.setField() to handle repeated enum values
1350 correctly.
1351 * Fixed a bug that caused NullPointerException to be thrown when
1352 converting manually constructed FileDescriptorProto to
1353 FileDescriptor.
1354
1355 Python
Feng Xiao419c94b2014-10-09 11:40:02 -07001356 * Fixed WhichOneof() to work with de-serialized protobuf messages.
Feng Xiao57b86722014-10-09 11:20:08 -07001357 * Fixed a missing file problem of Python C++ implementation.
1358
jieluo@google.com1eba9d92014-08-25 20:17:53 +000013592014-08-15 version 2.6.0:
1360
1361 General
1362 * Added oneofs(unions) feature. Fields in the same oneof will share
1363 memory and at most one field can be set at the same time. Use the
1364 oneof keyword to define a oneof like:
1365 message SampleMessage {
1366 oneof test_oneof {
1367 string name = 4;
1368 YourMessage sub_message = 9;
1369 }
1370 }
1371 * Files, services, enums, messages, methods and enum values can be marked
1372 as deprecated now.
Dongjoon Hyun7b08d492016-01-11 14:52:01 -08001373 * Added Support for list values, including lists of messages, when
jieluo@google.com1eba9d92014-08-25 20:17:53 +00001374 parsing text-formatted protos in C++ and Java.
1375 For example: foo: [1, 2, 3]
1376
1377 C++
1378 * Enhanced customization on TestFormat printing.
1379 * Added SwapFields() in reflection API to swap a subset of fields.
1380 Added SetAllocatedMessage() in reflection API.
1381 * Repeated primitive extensions are now packable. The
1382 [packed=true] option only affects serializers. Therefore, it is
1383 possible to switch a repeated extension field to packed format
1384 without breaking backwards-compatibility.
1385 * Various speed optimizations.
1386
1387 Java
1388 * writeTo() method in ByteString can now write a substring to an
1389 output stream. Added endWith() method for ByteString.
1390 * ByteString and ByteBuffer are now supported in CodedInputStream
1391 and CodedOutputStream.
1392 * java_generate_equals_and_hash can now be used with the LITE_RUNTIME.
1393
1394 Python
1395 * A new C++-backed extension module (aka "cpp api v2") that replaces the
1396 old ("cpp api v1") one. Much faster than the pure Python code. This one
1397 resolves many bugs and is recommended for general use over the
1398 pure Python when possible.
1399 * Descriptors now have enum_types_by_name and extension_types_by_name dict
1400 attributes.
1401 * Support for Python 3.
1402
xiaofeng@google.com2c9392f2013-02-28 06:12:28 +000014032013-02-27 version 2.5.0:
xiaofeng@google.comb55a20f2012-09-22 02:40:50 +00001404
1405 General
1406 * New notion "import public" that allows a proto file to forward the content
1407 it imports to its importers. For example,
1408 // foo.proto
1409 import public "bar.proto";
1410 import "baz.proto";
1411
1412 // qux.proto
1413 import "foo.proto";
1414 // Stuff defined in bar.proto may be used in this file, but stuff from
1415 // baz.proto may NOT be used without importing it explicitly.
1416 This is useful for moving proto files. To move a proto file, just leave
1417 a single "import public" in the old proto file.
1418 * New enum option "allow_alias" that specifies whether different symbols can
1419 be assigned the same numeric value. Default value is "true". Setting it to
1420 false causes the compiler to reject enum definitions where multiple symbols
1421 have the same numeric value.
xiaofeng@google.com7f4c9e82013-03-05 01:51:21 +00001422 Note: We plan to flip the default value to "false" in a future release.
1423 Projects using enum aliases should set the option to "true" in their .proto
1424 files.
xiaofeng@google.comb55a20f2012-09-22 02:40:50 +00001425
1426 C++
1427 * New generated method set_allocated_foo(Type* foo) for message and string
1428 fields. This method allows you to set the field to a pre-allocated object
1429 and the containing message takes the ownership of that object.
1430 * Added SetAllocatedExtension() and ReleaseExtension() to extensions API.
1431 * Custom options are now formatted correctly when descriptors are printed in
1432 text format.
1433 * Various speed optimizations.
1434
1435 Java
1436 * Comments in proto files are now collected and put into generated code as
1437 comments for corresponding classes and data members.
1438 * Added Parser to parse directly into messages without a Builder. For
1439 example,
xiaofeng@google.com2c9392f2013-02-28 06:12:28 +00001440 Foo foo = Foo.PARSER.ParseFrom(input);
xiaofeng@google.comb55a20f2012-09-22 02:40:50 +00001441 Using Parser is ~25% faster than using Builder to parse messages.
1442 * Added getters/setters to access the underlying ByteString of a string field
1443 directly.
1444 * ByteString now supports more operations: substring(), prepend(), and
1445 append(). The implementation of ByteString uses a binary tree structure
1446 to support these operations efficiently.
1447 * New method findInitializationErrors() that lists all missing required
1448 fields.
1449 * Various code size and speed optimizations.
1450
1451 Python
1452 * Added support for dynamic message creation. DescriptorDatabase,
Dongjoon Hyun7b08d492016-01-11 14:52:01 -08001453 DescriptorPool, and MessageFactory work like their C++ counterparts to
xiaofeng@google.comb55a20f2012-09-22 02:40:50 +00001454 simplify Descriptor construction from *DescriptorProtos, and MessageFactory
1455 provides a message instance from a Descriptor.
1456 * Added pickle support for protobuf messages.
1457 * Unknown fields are now preserved after parsing.
1458 * Fixed bug where custom options were not correctly populated. Custom
1459 options can be accessed now.
1460 * Added EnumTypeWrapper that provides better accessibility to enum types.
1461 * Added ParseMessage(descriptor, bytes) to generate a new Message instance
1462 from a descriptor and a byte string.
1463
liujisi@google.com5d996322011-04-30 15:29:09 +000014642011-05-01 version 2.4.1:
1465
1466 C++
Dongjoon Hyun7b08d492016-01-11 14:52:01 -08001467 * Fixed the friendship problem for old compilers to make the library now gcc 3
liujisi@google.com5d996322011-04-30 15:29:09 +00001468 compatible again.
1469 * Fixed vcprojects/extract_includes.bat to extract compiler/plugin.h.
1470
1471 Java
1472 * Removed usages of JDK 1.6 only features to make the library now JDK 1.5
1473 compatible again.
1474 * Fixed a bug about negative enum values.
1475 * serialVersionUID is now defined in generated messages for java serializing.
1476 * Fixed protoc to use java.lang.Object, which makes "Object" now a valid
1477 message name again.
1478
1479 Python
1480 * Experimental C++ implementation now requires C++ protobuf library installed.
1481 See the README.txt in the python directory for details.
1482
liujisi@google.com7a261472011-02-02 14:04:22 +000014832011-02-02 version 2.4.0:
liujisi@google.com33165fe2010-11-02 13:14:58 +00001484
1485 General
1486 * The RPC (cc|java|py)_generic_services default value is now false instead of
1487 true.
1488 * Custom options can have aggregate types. For example,
1489 message MyOption {
1490 optional string comment = 1;
1491 optional string author = 2;
1492 }
1493 extend google.protobuf.FieldOptions {
1494 optional MyOption myoption = 12345;
1495 }
1496 This option can now be set as follows:
1497 message SomeType {
1498 optional int32 field = 1 [(myoption) = { comment:'x' author:'y' }];
1499 }
1500
1501 C++
1502 * Various speed and code size optimizations.
1503 * Added a release_foo() method on string and message fields.
1504 * Fixed gzip_output_stream sub-stream handling.
1505
1506 Java
1507 * Builders now maintain sub-builders for sub-messages. Use getFooBuilder() to
1508 get the builder for the sub-message "foo". This allows you to repeatedly
1509 modify deeply-nested sub-messages without rebuilding them.
1510 * Builder.build() no longer invalidates the Builder for generated messages
1511 (You may continue to modify it and then build another message).
1512 * Code generator will generate efficient equals() and hashCode()
1513 implementations if new option java_generate_equals_and_hash is enabled.
1514 (Otherwise, reflection-based implementations are used.)
1515 * Generated messages now implement Serializable.
1516 * Fields with [deprecated=true] will be marked with @Deprecated in Java.
1517 * Added lazy conversion of UTF-8 encoded strings to String objects to improve
1518 performance.
1519 * Various optimizations.
1520 * Enum value can be accessed directly, instead of calling getNumber() on the
1521 enum member.
1522 * For each enum value, an integer constant is also generated with the suffix
1523 _VALUE.
1524
1525 Python
1526 * Added an experimental C++ implementation for Python messages via a Python
1527 extension. Implementation type is controlled by an environment variable
1528 PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION (valid values: "cpp" and "python")
1529 The default value is currently "python" but will be changed to "cpp" in
1530 future release.
1531 * Improved performance on message instantiation significantly.
1532 Most of the work on message instantiation is done just once per message
1533 class, instead of once per message instance.
1534 * Improved performance on text message parsing.
1535 * Allow add() to forward keyword arguments to the concrete class.
1536 E.g. instead of
1537 item = repeated_field.add()
1538 item.foo = bar
1539 item.baz = quux
1540 You can do:
1541 repeated_field.add(foo=bar, baz=quux)
1542 * Added a sort() interface to the BaseContainer.
1543 * Added an extend() method to repeated composite fields.
1544 * Added UTF8 debug string support.
1545
temporald4e38c72010-01-09 07:35:50 +000015462010-01-08 version 2.3.0:
kenton@google.comfccb1462009-12-18 02:11:36 +00001547
1548 General
1549 * Parsers for repeated numeric fields now always accept both packed and
1550 unpacked input. The [packed=true] option only affects serializers.
1551 Therefore, it is possible to switch a field to packed format without
1552 breaking backwards-compatibility -- as long as all parties are using
1553 protobuf 2.3.0 or above, at least.
1554 * The generic RPC service code generated by the C++, Java, and Python
1555 generators can be disabled via file options:
1556 option cc_generic_services = false;
1557 option java_generic_services = false;
1558 option py_generic_services = false;
1559 This allows plugins to generate alternative code, possibly specific to some
1560 particular RPC implementation.
1561
1562 protoc
1563 * Now supports a plugin system for code generators. Plugins can generate
1564 code for new languages or inject additional code into the output of other
1565 code generators. Plugins are just binaries which accept a protocol buffer
1566 on stdin and write a protocol buffer to stdout, so they may be written in
1567 any language. See src/google/protobuf/compiler/plugin.proto.
kenton@google.com7f4938b2009-12-22 22:57:39 +00001568 **WARNING**: Plugins are experimental. The interface may change in a
1569 future version.
kenton@google.com0225b352010-01-04 22:07:09 +00001570 * If the output location ends in .zip or .jar, protoc will write its output
1571 to a zip/jar archive instead of a directory. For example:
1572 protoc --java_out=myproto_srcs.jar --python_out=myproto.zip myproto.proto
1573 Currently the archive contents are not compressed, though this could change
1574 in the future.
kenton@google.comfccb1462009-12-18 02:11:36 +00001575 * inf, -inf, and nan can now be used as default values for float and double
1576 fields.
1577
1578 C++
1579 * Various speed and code size optimizations.
1580 * DynamicMessageFactory is now fully thread-safe.
1581 * Message::Utf8DebugString() method is like DebugString() but avoids escaping
1582 UTF-8 bytes.
1583 * Compiled-in message types can now contain dynamic extensions, through use
1584 of CodedInputStream::SetExtensionRegistry().
kenton@google.comc0ee4d22009-12-22 02:05:33 +00001585 * Now compiles shared libraries (DLLs) by default on Cygwin and MinGW, to
1586 match other platforms. Use --disable-shared to avoid this.
kenton@google.comfccb1462009-12-18 02:11:36 +00001587
1588 Java
1589 * parseDelimitedFrom() and mergeDelimitedFrom() now detect EOF and return
1590 false/null instead of throwing an exception.
1591 * Fixed some initialization ordering bugs.
1592 * Fixes for OpenJDK 7.
1593
1594 Python
1595 * 10-25 times faster than 2.2.0, still pure-Python.
1596 * Calling a mutating method on a sub-message always instantiates the message
1597 in its parent even if the mutating method doesn't actually mutate anything
1598 (e.g. parsing from an empty string).
1599 * Expanded descriptors a bit.
1600
kenton@google.com201b9be2009-08-12 00:23:05 +000016012009-08-11 version 2.2.0:
kenton@google.comceb561d2009-06-25 19:05:36 +00001602
1603 C++
kenton@google.com80b1d622009-07-29 01:13:20 +00001604 * Lite mode: The "optimize_for = LITE_RUNTIME" option causes the compiler
1605 to generate code which only depends libprotobuf-lite, which is much smaller
1606 than libprotobuf but lacks descriptors, reflection, and some other features.
kenton@google.comceb561d2009-06-25 19:05:36 +00001607 * Fixed bug where Message.Swap(Message) was only implemented for
1608 optimize_for_speed. Swap now properly implemented in both modes
1609 (Issue 91).
1610 * Added RemoveLast and SwapElements(index1, index2) to Reflection
1611 interface for repeated elements.
1612 * Added Swap(Message) to Reflection interface.
kenton@google.comd2fd0632009-07-24 01:00:35 +00001613 * Floating-point literals in generated code that are intended to be
1614 single-precision now explicitly have 'f' suffix to avoid pedantic warnings
1615 produced by some compilers.
kenton@google.com80b1d622009-07-29 01:13:20 +00001616 * The [deprecated=true] option now causes the C++ code generator to generate
1617 a GCC-style deprecation annotation (no-op on other compilers).
1618 * google::protobuf::GetEnumDescriptor<SomeGeneratedEnumType>() returns the
1619 EnumDescriptor for that type -- useful for templates which cannot call
1620 SomeGeneratedEnumType_descriptor().
1621 * Various optimizations and obscure bug fixes.
1622
1623 Java
1624 * Lite mode: The "optimize_for = LITE_RUNTIME" option causes the compiler
1625 to generate code which only depends libprotobuf-lite, which is much smaller
1626 than libprotobuf but lacks descriptors, reflection, and some other features.
kenton@google.com80b1d622009-07-29 01:13:20 +00001627 * Lots of style cleanups.
1628
1629 Python
1630 * Fixed endianness bug with floats and doubles.
1631 * Text format parsing support.
1632 * Fix bug with parsing packed repeated fields in embedded messages.
1633 * Ability to initialize fields by passing keyword args to constructor.
1634 * Support iterators in extend and __setslice__ for containers.
kenton@google.comceb561d2009-06-25 19:05:36 +00001635
kenton@google.com1fb3d392009-05-13 23:20:03 +000016362009-05-13 version 2.1.0:
kenton@google.com2d6daa72009-01-22 01:27:00 +00001637
1638 General
1639 * Repeated fields of primitive types (types other that string, group, and
1640 nested messages) may now use the option [packed = true] to get a more
1641 efficient encoding. In the new encoding, the entire list is written
1642 as a single byte blob using the "length-delimited" wire type. Within
1643 this blob, the individual values are encoded the same way they would
1644 be normally except without a tag before each value (thus, they are
1645 tightly "packed").
kenton@google.comcfa2d8a2009-04-18 00:02:12 +00001646 * For each field, the generated code contains an integer constant assigned
1647 to the field number. For example, the .proto file:
1648 message Foo { optional int bar_baz = 123; }
1649 would generate the following constants, all with the integer value 123:
1650 C++: Foo::kBarBazFieldNumber
1651 Java: Foo.BAR_BAZ_FIELD_NUMBER
1652 Python: Foo.BAR_BAZ_FIELD_NUMBER
1653 Constants are also generated for extensions, with the same naming scheme.
1654 These constants may be used as switch cases.
kenton@google.com37ad00d2009-04-21 21:00:39 +00001655 * Updated bundled Google Test to version 1.3.0. Google Test is now bundled
1656 in its verbatim form as a nested autoconf package, so you can drop in any
1657 other version of Google Test if needed.
kenton@google.comd37d46d2009-04-25 02:53:47 +00001658 * optimize_for = SPEED is now the default, by popular demand. Use
1659 optimize_for = CODE_SIZE if code size is more important in your app.
1660 * It is now an error to define a default value for a repeated field.
1661 Previously, this was silently ignored (it had no effect on the generated
1662 code).
1663 * Fields can now be marked deprecated like:
1664 optional int32 foo = 1 [deprecated = true];
1665 Currently this does not have any actual effect, but in the future the code
1666 generators may generate deprecation annotations in each language.
kenton@google.com9824eda2009-05-06 17:49:37 +00001667 * Cross-compiling should now be possible using the --with-protoc option to
1668 configure. See README.txt for more info.
kenton@google.com2d6daa72009-01-22 01:27:00 +00001669
kenton@google.comf663b162009-04-15 19:50:54 +00001670 protoc
1671 * --error_format=msvs option causes errors to be printed in Visual Studio
1672 format, which should allow them to be clicked on in the build log to go
kenton@google.comd37d46d2009-04-25 02:53:47 +00001673 directly to the error location.
1674 * The type name resolver will no longer resolve type names to fields. For
1675 example, this now works:
1676 message Foo {}
1677 message Bar {
1678 optional int32 Foo = 1;
1679 optional Foo baz = 2;
1680 }
1681 Previously, the type of "baz" would resolve to "Bar.Foo", and you'd get
1682 an error because Bar.Foo is a field, not a type. Now the type of "baz"
1683 resolves to the message type Foo. This change is unlikely to make a
1684 difference to anyone who follows the Protocol Buffers style guide.
kenton@google.comf663b162009-04-15 19:50:54 +00001685
kenton@google.com2d6daa72009-01-22 01:27:00 +00001686 C++
kenton@google.comd37d46d2009-04-25 02:53:47 +00001687 * Several optimizations, including but not limited to:
1688 - Serialization, especially to flat arrays, is 10%-50% faster, possibly
1689 more for small objects.
1690 - Several descriptor operations which previously required locking no longer
1691 do.
1692 - Descriptors are now constructed lazily on first use, rather than at
1693 process startup time. This should save memory in programs which do not
1694 use descriptors or reflection.
1695 - UnknownFieldSet completely redesigned to be more efficient (especially in
1696 terms of memory usage).
1697 - Various optimizations to reduce code size (though the serialization speed
1698 optimizations increased code size).
kenton@google.com2d6daa72009-01-22 01:27:00 +00001699 * Message interface has method ParseFromBoundedZeroCopyStream() which parses
1700 a limited number of bytes from an input stream rather than parsing until
1701 EOF.
kenton@google.come59427a2009-04-16 22:30:56 +00001702 * GzipInputStream and GzipOutputStream support reading/writing gzip- or
1703 zlib-compressed streams if zlib is available.
1704 (google/protobuf/io/gzip_stream.h)
kenton@google.comd37d46d2009-04-25 02:53:47 +00001705 * DescriptorPool::FindAllExtensions() and corresponding
1706 DescriptorDatabase::FindAllExtensions() can be used to enumerate all
1707 extensions of a given type.
1708 * For each enum type Foo, protoc will generate functions:
1709 const string& Foo_Name(Foo value);
1710 bool Foo_Parse(const string& name, Foo* result);
1711 The former returns the name of the enum constant corresponding to the given
1712 value while the latter finds the value corresponding to a name.
1713 * RepeatedField and RepeatedPtrField now have back-insertion iterators.
1714 * String fields now have setters that take a char* and a size, in addition
1715 to the existing ones that took char* or const string&.
1716 * DescriptorPool::AllowUnknownDependencies() may be used to tell
1717 DescriptorPool to create placeholder descriptors for unknown entities
1718 referenced in a FileDescriptorProto. This can allow you to parse a .proto
1719 file without having access to other .proto files that it imports, for
1720 example.
1721 * Updated gtest to latest version. The gtest package is now included as a
1722 nested autoconf package, so it should be able to drop new versions into the
1723 "gtest" subdirectory without modification.
kenton@google.com2d6daa72009-01-22 01:27:00 +00001724
1725 Java
1726 * Fixed bug where Message.mergeFrom(Message) failed to merge extensions.
1727 * Message interface has new method toBuilder() which is equivalent to
1728 newBuilderForType().mergeFrom(this).
1729 * All enums now implement the ProtocolMessageEnum interface.
1730 * Setting a field to null now throws NullPointerException.
1731 * Fixed tendency for TextFormat's parsing to overflow the stack when
1732 parsing large string values. The underlying problem is with Java's
1733 regex implementation (which unfortunately uses recursive backtracking
Dongjoon Hyun7b08d492016-01-11 14:52:01 -08001734 rather than building an NFA). Worked around by making use of possessive
kenton@google.com2d6daa72009-01-22 01:27:00 +00001735 quantifiers.
kenton@google.comd37d46d2009-04-25 02:53:47 +00001736 * Generated service classes now also generate pure interfaces. For a service
1737 Foo, Foo.Interface is a pure interface containing all of the service's
1738 defined methods. Foo.newReflectiveService() can be called to wrap an
1739 instance of this interface in a class that implements the generic
1740 RpcService interface, which provides reflection support that is usually
1741 needed by RPC server implementations.
1742 * RPC interfaces now support blocking operation in addition to non-blocking.
1743 The protocol compiler generates separate blocking and non-blocking stubs
1744 which operate against separate blocking and non-blocking RPC interfaces.
1745 RPC implementations will have to implement the new interfaces in order to
1746 support blocking mode.
1747 * New I/O methods parseDelimitedFrom(), mergeDelimitedFrom(), and
Dongjoon Hyun7b08d492016-01-11 14:52:01 -08001748 writeDelimitedTo() read and write "delimited" messages from/to a stream,
kenton@google.comd37d46d2009-04-25 02:53:47 +00001749 meaning that the message size precedes the data. This way, you can write
1750 multiple messages to a stream without having to worry about delimiting
1751 them yourself.
1752 * Throw a more descriptive exception when build() is double-called.
1753 * Add a method to query whether CodedInputStream is at the end of the input
1754 stream.
1755 * Add a method to reset a CodedInputStream's size counter; useful when
1756 reading many messages with the same stream.
1757 * equals() and hashCode() now account for unknown fields.
pesho.petrov87e64e12008-12-24 01:07:22 +00001758
1759 Python
1760 * Added slicing support for repeated scalar fields. Added slice retrieval and
1761 removal of repeated composite fields.
kenton@google.com2d6daa72009-01-22 01:27:00 +00001762 * Updated RPC interfaces to allow for blocking operation. A client may
1763 now pass None for a callback when making an RPC, in which case the
1764 call will block until the response is received, and the response
1765 object will be returned directly to the caller. This interface change
1766 cannot be used in practice until RPC implementations are updated to
1767 implement it.
kenton@google.comd37d46d2009-04-25 02:53:47 +00001768 * Changes to input_stream.py should make protobuf compatible with appengine.
pesho.petrov87e64e12008-12-24 01:07:22 +00001769
kenton@google.com9f175282008-11-25 19:37:10 +000017702008-11-25 version 2.0.3:
1771
1772 protoc
1773 * Enum values may now have custom options, using syntax similar to field
1774 options.
1775 * Fixed bug where .proto files which use custom options but don't actually
1776 define them (i.e. they import another .proto file defining the options)
1777 had to explicitly import descriptor.proto.
1778 * Adjacent string literals in .proto files will now be concatenated, like in
1779 C.
kenton@google.com2f669cb2008-12-02 05:59:15 +00001780 * If an input file is a Windows absolute path (e.g. "C:\foo\bar.proto") and
1781 the import path only contains "." (or contains "." but does not contain
1782 the file), protoc incorrectly thought that the file was under ".", because
1783 it thought that the path was relative (since it didn't start with a slash).
1784 This has been fixed.
kenton@google.com9f175282008-11-25 19:37:10 +00001785
1786 C++
1787 * Generated message classes now have a Swap() method which efficiently swaps
1788 the contents of two objects.
1789 * All message classes now have a SpaceUsed() method which returns an estimate
1790 of the number of bytes of allocated memory currently owned by the object.
1791 This is particularly useful when you are reusing a single message object
1792 to improve performance but want to make sure it doesn't bloat up too large.
1793 * New method Message::SerializeAsString() returns a string containing the
1794 serialized data. May be more convenient than calling
1795 SerializeToString(string*).
1796 * In debug mode, log error messages when string-type fields are found to
1797 contain bytes that are not valid UTF-8.
1798 * Fixed bug where a message with multiple extension ranges couldn't parse
1799 extensions.
1800 * Fixed bug where MergeFrom(const Message&) didn't do anything if invoked on
1801 a message that contained no fields (but possibly contained extensions).
1802 * Fixed ShortDebugString() to not be O(n^2). Durr.
1803 * Fixed crash in TextFormat parsing if the first token in the input caused a
1804 tokenization error.
1805 * Fixed obscure bugs in zero_copy_stream_impl.cc.
1806 * Added support for HP C++ on Tru64.
1807 * Only build tests on "make check", not "make".
1808 * Fixed alignment issue that caused crashes when using DynamicMessage on
1809 64-bit Sparc machines.
1810 * Simplify template usage to work with MSVC 2003.
1811 * Work around GCC 4.3.x x86_64 compiler bug that caused crashes on startup.
1812 (This affected Fedora 9 in particular.)
kenton@google.com25bc5cd2008-12-04 20:34:50 +00001813 * Now works on "Solaris 10 using recent Sun Studio".
kenton@google.com9f175282008-11-25 19:37:10 +00001814
1815 Java
1816 * New overload of mergeFrom() which parses a slice of a byte array instead
1817 of the whole thing.
1818 * New method ByteString.asReadOnlyByteBuffer() does what it sounds like.
1819 * Improved performance of isInitialized() when optimizing for code size.
1820
1821 Python
1822 * Corrected ListFields() signature in Message base class to match what
1823 subclasses actually implement.
1824 * Some minor refactoring.
kenton@google.com2f669cb2008-12-02 05:59:15 +00001825 * Don't pass self as first argument to superclass constructor (no longer
1826 allowed in Python 2.6).
kenton@google.com9f175282008-11-25 19:37:10 +00001827
kenton@google.com9b10f582008-09-30 00:09:40 +000018282008-09-29 version 2.0.2:
1829
kenton@google.com24bf56f2008-09-24 20:31:01 +00001830 General
Sebastian Schuberth902af082017-02-28 09:58:24 +01001831 * License changed from Apache 2.0 to 3-Clause BSD.
kenton@google.com24bf56f2008-09-24 20:31:01 +00001832 * It is now possible to define custom "options", which are basically
1833 annotations which may be placed on definitions in a .proto file.
1834 For example, you might define a field option called "foo" like so:
1835 import "google/protobuf/descriptor.proto"
1836 extend google.protobuf.FieldOptions {
1837 optional string foo = 12345;
1838 }
1839 Then you annotate a field using the "foo" option:
1840 message MyMessage {
1841 optional int32 some_field = 1 [(foo) = "bar"]
1842 }
1843 The value of this option is then visible via the message's
1844 Descriptor:
1845 const FieldDescriptor* field =
1846 MyMessage::descriptor()->FindFieldByName("some_field");
1847 assert(field->options().GetExtension(foo) == "bar");
1848 This feature has been implemented and tested in C++ and Java.
1849 Other languages may or may not need to do extra work to support
1850 custom options, depending on how they construct descriptors.
1851
1852 C++
1853 * Fixed some GCC warnings that only occur when using -pedantic.
1854 * Improved static initialization code, making ordering more
1855 predictable among other things.
1856 * TextFormat will no longer accept messages which contain multiple
1857 instances of a singular field. Previously, the latter instance
kenton@google.com9b10f582008-09-30 00:09:40 +00001858 would overwrite the former.
kenton@google.com24bf56f2008-09-24 20:31:01 +00001859 * Now works on systems that don't have hash_map.
1860
kenton@google.com9b10f582008-09-30 00:09:40 +00001861 Java
1862 * Print @Override annotation in generated code where appropriate.
1863
kenton@google.com24bf56f2008-09-24 20:31:01 +00001864 Python
1865 * Strings now use the "unicode" type rather than the "str" type.
1866 String fields may still be assigned ASCII "str" values; they will
1867 automatically be converted.
1868 * Adding a property to an object representing a repeated field now
1869 raises an exception. For example:
1870 # No longer works (and never should have).
1871 message.some_repeated_field.foo = 1
kenton@google.com9b10f582008-09-30 00:09:40 +00001872
1873 Windows
1874 * We now build static libraries rather than DLLs by default on MSVC.
1875 See vsprojects/readme.txt for more information.
1876
temporala44f3c32008-08-15 18:32:02 +000018772008-08-15 version 2.0.1:
kenton@google.com9b10f582008-09-30 00:09:40 +00001878
1879 protoc
1880 * New flags --encode and --decode can be used to convert between protobuf text
1881 format and binary format from the command-line.
1882 * New flag --descriptor_set_out can be used to write FileDescriptorProtos for
1883 all parsed files directly into a single output file. This is particularly
1884 useful if you wish to parse .proto files from programs written in languages
1885 other than C++: just run protoc as a background process and have it output
1886 a FileDescriptorList, then parse that natively.
1887 * Improved error message when an enum value's name conflicts with another
1888 symbol defined in the enum type's scope, e.g. if two enum types declared
1889 in the same scope have values with the same name. This is disallowed for
temporala44f3c32008-08-15 18:32:02 +00001890 compatibility with C++, but this wasn't clear from the error.
kenton@google.com9b10f582008-09-30 00:09:40 +00001891 * Fixed absolute output paths on Windows.
temporala44f3c32008-08-15 18:32:02 +00001892 * Allow trailing slashes in --proto_path mappings.
kenton@google.com9b10f582008-09-30 00:09:40 +00001893
1894 C++
1895 * Reflection objects are now per-class rather than per-instance. To make this
1896 possible, the Reflection interface had to be changed such that all methods
1897 take the Message instance as a parameter. This change improves performance
1898 significantly in memory-bandwidth-limited use cases, since it makes the
1899 message objects smaller. Note that source-incompatible interface changes
1900 like this will not be made again after the library leaves beta.
temporala44f3c32008-08-15 18:32:02 +00001901 * Heuristically detect sub-messages when printing unknown fields.
kenton@google.com9b10f582008-09-30 00:09:40 +00001902 * Fix static initialization ordering bug that caused crashes at startup when
temporala44f3c32008-08-15 18:32:02 +00001903 compiling on Mac with static linking.
kenton@google.com9b10f582008-09-30 00:09:40 +00001904 * Fixed TokenizerTest when compiling with -DNDEBUG on Linux.
1905 * Fixed incorrect definition of kint32min.
temporala44f3c32008-08-15 18:32:02 +00001906 * Fix bytes type setter to work with byte sequences with embedded NULLs.
1907 * Other irrelevant tweaks.
1908
kenton@google.com9b10f582008-09-30 00:09:40 +00001909 Java
1910 * Fixed UnknownFieldSet's parsing of varints larger than 32 bits.
1911 * Fixed TextFormat's parsing of "inf" and "nan".
1912 * Fixed TextFormat's parsing of comments.
1913 * Added info to Java POM that will be required when we upload the
temporala44f3c32008-08-15 18:32:02 +00001914 package to a Maven repo.
1915
kenton@google.com9b10f582008-09-30 00:09:40 +00001916 Python
1917 * MergeFrom(message) and CopyFrom(message) are now implemented.
1918 * SerializeToString() raises an exception if the message is missing required
1919 fields.
1920 * Code organization improvements.
1921 * Fixed doc comments for RpcController and RpcChannel, which had somehow been
temporala44f3c32008-08-15 18:32:02 +00001922 swapped.
kenton@google.com9b10f582008-09-30 00:09:40 +00001923 * Fixed text_format_test on Windows where floating-point exponents sometimes
1924 contain extra zeros.
temporala44f3c32008-08-15 18:32:02 +00001925 * Fix Python service CallMethod() implementation.
1926
1927 Other
1928 * Improved readmes.
1929 * VIM syntax highlighting improvements.
1930
temporal40ee5512008-07-10 02:12:20 +000019312008-07-07 version 2.0.0:
1932
1933 * First public release.