summaryrefslogtreecommitdiffstats
path: root/toolkit/components/protobuf/README.txt
blob: 6eafe257f71aae836e9256f97d91ffb287a9e7e1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
Protocol Buffers (protobuf) source is available at:

    https://github.com/google/protobuf

This code is covered under the BSD license (see COPYING.txt). Documentation is
available at https://developers.google.com/protocol-buffers/.

The tree's current version of the protobuf library is 3.4.1.

We do not include the protobuf tests or the protoc compiler.

--------------------------------------------------------------------------------

# Upgrading the Protobuf Library

1. Get a new protobuf release from https://github.com/google/protobuf/releases

2. Run `$ ./toolkit/components/protobuf/upgrade_protobuf.sh ~/path/to/release/checkout/of/protobuf`.

3. Update the moz.build to export the new set of headers and add any new .cc
   files to the unified sources and remove old ones. Note that we only
   need:
   - files contained in the `libprotobuf_lite_la_SOURCES` target
   (https://github.com/google/protobuf/blob/master/src/Makefile.am)
   - the header files they need
   - gzip streams (for devtools)

4. Re-generate all .pb.cc and .pb.h files using `$ ./toolkit/components/protobuf/regenerate_cpp_files.sh`.