resetting manifest requested domain to floor
[platform/upstream/ccache.git] / NEWS.txt
1 ccache news
2 ===========
3
4
5 ccache 3.1.6
6 ------------
7 Release date: 2011-08-21
8
9
10 New features and improvements
11 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12
13     - Rewrite argument to --sysroot if CCACHE_BASEDIR is used.
14
15
16 Bug fixes
17 ~~~~~~~~~
18
19     - Don't crash if getcwd() fails.
20     - Fixed alignment of "called for preprocessing" counter.
21
22
23 ccache 3.1.5
24 ------------
25 Release date: 2011-05-29
26
27
28 New features and improvements
29 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
30
31     - Added a new statistics counter named ``called for preprocessing''.
32     - The original command line is now logged to the file specified with
33       `CCACHE_LOGFILE`.
34     - Improved error logging when system calls fail.
35     - Added support for rewriting absolute paths in `-F`/`-iframework` GCC
36       options.
37     - Improved order of statistics counters in `ccache -s` output.
38
39
40 Bug fixes
41 ~~~~~~~~~
42
43     - The `-MF`/`-MT`/`-MQ` options with concatenated argument are now handled
44       correctly when they are last on the command line.
45     - ccache is now bug compatible with GCC for the `-MT`/`-MQ` options with
46       concatenated arguments.
47     - Fixed a minor memory leak.
48     - Systems that lack (and don't need to be linked with) libm are now
49       supported.
50
51
52 ccache 3.1.4
53 ------------
54 Release date: 2011-01-09
55
56
57 Bug fixes
58 ~~~~~~~~~
59
60     - Made a work-around for a bug in gzputc() in zlib 1.2.5.
61
62     - Corrupt manifest files are now removed so that they won't block direct
63       mode hits.
64
65     - ccache now copes with file systems that don't know about symbolic links.
66
67     - The file handle in now correctly closed on write error when trying to
68       create a cache dir tag.
69
70
71 ccache 3.1.3
72 ------------
73 Release date: 2010-11-28
74
75
76 Bug fixes
77 ~~~~~~~~~
78
79     - The -MFarg, -MTarg and -MQarg compiler options (i.e, without space
80       between option and argument) are now handled correctly.
81
82
83 Other
84 ~~~~~
85
86     - Portability fixes for HP-UX 11.00 and other esoteric systems.
87
88
89 ccache 3.1.2
90 ------------
91 Release date: 2010-11-21
92
93
94 Bug fixes
95 ~~~~~~~~~
96
97     - Bail out on too hard compiler options `-fdump-*`.
98
99     - NULL return values from malloc/calloc of zero bytes are now handled
100       correctly.
101
102     - Fixed issue when parsing precompiler output on AIX.
103
104
105 Other
106 ~~~~~
107
108     - Improved documentation on which information is included in the hash sum.
109
110     - Made the ``too new header file'' test case work on file systems with
111       unsynchronized clocks.
112
113     - The test suite now also works on systems that lack a /dev/zero.
114
115
116 ccache 3.1.1
117 ------------
118 Release date: 2010-11-07
119
120
121 Bug fixes
122 ~~~~~~~~~
123
124     - ccache now falls back to preprocessor mode when a non-regular include
125       file (device, socket, etc) has been detected so that potential hanging
126       due to blocking reads is avoided.
127
128     - CRC errors are now detected when decompressing compressed files in the
129       cache.
130
131     - Fixed potential object file corruption race on NFS.
132
133     - Minor documentation corrections.
134
135     - Fixed configure detection of ar.
136
137     - ccache development version (set by dev.mk) now works with gits whose
138       `describe` command doesn't understand `--dirty`.
139
140
141 Other
142 ~~~~~
143
144     - Minor debug log message improvements.
145
146
147 ccache 3.1
148 ----------
149 Release date: 2010-09-16
150
151 New features and improvements
152 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
153
154     - Added support for hashing the output of a custom command (e.g.
155       `%compiler% --version`) to identify the compiler instead of stat-ing or
156       hashing the compiler binary. This can improve robustness when the
157       compiler (as seen by ccache) actually isn't the real compiler but another
158       compiler wrapper.
159
160     - Added support for caching compilations that use precompiled headers. (See
161       the manual for important instructions regarding this.)
162
163     - Locking of the files containing statistics counters is now done using
164       symlinks instead of POSIX locks. This should make ccache behave a lot
165       better on file systems where POSIX locks are slow or broken (e.g. NFS on
166       some systems).
167
168     - Manifest files are now updated without the need of taking locks.
169
170     - Updates of statistics counters are now always done in one of the
171       sub-level statistics files. This reduces lock contention, which
172       especially improves performance on slow NFS mounts.
173
174     - Reading and writing of statistics counters has been made
175       forward-compatible (unknown counters are retained).
176
177     - Files are now read without using mmap(). This has two benefits: it's more
178       robust against file changes during reading and it improves performance on
179       poor systems where mmap() doesn't use the disk cache.
180
181     - Added `.cp` and `.CP` as known C++ suffixes.
182
183     - Improved logging.
184
185     - Added `-install_name` as an option known to take an argument. (This
186       improves statistics when using the Darwin linker.)
187
188
189 Bug fixes
190 ~~~~~~~~~
191
192     - Non-fatal error messages are now never printed to stderr but logged
193       instead.
194
195     - Fixed a bug affecting failing commands when `--ccache-skip` is used.
196
197     - Made `--ccache-skip` work for all options.
198
199     - EINTR is now handled correctly.
200
201
202 Other
203 ~~~~~
204
205     - Work on porting ccache to win32 (native), mostly done by Ramiro Polla.
206       The port is not yet finished, but will hopefully be complete in some
207       subsequent release.
208
209     - Added a `--nostats` flag to the performance benchmark program.
210
211     - Made the performance benchmark program more accurate when measuring cache
212       hits.
213
214     - Added a new test framework for unit tests written in C.
215
216     - Got rid of `configure-dev`; dev mode is now given by `dev.mk.in`
217       presence.
218
219     - Improved documentation on how to combine ccache with other compiler
220       wrappers (like `distcc`).
221
222     - New `LICENSE.txt` file with licensing and copyright details about bundled
223       source code.
224
225     - New `AUTHORS.txt` file with a list of ccache contributors.
226
227     - New `HACKING.txt` file with some notes about ccache code conventions.
228
229
230 ccache 3.0.1
231 ------------
232 Release date: 2010-07-15
233
234 Bug fixes
235 ~~~~~~~~~
236
237     - The statistics counter ``called for link'' is now correctly updated when
238       linking with a single object file.
239     - Fixed a problem with out-of-source builds.
240
241
242 ccache 3.0
243 ----------
244 Release date: 2010-06-20
245
246 General
247 ~~~~~~~
248
249     - ccache is now licensed under the GNU General Public License (GPL) version
250       3 or later.
251
252
253 Upgrade notes
254 ~~~~~~~~~~~~~
255
256     - The way the hashes are calculated has changed, so you won't get cache
257       hits for compilation results stored by older ccache versions. Because of
258       this, you might as well clear the old cache directory with `ccache
259       --clear` if you want, unless you plan to keep using an older ccache
260       version.
261
262
263 New features and improvements
264 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
265
266     - ccache now has a ``direct mode'' where it computes a hash of the source
267       code (including all included files) and compiler options without
268       running the preprocessor. By not running the preprocessor, CPU usage is
269       reduced; the speed is somewhere between 1 and 5 times that of ccache
270       running in traditional mode, depending on the circumstances. The speedup
271       will be higher when I/O is fast (e.g., when files are in the disk cache).
272       The direct mode can be disabled by setting +CCACHE_NODIRECT+.
273
274     - Support has been added for rewriting absolute paths to relative paths
275       when hashing, in order to increase cache hit rate when building the same
276       source code in different directories even when compiling with `-g` and
277       when using absolute include directory paths. This is done by setting the
278       `CCACHE_BASEDIR` environment variable to an absolute path that specifies
279       which paths to rewrite.
280
281     - Object files are now optionally stored compressed in the cache. The
282       runtime cost is negligible, and more files will fit in the ccache
283       directory and in the disk cache. Set `CCACHE_COMPRESS` to enable object
284       file compression. Note that you can't use compression in combination with
285       the hard link feature.
286
287     - A `CCACHE_COMPILERCHECK` option has been added. This option tells ccache
288       what compiler-identifying information to hash to ensure that results
289       retrieved from the cache are accurate. Possible values are: none (don't
290       hash anything), mtime (hash the compiler's mtime and size) and content
291       (hash the content of the compiler binary). The default is mtime.
292
293     - It is now possible to specify extra files whose contents should be
294       included in the hash sum by setting the `CCACHE_EXTRAFILES` option.
295
296     - Added support for Objective-C and Objective-C\+\+. The statistics counter
297       ``not a C/C++ file'' has been renamed to ``unsupported source language''.
298
299     - Added support for the `-x` compiler option.
300
301     - Added support for long command-line options.
302
303     - A `CACHEDIR.TAG` file is now created in the cache directory. See
304       <http://www.brynosaurus.com/cachedir/>.
305
306     - Messages printed to the debug log (specified by `CCACHE_LOGFILE`) have
307       been improved.
308
309     - You can relax some checks that ccache does in direct mode by setting
310       `CCACHE_SLOPPINESS`. See the manual for more information.
311
312     - `CCACHE_TEMPDIR` no longer needs to be on the same filesystem as
313       `CCACHE_DIR`.
314
315     - The default value of `CCACHE_TEMPDIR` has been changed to
316       `$CCACHE_DIR/tmp` to avoid cluttering the top directory.
317
318     - Temporary files that later will be moved into the cache are now created
319       in the cache directory they will end up in. This makes ccache more
320       friendly to Linux's directory layout.
321
322     - Improved the test suite and added tests for most of the new
323       functionality. It's now also possible to specify a subset of tests to
324       run.
325
326     - Standard error output from the compiler is now only stored in the cache
327       if it's non-empty.
328
329     - If the compiler produces no object file or an empty object file, but
330       gives a zero exit status (could be due to a file system problem, a buggy
331       program specified by `CCACHE_PREFIX`, etc.), ccache copes with it
332       properly.
333
334     - Added `installcheck` and `distcheck` make targets.
335
336     - Clarified cache size limit options' and cleanup semantics.
337
338     - Improved display of cache max size values.
339
340     - The following options are no longer hashed in the preprocessor mode:
341       `-imacros`, `-imultilib`, `-iprefix`, `-iquote`, `-isysroot`,
342       `-iwithprefix`, `-iwithprefixbefore`, `-nostdinc`, `-nostdinc++` and
343       `-U`.
344
345
346 Bug fixes
347 ~~~~~~~~~
348
349     - Various portability improvements.
350
351     - Improved detection of home directory.
352
353     - User-defined `CPPFLAGS` and `LDFLAGS` are now respected in the Makefile.
354
355     - Fixed NFS issues.
356
357     - Computation of the hash sum has been improved to decrease the risk of
358       hash collisions. For instance, the compiler options `-X -Y` and `-X-Y`
359       previously contributed equally to the hash sum.
360
361     - Bail out on too hard compiler options `--coverage`, `-fprofile-arcs`,
362       `-fprofile-generate`, `-fprofile-use`, `-frepo`, `-ftest-coverage` and
363       `-save-temps`. Also bail out on `@file` style options.
364
365     - Errors when using multiple `-arch` compiler options are now noted as
366       ``unsupported compiler option''.
367
368     - `-MD`/`-MMD` options without `-MT`/`-MF` are now handled correctly.
369
370     - The `-finput-charset` option is now handled correctly.
371
372     - Added support for `-Wp,-MD` and `-Wp,-MMD` options.
373
374     - The compiler options `-Xassembler`, `-b`, `-G` and `-V` are now correctly
375       recognized as taking an argument.
376
377     - Debug information containing line numbers of predefined and command-line
378       macros (enabled with the compiler option `-g3`) will now be correct.
379
380     - Corrected LRU cleanup handling of object files.
381
382     - `utimes()` is now used instead of `utime()` when available.
383
384     - Non-writable cache directories are now handled gracefully.
385
386     - Corrected documentation about sharing the cache directory.
387
388     - Fixed compilation warnings from GCC 4.3.
389
390     - The command specified by `CCACHE_PREFIX` is no longer part of the hash.
391
392     - Fixed bad memory access spotted by Valgrind.
393
394     - Fixed a bug in `x_realloc`.
395
396     - Freed memory is no longer referenced when compiling a `.i`/`.ii` file and
397       falling back to running the real compiler.
398
399     - The test suite is now immune to external values of the `CCACHE_*`
400       environment variables.
401
402     - Improved detection of recursive invocation.
403
404     - The ccache binary is now not unconditionally stripped when installing.
405
406     - Statistics counters are now correctly updated for -E option failures and
407       internal errors.