summaryrefslogtreecommitdiffstats
path: root/other-licenses/snappy/README
blob: 194f1cc835a5f8603f29aade4e56c8910e22cfe1 (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
29
30
See src/README for the README that ships with snappy.

Mozilla does not modify the actual snappy source with the exception of the
'snappy-stubs-public.h' header and one small patch to resolve implicit
constructor warnings. We have replaced its build system with our own.

Snappy comes from:
  https://github.com/google/snappy

We are currently using revision: 1.2.0

To upgrade to a newer version:
  1. Check out the new code using git.
  2. Update 'snappy-stubs-public.h' in this directory with any changes that were
     made to 'snappy-stubs-public.h.in' in the new source. Note that we don't
     bother trying to detect the availability of sys/uio.h and unconditionally
     define the iovec type instead for all platforms.
  3. Copy the major/minor/patch versions from 'CMakeLists.txt' into
     'snappy-stubs-public.h'.
  4. Copy all source files from the new version into the src subdirectory. The
     following are not needed:
       - 'CMakeLists.txt', 'snappy_benchmark.cc', 'snappy_test_data.cc',
         'snappy_test_data.h', and 'snappy_test_tool.cc' files
       - 'cmake' subdirectory
       - 'docs' subdirectory
       - 'testdata' subdirectory
       - 'third_party' subdirectory
  5. Update the revision stamp in this file.
  6. Apply 01-explicit.patch.