summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoel Rosdahl <joel@rosdahl.net>2021-07-26 10:23:25 +0200
committerJoel Rosdahl <joel@rosdahl.net>2021-07-26 13:38:58 +0200
commit63239e95632fb51795f0bac5f9d3c46c849e6f5d (patch)
treebaaac70e7c51a501c6ef1a62865aeed58c8e6adf
parent5f39e40328c6bd75d6bb86f7fdcde6aa70db7611 (diff)
downloadccache-63239e95632fb51795f0bac5f9d3c46c849e6f5d.tar.gz
Use Asciidoctor instead of Asciidoc to render documentation
Asciidoctor seems to: - Provide a nice left-hand side table of contents. - Have nicer looking defaults. - Be faster. - Have less (but non-zero) quirks.
-rw-r--r--.github/workflows/build.yaml6
-rw-r--r--doc/AUTHORS.adoc3
-rw-r--r--doc/CMakeLists.txt87
-rw-r--r--doc/INSTALL.md7
-rw-r--r--doc/MANUAL.adoc483
-rw-r--r--doc/NEWS.adoc869
-rw-r--r--dockerfiles/centos-7/Dockerfile4
-rw-r--r--dockerfiles/centos-8/Dockerfile2
-rw-r--r--dockerfiles/debian-10/Dockerfile1
-rw-r--r--dockerfiles/debian-11/Dockerfile1
-rw-r--r--dockerfiles/ubuntu-18.04/Dockerfile3
-rw-r--r--dockerfiles/ubuntu-20.04/Dockerfile3
12 files changed, 678 insertions, 791 deletions
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
index dce8f351..ac155e24 100644
--- a/.github/workflows/build.yaml
+++ b/.github/workflows/build.yaml
@@ -248,19 +248,19 @@ jobs:
CC: gcc
CXX: g++
SPECIAL: build-and-verify-source-package
- apt_get: elfutils libzstd-dev pkg-config libhiredis-dev ninja-build asciidoc xsltproc docbook-xml docbook-xsl
+ apt_get: elfutils libzstd-dev pkg-config libhiredis-dev ninja-build asciidoctor
- name: HTML documentation
os: ubuntu-18.04
EXTRA_CMAKE_BUILD_FLAGS: --target doc-html
RUN_TESTS: none
- apt_get: libzstd-dev pkg-config libhiredis-dev asciidoc docbook-xml docbook-xsl
+ apt_get: libzstd-dev pkg-config libhiredis-dev asciidoctor
- name: Manual page
os: ubuntu-18.04
EXTRA_CMAKE_BUILD_FLAGS: --target doc-man-page
RUN_TESTS: none
- apt_get: libzstd-dev pkg-config libhiredis-dev asciidoc xsltproc docbook-xml docbook-xsl
+ apt_get: libzstd-dev pkg-config libhiredis-dev asciidoctor
- name: Clang-Tidy
os: ubuntu-18.04
diff --git a/doc/AUTHORS.adoc b/doc/AUTHORS.adoc
index 2a8363a9..c14ee84e 100644
--- a/doc/AUTHORS.adoc
+++ b/doc/AUTHORS.adoc
@@ -1,5 +1,4 @@
-Ccache authors
-==============
+= Ccache authors
Ccache was originally written by Andrew Tridgell and is currently developed and
maintained by Joel Rosdahl.
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index c5ce224d..74c7fe2e 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -1,70 +1,51 @@
-find_program(ASCIIDOC_EXE asciidoc)
-mark_as_advanced(ASCIIDOC_EXE) # Don't show in CMake UIs
+find_program(ASCIIDOCTOR_EXE asciidoctor)
+mark_as_advanced(ASCIIDOCTOR_EXE) # Don't show in CMake UIs
-if(NOT ASCIIDOC_EXE)
- message(WARNING "Could not find asciidoc; documentation will not be generated")
+if(NOT ASCIIDOCTOR_EXE)
+ message(WARNING "Could not find asciidoctor; documentation will not be generated")
else()
- #
- # HTML documentation
- #
- function(generate_html adoc_file)
+ function(generate_doc backend adoc_file output_file)
get_filename_component(base_name "${adoc_file}" NAME_WE)
- set(html_file "${base_name}.html")
add_custom_command(
- OUTPUT "${html_file}"
+ OUTPUT "${output_file}"
COMMAND
- ${ASCIIDOC_EXE}
- -o "${html_file}"
+ ${ASCIIDOCTOR_EXE}
+ -o "${output_file}"
-a revnumber="${CCACHE_VERSION}"
- -a toc
- -b xhtml11
+ -a toc=left
+ -a sectanchors
+ -b "${backend}"
"${CMAKE_SOURCE_DIR}/${adoc_file}"
MAIN_DEPENDENCY "${CMAKE_SOURCE_DIR}/${adoc_file}"
)
- set(html_files "${html_files}" "${html_file}" PARENT_SCOPE)
+ set(doc_files "${doc_files}" "${output_file}" PARENT_SCOPE)
endfunction()
- generate_html(LICENSE.adoc)
- generate_html(doc/AUTHORS.adoc)
- generate_html(doc/MANUAL.adoc)
- generate_html(doc/NEWS.adoc)
-
- add_custom_target(doc-html DEPENDS "${html_files}")
- set(doc_files "${html_files}")
+ #
+ # HTML documentation
+ #
+ generate_doc(html LICENSE.adoc LICENSE.html)
+ generate_doc(html doc/AUTHORS.adoc AUTHORS.html)
+ generate_doc(html doc/MANUAL.adoc MANUAL.html)
+ generate_doc(html doc/NEWS.adoc NEWS.html)
+ add_custom_target(doc-html DEPENDS "${doc_files}")
#
# Man page
#
- find_program(A2X_EXE a2x)
- mark_as_advanced(A2X_EXE) # Don't show in CMake UIs
- if(NOT A2X_EXE)
- message(WARNING "Could not find a2x; man page will not be generated")
- else()
- # MANUAL.adoc -> MANUAL.xml -> man page
- add_custom_command(
- OUTPUT MANUAL.xml
- COMMAND
- ${ASCIIDOC_EXE}
- -o -
- -a revnumber=${CCACHE_VERSION}
- -d manpage
- -b docbook "${CMAKE_SOURCE_DIR}/doc/MANUAL.adoc"
- | perl -pe 's!<literal>\(.*?\)</literal>!<emphasis role="strong">\\1</emphasis>!g'
- >MANUAL.xml
- MAIN_DEPENDENCY "${CMAKE_SOURCE_DIR}/doc/MANUAL.adoc"
- )
- add_custom_command(
- OUTPUT ccache.1
- COMMAND ${A2X_EXE} --doctype manpage --format manpage MANUAL.xml
- MAIN_DEPENDENCY MANUAL.xml
- )
- add_custom_target(doc-man-page DEPENDS ccache.1)
- install(
- FILES "${CMAKE_CURRENT_BINARY_DIR}/ccache.1"
- DESTINATION "${CMAKE_INSTALL_MANDIR}/man1"
- )
- set(doc_files "${doc_files}" ccache.1)
- endif()
+ generate_doc(manpage doc/MANUAL.adoc ccache.1.tmp)
+ add_custom_command(
+ OUTPUT ccache.1
+ # Convert monospace to bold since that's typically rendered better when
+ # viewing the man page.
+ COMMAND perl -pe "'s!\\\\f\\(CR(.*?)\\\\fP!\\\\fB\\1\\\\fP!g'" ccache.1.tmp >ccache.1
+ MAIN_DEPENDENCY ccache.1.tmp
+ )
+ install(
+ FILES "${CMAKE_CURRENT_BINARY_DIR}/ccache.1"
+ DESTINATION "${CMAKE_INSTALL_MANDIR}/man1"
+ )
+ add_custom_target(doc-man-page DEPENDS ccache.1)
- add_custom_target(doc ALL DEPENDS "${doc_files}")
+ add_custom_target(doc ALL DEPENDS doc-html doc-man-page)
endif()
diff --git a/doc/INSTALL.md b/doc/INSTALL.md
index 4391ffaf..27e928c2 100644
--- a/doc/INSTALL.md
+++ b/doc/INSTALL.md
@@ -38,12 +38,7 @@ Optional:
To link libhiredis statically you can use
`-DHIREDIS_LIBRARY=/path/to/libhiredis.a`.
- GNU Bourne Again SHell (bash) for tests.
-- [AsciiDoc](https://www.methods.co.nz/asciidoc/) to build the HTML
- documentation.
- - Tip: On Debian-based systems (e.g. Ubuntu), install the `docbook-xml` and
- `docbook-xsl` packages in addition to `asciidoc`. Without the former the
- man page generation will be very slow.
-- [xsltproc](http://xmlsoft.org/XSLT/xsltproc2.html) to build the man page.
+- [Asciidoctor](https://asciidoctor.org) to build the HTML documentation.
- [Python](https://www.python.org) to debug and run the performance test suite.
diff --git a/doc/MANUAL.adoc b/doc/MANUAL.adoc
index e52c974b..1bcb8b80 100644
--- a/doc/MANUAL.adoc
+++ b/doc/MANUAL.adoc
@@ -1,8 +1,5 @@
-= CCACHE(1)
-:man source: ccache
-:man version: {revnumber}
-:man manual: ccache Manual
-
+= ccache(1)
+:mansource: Ccache {revnumber}
== Name
@@ -33,13 +30,13 @@ where ccache changes the output of your compiler, please let us know.
== Run modes
There are two ways to use ccache. You can either prefix your compilation
-commands with *ccache* or you can let ccache masquerade as the compiler by
+commands with `ccache` or you can let ccache masquerade as the compiler by
creating a symbolic link (named as the compiler) to ccache. The first method is
most convenient if you just want to try out ccache or wish to use it for some
specific projects. The second method is most useful for when you wish to use
ccache for all your compilations.
-To use the first method, just make sure that *ccache* is in your *PATH*.
+To use the first method, just make sure that `ccache` is in your `PATH`.
To use the symlinks method, do something like this:
@@ -53,7 +50,7 @@ ln -s ccache /usr/local/bin/c++
And so forth. This will work as long as the directory with symlinks comes
before the path to the compiler (which is usually in `/usr/bin`). After
-installing you may wish to run ``which gcc'' to make sure that the correct link
+installing you may wish to run "`which gcc`" to make sure that the correct link
is being used.
WARNING: The technique of letting ccache masquerade as the compiler works well,
@@ -65,7 +62,7 @@ WARNING: Use a symbolic links for masquerading, not hard links.
== Command line options
-These command line options only apply when you invoke ccache as ``ccache''.
+These command line options only apply when you invoke ccache as "`ccache`".
When invoked as a compiler (via a symlink as described in the previous
section), the normal compiler options apply and you should refer to the
compiler's documentation.
@@ -73,7 +70,7 @@ compiler's documentation.
=== Common options
-*`-c`*, *`--cleanup`*::
+*-c*, *--cleanup*::
Clean up the cache by removing old cached files until the specified file
number and cache size limits are not exceeded. This also recalculates the
@@ -83,18 +80,18 @@ compiler's documentation.
cleanup is mostly useful if you manually modify the cache contents or
believe that the cache size statistics may be inaccurate.
-*`-C`*, *`--clear`*::
+*-C*, *--clear*::
Clear the entire cache, removing all cached files, but keeping the
configuration file.
-*`--config-path`* _PATH_::
+*--config-path* _PATH_::
Let the subsequent command line options operate on configuration file
_PATH_ instead of the default. Using this option has the same effect as
setting the environment variable `CCACHE_CONFIGPATH` temporarily.
-*`-d`*, *`--directory`* _PATH_::
+*-d*, *--directory* _PATH_::
Let the subsequent command line options operate on cache directory _PATH_
instead of the default. For example, to show statistics for a cache
@@ -102,22 +99,22 @@ compiler's documentation.
Using this option has the same effect as setting the environment variable
`CCACHE_DIR` temporarily.
-*`--evict-older-than`* _AGE_::
+*--evict-older-than* _AGE_::
Remove files older than _AGE_ from the cache. _AGE_ should be an unsigned
integer with a `d` (days) or `s` (seconds) suffix.
-*`-h`*, *`--help`*::
+*-h*, *--help*::
Print a summary of command line options.
-*`-F`* _NUM_, *`--max-files`* _NUM_::
+*-F* _NUM_, *--max-files* _NUM_::
Set the maximum number of files allowed in the cache to _NUM_. Use 0 for no
limit. The value is stored in a configuration file in the cache directory
and applies to all future compilations.
-*`-M`* _SIZE_, *`--max-size`* _SIZE_::
+*-M* _SIZE_, *--max-size* _SIZE_::
Set the maximum size of the files stored in the cache. _SIZE_ should be a
number followed by an optional suffix: k, M, G, T (decimal), Ki, Mi, Gi or
@@ -125,7 +122,7 @@ compiler's documentation.
stored in a configuration file in the cache directory and applies to all
future compilations.
-*`-X`* _LEVEL_, *`--recompress`* _LEVEL_::
+*-X* _LEVEL_, *--recompress* _LEVEL_::
Recompress the cache to level _LEVEL_ using the Zstandard algorithm. The
level can be an integer, with the same semantics as the
@@ -136,77 +133,77 @@ compiler's documentation.
visited. Only files that are currently compressed with a different level
than _LEVEL_ will be recompressed.
-*`-o`* _KEY=VALUE_, *`--set-config`* _KEY_=_VALUE_::
+*-o* _KEY=VALUE_, *--set-config* _KEY_=_VALUE_::
Set configuration option _KEY_ to _VALUE_. See
_<<_configuration,Configuration>>_ for more information.
-*`-x`*, *`--show-compression`*::
+*-x*, *--show-compression*::
Print cache compression statistics. See _<<_cache_compression,Cache
compression>>_ for more information. This can potentionally take a long
time since all files in the cache need to be visited.
-*`-p`*, *`--show-config`*::
+*-p*, *--show-config*::
Print current configuration options and from where they originate
(environment variable, configuration file or compile-time default) in
human-readable format.
-*`--show-log-stats`*::
+*--show-log-stats*::
Print statistics counters from the stats log in human-readable format.
See <<config_stats_log,*stats_log*>>.
-*`-s`*, *`--show-stats`*::
+*-s*, *--show-stats*::
Print a summary of configuration and statistics counters in human-readable
format.
-*`-V`*, *`--version`*::
+*-V*, *--version*::
Print version and copyright information.
-*`-z`*, *`--zero-stats`*::
+*-z*, *--zero-stats*::
Zero the cache statistics (but not the configuration options).
=== Options for scripting or debugging
-*`--checksum-file`* _PATH_::
+*--checksum-file* _PATH_::
Print the checksum (64 bit XXH3) of the file at _PATH_ (`-` for standard
input).
-*`--dump-manifest`* _PATH_::
+*--dump-manifest* _PATH_::
Dump manifest file at _PATH_ (`-` for standard input) in text format to
standard output. This is only useful when debugging ccache and its behavior.
-*`--dump-result`* _PATH_::
+*--dump-result* _PATH_::
Dump result file at _PATH_ (`-` for standard input) in text format to
standard output. This is only useful when debugging ccache and its behavior.
-*`--extract-result`* _PATH_::
+*--extract-result* _PATH_::
Extract data stored in the result file at _PATH_ (`-` for standard input).
- The data will be written to *ccache-result.** files in to the current
+ The data will be written to `ccache-result.*` files in to the current
working directory. This is only useful when debugging ccache and its
behavior.
-*`-k`* _KEY_, *`--get-config`* _KEY_::
+*-k* _KEY_, *--get-config* _KEY_::
Print the value of configuration option _KEY_. See
_<<_configuration,Configuration>>_ for more information.
-*`--hash-file`* _PATH_::
+*--hash-file* _PATH_::
Print the hash (160 bit BLAKE3) of the file at _PATH_ (`-` for standard
input). This is only useful when debugging ccache and its behavior.
-*`--print-stats`*::
+*--print-stats*::
Print statistics counter IDs and corresponding values in machine-parsable
(tab-separated) format.
@@ -217,10 +214,10 @@ compiler's documentation.
When run as a compiler, ccache usually just takes the same command line options
as the compiler you are using. The only exception to this is the option
-*--ccache-skip*. That option can be used to tell ccache to avoid interpreting
+`--ccache-skip`. That option can be used to tell ccache to avoid interpreting
the next option in any way and to pass it along to the compiler as-is.
-NOTE: *--ccache-skip* currently only tells ccache not to interpret the next
+NOTE: `--ccache-skip` currently only tells ccache not to interpret the next
option as a special compiler option -- the option will still be included in the
direct mode hash.
@@ -229,19 +226,19 @@ line and determine what is an input filename and what is a compiler option, as
it needs the input filename to determine the name of the resulting object file
(among other things). The heuristic ccache uses when parsing the command line
is that any argument that exists as a file is treated as an input file name. By
-using *--ccache-skip* you can force an option to not be treated as an input
+using `--ccache-skip` you can force an option to not be treated as an input
file name and instead be passed along to the compiler as a command line option.
-Another case where *--ccache-skip* can be useful is if ccache interprets an
+Another case where `--ccache-skip` can be useful is if ccache interprets an
option specially but shouldn't, since the option has another meaning for your
compiler than what ccache thinks.
== Configuration
-ccache's default behavior can be overridden by options in configuration files,
+Ccache's default behavior can be overridden by options in configuration files,
which in turn can be overridden by environment variables with names starting
-with *CCACHE_*. Ccache normally reads configuration from two files: first a
+with `CCACHE_`. Ccache normally reads configuration from two files: first a
system-level configuration file and secondly a cache-specific configuration
file. The priorities of configuration options are as follows (where 1 is
highest):
@@ -249,11 +246,11 @@ highest):
1. Environment variables.
2. The primary (cache-specific) configuration file (see below).
3. The secondary (system-wide read-only) configuration file
- *_<sysconfdir>_/ccache.conf* (typically */etc/ccache.conf* or
- */usr/local/etc/ccache.conf*).
+ `<sysconfdir>/ccache.conf` (typically `/etc/ccache.conf` or
+ `/usr/local/etc/ccache.conf`).
4. Compile-time defaults.
-As a special case, if the the environment variable *CCACHE_CONFIGPATH* is set
+As a special case, if the the environment variable `CCACHE_CONFIGPATH` is set
it specifies the primary configuration file and the secondary (system-wide)
configuration file won't be read.
@@ -263,23 +260,23 @@ configuration file won't be read.
The location of the primary (cache-specific) configuration is determined like
this:
-1. If *CCACHE_CONFIGPATH* is set, use that path.
-2. Otherwise, if the environment variable *CCACHE_DIR* is set then use
- *$CCACHE_DIR/ccache.conf*.
+1. If `CCACHE_CONFIGPATH` is set, use that path.
+2. Otherwise, if the environment variable `CCACHE_DIR` is set then use
+ `$CCACHE_DIR/ccache.conf`.
3. Otherwise, if <<config_cache_dir,*cache_dir*>> is set in the secondary
- (system-wide) configuration file then use *<cache_dir>/ccache.conf*.
-4. Otherwise, if there is a legacy *$HOME/.ccache* directory then use
- *$HOME/.ccache/ccache.conf*.
-5. Otherwise, if *XDG_CONFIG_HOME* is set then use
- *$XDG_CONFIG_HOME/ccache/ccache.conf*.
-6. Otherwise, use *%APPDATA%/ccache/ccache.conf* (Windows),
- *$HOME/Library/Preferences/ccache/ccache.conf* (macOS) or
- *$HOME/.config/ccache/ccache.conf* (other systems).
+ (system-wide) configuration file then use `<cache_dir>/ccache.conf`.
+4. Otherwise, if there is a legacy `$HOME/.ccache` directory then use
+ `$HOME/.ccache/ccache.conf`.
+5. Otherwise, if `XDG_CONFIG_HOME` is set then use
+ `$XDG_CONFIG_HOME/ccache/ccache.conf`.
+6. Otherwise, use `%APPDATA%/ccache/ccache.conf` (Windows),
+ `$HOME/Library/Preferences/ccache/ccache.conf` (macOS) or
+ `$HOME/.config/ccache/ccache.conf` (other systems).
=== Configuration file syntax
-Configuration files are in a simple ``key = value'' format, one option per
+Configuration files are in a simple "`key = value`" format, one option per
line. Lines starting with a hash sign are comments. Blank lines are ignored, as
is whitespace surrounding keys and values. Example:
@@ -294,14 +291,14 @@ Some configuration options are boolean values (i.e. truth values). In a
configuration file, such values must be set to the string *true* or *false*.
For the corresponding environment variables, the semantics are a bit different:
-* A set environment variable means ``true'' (even if set to the empty string).
+* A set environment variable means "`true`" (even if set to the empty string).
* The following case-insensitive negative values are considered an error
(instead of surprising the user): *0*, *false*, *disable* and *no*.
-* An unset environment variable means ``false''.
+* An unset environment variable means "`false`".
Each boolean environment variable also has a negated form starting with
-*CCACHE_NO*. For example, *CCACHE_COMPRESS* can be set to force compression and
-*CCACHE_NOCOMPRESS* can be set to force no compression.
+`CCACHE_NO`. For example, `CCACHE_COMPRESS` can be set to force compression and
+`CCACHE_NOCOMPRESS` can be set to force no compression.
=== Configuration options
@@ -378,15 +375,15 @@ project2 will be a different absolute path.
[[config_cache_dir]] *cache_dir* (*CCACHE_DIR*)::
This option specifies where ccache will keep its cached compiler outputs.
- The default is *$XDG_CACHE_HOME/ccache* if *XDG_CACHE_HOME* is set,
- otherwise *$HOME/.cache/ccache*. Exception: If the legacy directory
- *$HOME/.ccache* exists then that directory is the default.
+ The default is `$XDG_CACHE_HOME/ccache` if `XDG_CACHE_HOME` is set,
+ otherwise `$HOME/.cache/ccache`. Exception: If the legacy directory
+ `$HOME/.ccache` exists then that directory is the default.
+
See also _<<_location_of_the_primary_configuration_file,Location of the primary
configuration file>>_.
+
-If you want to use another *CCACHE_DIR* value temporarily for one ccache
-invocation you can use the `-d/--directory` command line option instead.
+If you want to use another `CCACHE_DIR` value temporarily for one ccache
+invocation you can use the `-d`/`--directory` command line option instead.
[[config_compiler]] *compiler* (*CCACHE_COMPILER* or (deprecated) *CCACHE_CC*)::
@@ -396,7 +393,7 @@ invocation you can use the `-d/--directory` command line option instead.
[[config_compiler_check]] *compiler_check* (*CCACHE_COMPILERCHECK*)::
- By default, ccache includes the modification time (``mtime'') and size of
+ By default, ccache includes the modification time ("`mtime`") and size of
the compiler in the hash to ensure that results retrieved from the cache
are accurate. This option can be used to select another strategy. Possible
values are:
@@ -426,22 +423,20 @@ _a command string_::
path to the compiler. Several commands can be specified with semicolon as
separator. Examples:
+
---
-
----
%compiler% -v
----
-
++
----
%compiler% -dumpmachine; %compiler% -dumpversion
----
-
++
You should make sure that the specified command is as fast as possible since it
will be run once for each ccache invocation.
-
++
Identifying the compiler using a command is useful if you want to avoid cache
misses when the compiler has been rebuilt but not changed.
-
++
Another case is when the compiler (as seen by ccache) actually isn't the real
compiler but another compiler wrapper -- in that case, the default *mtime*
method will hash the mtime and size of the other compiler wrapper, which means
@@ -452,7 +447,6 @@ should consider continue using the *mtime* method in combination with the
_<<_using_ccache_with_other_compiler_wrappers,Using ccache with other compiler
wrappers>>_.
--
---
[[config_compiler_type]] *compiler_type* (*CCACHE_COMPILERTYPE*)::
@@ -474,7 +468,7 @@ wrappers>>_.
*other*::
Any compiler other than the known types.
*pump*::
- distcc's "pump" script.
+ distcc's "`pump`" script.
--
[[config_compression]] *compression* (*CCACHE_COMPRESS* or *CCACHE_NOCOMPRESS*, see _<<_boolean_values,Boolean values>>_ above)::
@@ -513,11 +507,11 @@ Semantics of *compression_level*:
essentially the same for all levels. As a rule of thumb, use level 5 or
lower since higher levels may slow down compilations noticeably. Higher
levels are however useful when recompressing the cache with command line
- option *-X/--recompress*.
+ option `-X`/`--recompress`.
*< 0*::
- A negative value corresponds to Zstandard's ``ultra-fast'' compression
+ A negative value corresponds to Zstandard's "`ultra-fast`" compression
levels, which are even faster than level 1 but with less good compression
- ratios. For instance, level *-3* corresponds to ``--fast=3'' for the *zstd*
+ ratios. For instance, level *-3* corresponds to `--fast=3` for the `zstd`
command line tool. In practice, there is little use for levels lower than
*-5* or so.
*0* (default)::
@@ -533,7 +527,7 @@ See the http://zstd.net[Zstandard documentation] for more information.
preprocessed file. The default is to automatically determine the extension
to use for intermediate preprocessor files based on the type of file being
compiled, but that sometimes doesn't work. For example, when using the
- ``aCC'' compiler on HP-UX, set the cpp extension to *i*.
+ "`aCC`" compiler on HP-UX, set the cpp extension to *i*.
[[config_debug]] *debug* (*CCACHE_DEBUG* or *CCACHE_NODEBUG*, see _<<_boolean_values,Boolean values>>_ above)::
@@ -545,8 +539,8 @@ See the http://zstd.net[Zstandard documentation] for more information.
[[config_debug_dir]] *debug_dir* (*CCACHE_DEBUGDIR*)::
- Specifies where to write per-object debug files if the _<<config_debug,debug
- mode>>_ is enabled. If set to the empty string, the files will be written
+ Specifies where to write per-object debug files if the <<config_debug,debug
+ mode>> is enabled. If set to the empty string, the files will be written
next to the object file. If set to a directory, the debug files will be
written with full absolute paths in that directory, creating it if needed.
The default is the empty string.
@@ -579,10 +573,10 @@ _<<_cache_debugging,Cache debugging>>_.
[[config_file_clone]] *file_clone* (*CCACHE_FILECLONE* or *CCACHE_NOFILECLONE*, see _<<_boolean_values,Boolean values>>_ above)::
- If true, ccache will attempt to use file cloning (also known as ``copy on
- write'', ``CoW'' or ``reflinks'') to store and fetch cached compiler results.
- *file_clone* has priority over <<config_hard_link,*hard_link*>>. The
- default is false.
+ If true, ccache will attempt to use file cloning (also known as "`copy on
+ write`", "`CoW`" or "`reflinks`") to store and fetch cached compiler
+ results. *file_clone* has priority over <<config_hard_link,*hard_link*>>.
+ The default is false.
+
Files stored by cloning cannot be compressed, so the cache size will likely be
significantly larger if this option is enabled. However, performance may be
@@ -614,23 +608,23 @@ WARNING: Do not enable this option unless you are aware of these caveats:
file size will not.
* Programs that don't expect that files from two different identical
compilations are hard links to each other can fail.
-* Programs that rely on modification times (like ``make'') can be confused if
+* Programs that rely on modification times (like `make`) can be confused if
several users (or one user with several build trees) use the same cache
directory. The reason for this is that the object files share i-nodes and
- therefore modification times. If *file.o* is in build tree A (hard-linked
- from the cache) and *file.o* then is produced by ccache in build tree B by
+ therefore modification times. If `file.o` is in build tree *A* (hard-linked
+ from the cache) and `file.o` then is produced by ccache in build tree *B* by
hard-linking from the cache, the modification timestamp will be updated for
- *file.o* in build tree A as well. This can retrigger relinking in build tree
- A even though nothing really has changed.
+ `file.o` in build tree *A* as well. This can retrigger relinking in build tree
+ *A* even though nothing really has changed.
[[config_hash_dir]] *hash_dir* (*CCACHE_HASHDIR* or *CCACHE_NOHASHDIR*, see _<<_boolean_values,Boolean values>>_ above)::
If true (which is the default), ccache will include the current working
directory (CWD) in the hash that is used to distinguish two compilations
- when generating debug info (compiler option *-g* with variations).
+ when generating debug info (compiler option `-g` with variations).
Exception: The CWD will not be included in the hash if
<<config_base_dir,*base_dir*>> is set (and matches the CWD) and the
- compiler option *-fdebug-prefix-map* is used. See also the discussion under
+ compiler option `-fdebug-prefix-map` is used. See also the discussion under
_<<_compiling_in_different_directories,Compiling in different
directories>>_.
+
@@ -658,7 +652,7 @@ might be incorrect.
useful when you know it doesn't affect the result (but ccache doesn't know
that), or when it does and you don't care. If a compiler option in the list
is suffixed with an asterisk (`*`) it will be matched as a prefix. For
- example, `-fmessage-length=*` will match both `-fmessage-length=20` and
+ example, `+-fmessage-length=*+` will match both `-fmessage-length=20` and
`-fmessage-length=70`.
[[config_inode_cache]] *inode_cache* (*CCACHE_INODECACHE* or *CCACHE_NOINODECACHE*, see _<<_boolean_values,Boolean values>>_ above)::
@@ -675,7 +669,7 @@ The feature requires *temporary_dir* to be located on a local filesystem.
[[config_keep_comments_cpp]] *keep_comments_cpp* (*CCACHE_COMMENTS* or *CCACHE_NOCOMMENTS*, see _<<_boolean_values,Boolean values>>_ above)::
If true, ccache will not discard the comments before hashing preprocessor
- output. This can be used to check documentation with *-Wdocumentation*.
+ output. This can be used to check documentation with `-Wdocumentation`.
[[config_limit_multiple]] *limit_multiple* (*CCACHE_LIMIT_MULTIPLE*)::
@@ -717,14 +711,14 @@ file in `/etc/rsyslog.d`:
If set, ccache will search directories in this list when looking for the
real compiler. The list separator is semicolon on Windows systems and colon
on other systems. If not set, ccache will look for the first executable
- matching the compiler name in the normal *PATH* that isn't a symbolic link
+ matching the compiler name in the normal `PATH` that isn't a symbolic link
to ccache itself.
[[config_pch_external_checksum]] *pch_external_checksum* (*CCACHE_PCH_EXTSUM* or *CCACHE_NOPCH_EXTSUM*, see _<<_boolean_values,Boolean values>>_ above)::
When this option is set, and ccache finds a precompiled header file,
- ccache will look for a file with the extension ``.sum'' added
- (e.g. ``pre.h.gch.sum''), and if found, it will hash this file instead
+ ccache will look for a file with the extension "`.sum`" added
+ (e.g. "`pre.h.gch.sum`"), and if found, it will hash this file instead
of the precompiled header itself to work around the performance
penalty of hashing very large files.
@@ -779,7 +773,7 @@ compilers won't produce the same result (for instance diagnostics warnings)
when compiling preprocessed source code.
+
A solution to the above mentioned downside is to set *run_second_cpp* to false
-and pass *-fdirectives-only* (for GCC) or *-frewrite-includes* (for Clang) to
+and pass `-fdirectives-only` (for GCC) or `-frewrite-includes` (for Clang) to
the compiler. This will cause the compiler to leave the macros and other
preprocessor information, and only process the *#include* directives. When run
in this way, the preprocessor arguments will be passed to the compiler since it
@@ -794,10 +788,10 @@ still has to do _some_ preprocessing (like macros).
+
Examples:
+
-* `file:/shared/nfs/directory`
-* `file:///shared/nfs/one|read-only file:///shared/nfs/two`
-* `http://example.com/cache`
-* `redis://example.com`
+* `+file:/shared/nfs/directory+`
+* `+file:///shared/nfs/one|read-only file:///shared/nfs/two+`
+* `+http://example.com/cache+`
+* `+redis://example.com+`
[[config_sloppiness]] *sloppiness* (*CCACHE_SLOPPINESS*)::
@@ -810,7 +804,7 @@ Examples:
+
--
*clang_index_store*::
- Ignore the Clang compiler option *-index-store-path* and its argument when
+ Ignore the Clang compiler option `-index-store-path` and its argument when
computing the manifest hash. This is useful if you use Xcode, which uses an
index store path derived from the local project path. Note that the index
store won't be updated correctly on cache hits if you enable this
@@ -833,19 +827,19 @@ Examples:
_<<_handling_of_newly_created_header_files,Handling of newly created header
files>>_.
*ivfsoverlay*::
- Ignore the Clang compiler option *-ivfsoverlay* and its argument. This is
+ Ignore the Clang compiler option `-ivfsoverlay` and its argument. This is
useful if you use Xcode, which uses a virtual file system (VFS) for things
like combining Objective-C and Swift code.
*locale*::
- Ccache includes the environment variables *LANG*, *LC_ALL*, *LC_CTYPE* and
- *LC_MESSAGES* in the hash by default since they may affect localization of
+ Ccache includes the environment variables `LANG`, `LC_ALL`, `LC_CTYPE` and
+ `LC_MESSAGES` in the hash by default since they may affect localization of
compiler warning messages. Set this sloppiness to tell ccache not to do
that.
*pch_defines*::
- Be sloppy about **#define**s when precompiling a header file. See
+ Be sloppy about `#define` directives when precompiling a header file. See
_<<_precompiled_headers,Precompiled headers>>_ for more information.
*modules*::
- By default, ccache will not cache compilations if *-fmodules* is used since
+ By default, ccache will not cache compilations if `-fmodules` is used since
it cannot hash the state of compiler's internal representation of relevant
modules. This sloppiness allows caching in such a case. See
_<<_c_modules,C++ modules>>_ for more information.
@@ -854,7 +848,7 @@ Examples:
With this sloppiness set, ccache will only include system headers in the
hash but not add the system header files to the list of include files.
*time_macros*::
- Ignore `__DATE__`, `__TIME__` and `__TIMESTAMP__` being present in the
+ Ignore `+__DATE__+`, `+__TIME__+` and `+__TIMESTAMP__+` being present in the
source code.
--
+
@@ -877,11 +871,11 @@ NOTE: Lines in the stats log starting with a hash sign (`#`) are comments.
[[config_temporary_dir]] *temporary_dir* (*CCACHE_TEMPDIR*)::
This option specifies where ccache will put temporary files. The default is
- */run/user/<UID>/ccache-tmp* if */run/user/<UID>* exists, otherwise
- *<cache_dir>/tmp*.
+ `/run/user/<UID>/ccache-tmp` if `/run/user/<UID>` exists, otherwise
+ `<cache_dir>/tmp`.
+
NOTE: In previous versions of ccache, *CCACHE_TEMPDIR* had to be on the same
-filesystem as the *CCACHE_DIR* path, but this requirement has been relaxed.)
+filesystem as the `CCACHE_DIR` path, but this requirement has been relaxed.
[[config_umask]] *umask* (*CCACHE_UMASK*)::
@@ -913,7 +907,7 @@ These are the available backends:
=== File storage backend
-URL format: `file:DIRECTORY` or `file://DIRECTORY`
+URL format: `+file:DIRECTORY+` or `+file://DIRECTORY+`
This backend stores data as separate files in a directory structure below
*DIRECTORY* (an absolute path), similar (but not identical) to the primary cache
@@ -923,8 +917,8 @@ has to be done by other means.
Examples:
-* `file:/shared/nfs/directory`
-* `file:///shared/nfs/directory|umask=002|update-mtime=true`
+* `+file:/shared/nfs/directory+`
+* `+file:///shared/nfs/directory|umask=002|update-mtime=true+`
Optional attributes:
@@ -935,7 +929,7 @@ Optional attributes:
=== HTTP storage backend
-URL format: `http://HOST[:PORT][/PATH]`
+URL format: `+http://HOST[:PORT][/PATH]+`
This backend stores data in an HTTP-compatible server. The required HTTP methods
are `GET`, `PUT` and `DELETE`.
@@ -944,8 +938,8 @@ Note that ccache will not perform any cleanup of the HTTP storage.
Examples:
-* `http://localhost:8080/`
-* `http://someusername:p4ssw0rd@example.com/cache`
+* `+http://localhost:8080/+`
+* `+http://someusername:p4ssw0rd@example.com/cache+`
Optional attributes:
@@ -958,7 +952,7 @@ Known issues and limitations:
=== Redis storage backend
-URL format: `redis://[[USERNAME:]PASSWORD@]HOST[:PORT][/DBNUMBER]`
+URL format: `+redis://[[USERNAME:]PASSWORD@]HOST[:PORT][/DBNUMBER]+`
This backend stores data in a https://redis.io[Redis] (or Redis-compatible)
server. There are implementations for both memory-based and disk-based storage.
@@ -969,8 +963,8 @@ https://redis.io/topics/lru-cache[configure LRU eviction].
Examples:
-* `redis://localhost`
-* `redis://p4ssw0rd@cache.example.com:6379/0|connect-timeout=50`
+* `+redis://localhost+`
+* `+redis://p4ssw0rd@cache.example.com:6379/0|connect-timeout=50+`
Optional attributes:
@@ -981,9 +975,9 @@ Optional attributes:
By default, ccache has a 5 GB limit on the total size of files in the cache and
no limit on the number of files. You can set different limits using the command
-line options *-M*/*--max-size* and *-F*/*--max-files*. Use *ccache
--s/--show-stats* to see the cache size and the currently configured limits (in
-addition to other various statistics).
+line options `-M`/`--max-size` and `-F`/`--max-files`. Use the
+`-s`/`--show-stats` option to see the cache size and the currently configured
+limits (in addition to other various statistics).
Cleanup can be triggered in two different ways: automatic and manual.
@@ -1019,7 +1013,7 @@ idea to trigger it often, like after each cache miss.
=== Manual cleanup
-You can run *ccache -c/--cleanup* to force cleanup of the whole cache, i.e. all
+You can run `ccache -c/--cleanup` to force cleanup of the whole cache, i.e. all
of the sixteen subdirectories. This will recalculate the statistics counters
and make sure that the configuration options *max_size* and
<<config_max_files,*max_files*>> are not exceeded. Note that
@@ -1038,7 +1032,7 @@ course is redundant. See the documentation for the configuration options
<<config_compression,*compression*>> and
<<config_compression_level,*compression_level*>> for more information.
-You can use the command line option *-x/--show-compression* to print
+You can use the command line option `-x`/`--show-compression` to print
information related to compression. Example:
-------------------------------------------------------------------------------
@@ -1051,11 +1045,11 @@ Incompressible data: 3.5 GB
Notes:
-* The ``disk blocks'' size is the cache size when taking disk block size into
- account. This value should match the ``cache size'' value from ``ccache
- --show-stats''. The other size numbers refer to actual content sizes.
-* ``Compressed data'' refers to result and manifest files stored in the cache.
-* ``Incompressible data'' refers to files that are always stored uncompressed
+* The "`disk blocks`" size is the cache size when taking disk block size into
+ account. This value should match the "`cache size`" value from "`ccache
+ --show-stats`". The other size numbers refer to actual content sizes.
+* "`Compressed data`" refers to result and manifest files stored in the cache.
+* "`Incompressible data`" refers to files that are always stored uncompressed
(triggered by enabling <<config_file_clone,*file_clone*>> or
<<config_hard_link,*hard_link*>>) or unknown files (for instance files
created by older ccache versions).
@@ -1063,7 +1057,7 @@ Notes:
<<config_compression_level,*compression_level*>>.
The cache data can also be recompressed to another compression level (or made
-uncompressed) with the command line option *-X/--recompress*. If you choose to
+uncompressed) with the command line option `-X`/`--recompress`. If you choose to
disable compression by default or to use a low compression level, you can
(re)compress newly cached data with a higher compression level after the build
or at another time when there are more CPU cycles available, for instance every
@@ -1074,11 +1068,12 @@ recompressed.
== Cache statistics
-*ccache -s/--show-stats* can show the following statistics:
+`ccache -s` can show the following statistics:
[options="header",cols="30%,70%"]
|==============================================================================
-|Name | Description
+| *Name* | *Description*
+
| autoconf compile/link |
Uncachable compilation or linking by an autoconf test.
@@ -1107,7 +1102,7 @@ Current size of the cache.
| called for link |
The compiler was called for linking, not compiling. Ccache only supports
-compilation of a single file, i.e. calling the compiler with the *-c* option to
+compilation of a single file, i.e. calling the compiler with the `-c` option to
produce a single object file from a single source file.
| called for preprocessing |
@@ -1125,7 +1120,7 @@ Unexpected failure, e.g. due to problems reading/writing the cache.
| cleanups performed |
Number of cleanups performed, either implicitly due to the cache size limit
-being reached or due to explicit *ccache -c/--cleanup* calls.
+being reached or due to explicit `ccache -c` calls.
| compile failed |
The compilation failed. No result stored in the cache.
@@ -1164,31 +1159,31 @@ supported by ccache.
No input file was specified to the compiler.
| output to a non-regular file |
-The output path specified with *-o* is not a file (e.g. a directory or a device
+The output path specified with `-o` is not a file (e.g. a directory or a device
node).
| output to stdout |
-The compiler was instructed to write its output to standard output using *-o
--*. This is not supported by ccache.
+The compiler was instructed to write its output to standard output using `-o -`.
+This is not supported by ccache.
| preprocessor error |
-Preprocessing the source code using the compiler's *-E* option failed.
+Preprocessing the source code using the compiler's `-E` option failed.
| stats updated |
When statistics were updated the last time.
| stats zeroed |
-When *ccache -z* was called the last time.
+When `ccache -z` was called the last time.
| unsupported code directive |
-Code like the assembler *.incbin* directive was found. This is not supported
+Code like the assembler `.incbin` directive was found. This is not supported
by ccache.
| unsupported compiler option |
A compiler option not supported by ccache was found.
| unsupported source language |
-A source language e.g. specified with *-x* was unsupported by ccache.
+A source language e.g. specified with `-x` was unsupported by ccache.
|==============================================================================
@@ -1228,7 +1223,7 @@ below.
The following information is always included in the hash:
* the extension used by the compiler for a file with preprocessor output
- (normally *.i* for C code and *.ii* for C++ code)
+ (normally `.i` for C code and `.ii` for C++ code)
* the compiler's size and modification time (or other compiler-specific
information specified by <<config_compiler_check,*compiler_check*>>)
* the name of the compiler
@@ -1241,9 +1236,9 @@ The following information is always included in the hash:
In the preprocessor mode, the hash is formed of the common information and:
-* the preprocessor output from running the compiler with *-E*
-* the command line options except those that affect include files (*-I*,
- *-include*, *-D*, etc; the theory is that these command line options will
+* the preprocessor output from running the compiler with `-E`
+* the command line options except those that affect include files (`-I`,
+ `-include`, `-D`, etc; the theory is that these command line options will
change the preprocessor output if they have any effect at all)
* any standard error output generated by the preprocessor
@@ -1258,7 +1253,7 @@ In the direct mode, the hash is formed of the common information and:
* the input source file
* the compiler options
-Based on the hash, a data structure called ``manifest'' is looked up in the
+Based on the hash, a data structure called "`manifest`" is looked up in the
cache. The manifest contains:
* references to cached compilation results (object file, dependency file, etc)
@@ -1289,10 +1284,10 @@ The direct mode will be disabled if any of the following holds:
* a modification time of one of the include files is too new (needed to avoid a
race condition)
* a compiler option not supported by the direct mode is used:
-** a *-Wp,_X_* compiler option other than *-Wp,-MD,_path_*,
- *-Wp,-MMD,_path_* and *-Wp,-D_define_*
-** *-Xpreprocessor*
-* the string `__TIME__` is present in the source code
+** a `-Wp,++*++` compiler option other than `-Wp,-MD,<path>`, `-Wp,-MMD,<path>`
+ and `-Wp,-D<define>`
+** `-Xpreprocessor`
+* the string `+__TIME__+` is present in the source code
=== The depend mode
@@ -1300,7 +1295,7 @@ The direct mode will be disabled if any of the following holds:
If the depend mode is enabled, ccache will not use the preprocessor at all. The
hash used to identify results in the cache will be based on the direct mode
hash described above plus information about include files read from the
-dependency file generated by the compiler with *-MD* or *-MMD*.
+dependency file generated by the compiler with `-MD` or `-MMD`.
Advantages:
@@ -1325,7 +1320,7 @@ The depend mode will be disabled if any of the following holds:
* <<config_depend_mode,*depend_mode*>> is false.
* <<config_run_second_cpp,*run_second_cpp*>> is false.
-* The compiler is not generating dependencies using *-MD* or *-MMD*.
+* The compiler is not generating dependencies using `-MD` or `-MMD`.
== Handling of newly created header files
@@ -1359,7 +1354,7 @@ For reference, the race condition mentioned above consists of these events:
To find out what information ccache actually is hashing, you can enable the
debug mode via the configuration option <<config_debug,*debug*>> or by setting
-*CCACHE_DEBUG* in the environment. This can be useful if you are investigating
+`CCACHE_DEBUG` in the environment. This can be useful if you are investigating
why you don't get cache hits. Note that performance will be reduced slightly.
When the debug mode is enabled, ccache will create up to five additional files
@@ -1367,45 +1362,47 @@ next to the object file:
[options="header",cols="30%,70%"]
|==============================================================================
-|Filename | Description
-| *<objectfile>.ccache-input-c* |
+| *Filename* | *Description*
+
+| `<objectfile>.ccache-input-c` |
Binary input hashed by both the direct mode and the preprocessor mode.
-| *<objectfile>.ccache-input-d* |
+| `<objectfile>.ccache-input-d` |
Binary input only hashed by the direct mode.
-| *<objectfile>.ccache-input-p* |
+| `<objectfile>.ccache-input-p` |
Binary input only hashed by the preprocessor mode.
-| *<objectfile>.ccache-input-text* |
+| `<objectfile>.ccache-input-text` |
Human-readable combined diffable text version of the three files above.
-| *<objectfile>.ccache-log* |
+| `<objectfile>.ccache-log` |
Log for this object file.
|==============================================================================
-If <<config_debug_dir,*config_dir*>> (environment variable *CCACHE_DEBUGDIR*) is
+If <<config_debug_dir,*config_dir*>> (environment variable `CCACHE_DEBUGDIR`) is
set, the files above will be written to that directory with full absolute paths
instead of next to the object file.
In the direct mode, ccache uses the 160 bit BLAKE3 hash of the
-*ccache-input-c* + *ccache-input-d* data (where *+* means concatenation), while
-the *ccache-input-c* + *ccache-input-p* data is used in the preprocessor mode.
+"`ccache-input-c`" + "`ccache-input-d`" data (where *+* means concatenation),
+while the "`ccache-input-c`" + "`ccache-input-p`" data is used in the
+preprocessor mode.
-The *ccache-input-text* file is a combined text version of the three
-binary input files. It has three sections (``COMMON'', ``DIRECT MODE'' and
-``PREPROCESSOR MODE''), which is turn contain annotations that say what kind of
+The "`ccache-input-text`" file is a combined text version of the three binary
+input files. It has three sections ("`COMMON`", "`DIRECT MODE`" and
+"`PREPROCESSOR MODE`"), which is turn contain annotations that say what kind of
data comes next.
To debug why you don't get an expected cache hit for an object file, you can do
something like this:
1. Build with debug mode enabled.
-2. Save the *<objectfile>.ccache-&#42;* files.
+2. Save the `<objectfile>.ccache-++*++` files.
3. Build again with debug mode enabled.
-4. Compare *<objectfile>.ccache-input-text* for the two builds. This together
- with the *<objectfile>.ccache-log* files should give you some clues about
+4. Compare `<objectfile>.ccache-input-text` for the two builds. This together
+ with the `<objectfile>.ccache-log` files should give you some clues about
what is happening.
@@ -1415,12 +1412,12 @@ Some information included in the hash that identifies a unique compilation can
contain absolute paths:
* The preprocessed source code may contain absolute paths to include files if
- the compiler option *-g* is used or if absolute paths are given to *-I* and
+ the compiler option `-g` is used or if absolute paths are given to `-I` and
similar compiler options.
-* Paths specified by compiler options (such as *-I*, *-MF*, etc) on the command
+* Paths specified by compiler options (such as `-I`, `-MF`, etc) on the command
line may be absolute.
* The source code file path may be absolute, and that path may substituted for
- `__FILE__` macros in the source code or included in warnings emitted to
+ `+__FILE__+` macros in the source code or included in warnings emitted to
standard error by the preprocessor.
This means that if you compile the same code in different locations, you can't
@@ -1431,18 +1428,15 @@ hash.
Here's what can be done to enable cache hits between different build
directories:
-* If you build with *-g* (or similar) to add debug information to the object
+* If you build with `-g` (or similar) to add debug information to the object
file, you must either:
-+
---
-** use the compiler option *-fdebug-prefix-map=_old_=_new_* for relocating
- debug info to a common prefix (e.g. *-fdebug-prefix-map=$PWD=.*); or
+** use the compiler option `-fdebug-prefix-map=<old>=<new>` for relocating
+ debug info to a common prefix (e.g. `-fdebug-prefix-map=$PWD=.`); or
** set *hash_dir = false*.
---
* If you use absolute paths anywhere on the command line (e.g. the source code
- file path or an argument to compiler options like *-I* and *-MF*), you must
- set <<config_base_dir,*base_dir*>> to an absolute path to a ``base
- directory''. Ccache will then rewrite absolute paths under that directory to
+ file path or an argument to compiler options like `-I` and `-MF`), you must
+ set <<config_base_dir,*base_dir*>> to an absolute path to a "`base
+ directory`". Ccache will then rewrite absolute paths under that directory to
relative before computing the hash.
@@ -1452,10 +1446,10 @@ Ccache has support for GCC's precompiled headers. However, you have to do some
things to make it work properly:
* You must set <<config_sloppiness,*sloppiness*>> to *pch_defines,time_macros*.
- The reason is that ccache can't tell whether `__TIME__`, `__DATE__` or
- `__TIMESTAMP__` is used when using a precompiled header. Further, it can't
- detect changes in **#define**s in the source code because of how
- preprocessing works in combination with precompiled headers.
+ The reason is that ccache can't tell whether `+__TIME__+`, `+__DATE__+` or
+ `+__TIMESTAMP__+` is used when using a precompiled header. Further, it can't
+ detect changes in ``#define``s in the source code because of how preprocessing
+ works in combination with precompiled headers.
* You may also want to include *include_file_mtime,include_file_ctime* in
<<config_sloppiness,*sloppiness*>>. See
_<<_handling_of_newly_created_header_files,Handling of newly created header
@@ -1463,35 +1457,35 @@ things to make it work properly:
* You must either:
+
--
-** use the compiler option *-include* to include the precompiled header (i.e.,
- don't use *#include* in the source code to include the header; the filename
- itself must be sufficient to find the header, i.e. *-I* paths are not
+* use the compiler option `-include` to include the precompiled header (i.e.,
+ don't use `#include` in the source code to include the header; the filename
+ itself must be sufficient to find the header, i.e. `-I` paths are not
searched); or
-** (for the Clang compiler) use the compiler option *-include-pch* to include
+* (for the Clang compiler) use the compiler option `-include-pch` to include
the PCH file generated from the precompiled header; or
-** (for the GCC compiler) add the compiler option *-fpch-preprocess* when
+* (for the GCC compiler) add the compiler option `-fpch-preprocess` when
compiling.
-
+--
++
If you don't do this, either the non-precompiled version of the header file
will be used (if available) or ccache will fall back to running the real
-compiler and increase the statistics counter ``preprocessor error'' (if the
+compiler and increase the statistics counter "`preprocessor error`" (if the
non-precompiled header file is not available).
---
== C++ modules
-Ccache has support for Clang's *-fmodules* option. In practice ccache only
-additionally hashes *module.modulemap* files; it does not know how Clang
+Ccache has support for Clang's `-fmodules` option. In practice ccache only
+additionally hashes `module.modulemap` files; it does not know how Clang
handles its cached binary form of modules so those are ignored. This should not
-matter in practice: as long as everything else (including *module.modulemap*
+matter in practice: as long as everything else (including `module.modulemap`
files) is the same the cached result should work. Still, you must set
<<config_sloppiness,*sloppiness*>> to *modules* to allow caching.
You must use both <<_the_direct_mode,*direct mode*>> and
<<_the_depend_mode,*depend mode*>>. When using <<_the_preprocessor_mode,the
preprocessor mode>> Clang does not provide enough information to allow hashing
-of *module.modulemap* files.
+of `module.modulemap` files.
== Sharing a cache
@@ -1504,7 +1498,7 @@ conditions should to be met:
* Make sure that the configuration option <<config_hard_link,*hard_link*>> is
false (which is the default).
* Make sure that all users are in the same group.
-* Set the configuration option <<config_umask,*umask*>> to 002. This ensures
+* Set the configuration option <<config_umask,*umask*>> to *002*. This ensures
that cached files are accessible to everyone in the group.
* Make sure that all users have write permission in the entire cache directory
(and that you trust all users of the shared cache).
@@ -1512,11 +1506,9 @@ conditions should to be met:
tells the filesystem to inherit group ownership for new directories. The
following command might be useful for this:
+
---
----
find $CCACHE_DIR -type d | xargs chmod g+s
----
---
The reason to avoid the hard link mode is that the hard links cause unwanted
side effects, as all links to a cached file share the file's modification
@@ -1555,21 +1547,20 @@ An alternative to putting the main cache directory on NFS is to set up a
== Using ccache with other compiler wrappers
The recommended way of combining ccache with another compiler wrapper (such as
-``distcc'') is by letting ccache execute the compiler wrapper. This is
+"`distcc`") is by letting ccache execute the compiler wrapper. This is
accomplished by defining <<config_prefix_command,*prefix_command*>>, for
-example by setting the environment variable *CCACHE_PREFIX* to the name of the
-wrapper (e.g. *distcc*). Ccache will then prefix the command line with the
+example by setting the environment variable `CCACHE_PREFIX` to the name of the
+wrapper (e.g. `distcc`). Ccache will then prefix the command line with the
specified command when running the compiler. To specify several prefix
commands, set <<config_prefix_command,*prefix_command*>> to a colon-separated
list of commands.
Unless you set <<config_compiler_check,*compiler_check*>> to a suitable command
-(see the description of that configuration option), it is not recommended to
-use the form *ccache anotherwrapper compiler args* as the compilation command.
-It's also not recommended to use the masquerading technique for the other
-compiler wrapper. The reason is that by default, ccache will in both cases hash
-the mtime and size of the other wrapper instead of the real compiler, which
-means that:
+(see the description of that configuration option), it is not recommended to use
+the form `ccache anotherwrapper compiler args` as the compilation command. It's
+also not recommended to use the masquerading technique for the other compiler
+wrapper. The reason is that by default, ccache will in both cases hash the mtime
+and size of the other wrapper instead of the real compiler, which means that:
* Compiler upgrades will not be detected properly.
* The cached results will not be shared between compilations with and without
@@ -1579,7 +1570,7 @@ Another minor thing is that if <<config_prefix_command,*prefix_command*>> is
used, ccache will not invoke the other wrapper when running the preprocessor,
which increases performance. You can use
<<config_prefix_command_cpp,*prefix_command_cpp*>> if you also want to invoke
-the other wrapper when doing preprocessing (normally by adding *-E*).
+the other wrapper when doing preprocessing (normally by adding `-E`).
== Caveats
@@ -1609,72 +1600,72 @@ Since ccache works best when I/O is fast, put the cache directory on a fast
storage device if possible. Having lots of free memory so that files in the
cache directory stay in the disk cache is also preferable.
-A good way of monitoring how well ccache works is to run *ccache -s* before and
+A good way of monitoring how well ccache works is to run `ccache -s` before and
after your build and then compare the statistics counters. Here are some common
problems and what may be done to increase the hit rate:
-* If ``cache hit (preprocessed)'' has been incremented instead of ``cache hit
- (direct)'', ccache has fallen back to preprocessor mode, which is generally
+* If "`cache hit (preprocessed)`" has been incremented instead of "`cache hit
+ (direct)`", ccache has fallen back to preprocessor mode, which is generally
slower. Some possible reasons are:
** The source code has been modified in such a way that the preprocessor output
is not affected.
** Compiler arguments that are hashed in the direct mode but not in the
- preprocessor mode have changed (*-I*, *-include*, *-D*, etc) and they didn't
+ preprocessor mode have changed (`-I`, `-include`, `-D`, etc) and they didn't
affect the preprocessor output.
-** The compiler option *-Xpreprocessor* or *-Wp,_X_* (except *-Wp,-MD,_path_*,
- *-Wp,-MMD,_path_*, and *-Wp,-D_define_*) is used.
+** The compiler option `-Xpreprocessor` or `-Wp,++*++` (except `-Wp,-MD,<path>`,
+ `-Wp,-MMD,<path>`, and `-Wp,-D<define>`) is used.
** This was the first compilation with a new value of the
<<config_base_dir,base directory>>.
** A modification or status change time of one of the include files is too new
(created the same second as the compilation is being done). See
_<<_handling_of_newly_created_header_files,Handling of newly created header
files>>_.
-** The `__TIME__` preprocessor macro is (potentially) being used. Ccache turns
- off direct mode if `__TIME__` is present in the source code. This is done as
- a safety measure since the string indicates that a `__TIME__` macro _may_
- affect the output. (To be sure, ccache would have to run the preprocessor,
- but the sole point of the direct mode is to avoid that.) If you know that
- `__TIME__` isn't used in practise, or don't care if ccache produces objects
- where `__TIME__` is expanded to something in the past, you can set
- <<config_sloppiness,*sloppiness*>> to *time_macros*.
-** The `__DATE__` preprocessor macro is (potentially) being used and the date
- has changed. This is similar to how `__TIME__` is handled. If `__DATE__` is
- present in the source code, ccache hashes the current date in order to be
- able to produce the correct object file if the `__DATE__` macro affects the
- output. If you know that `__DATE__` isn't used in practise, or don't care if
- ccache produces objects where `__DATE__` is expanded to something in the
+** The `+__TIME__+` preprocessor macro is (potentially) being used. Ccache turns
+ off direct mode if `+__TIME__+` is present in the source code. This is done
+ as a safety measure since the string indicates that a `+__TIME__+` macro
+ _may_ affect the output. (To be sure, ccache would have to run the
+ preprocessor, but the sole point of the direct mode is to avoid that.) If you
+ know that `+__TIME__+` isn't used in practise, or don't care if ccache
+ produces objects where `+__TIME__+` is expanded to something in the past, you
+ can set <<config_sloppiness,*sloppiness*>> to *time_macros*.
+** The `+__DATE__+` preprocessor macro is (potentially) being used and the date
+ has changed. This is similar to how `+__TIME__+` is handled. If `+__DATE__+`
+ is present in the source code, ccache hashes the current date in order to be
+ able to produce the correct object file if the `+__DATE__+` macro affects the
+ output. If you know that `+__DATE__+` isn't used in practise, or don't care
+ if ccache produces objects where `+__DATE__+` is expanded to something in the
past, you can set <<config_sloppiness,*sloppiness*>> to *time_macros*.
-** The `__TIMESTAMP__` preprocessor macro is (potentially) being used and the
+** The `+__TIMESTAMP__+` preprocessor macro is (potentially) being used and the
source file's modification time has changed. This is similar to how
- `__TIME__` is handled. If `__TIMESTAMP__` is present in the source code,
+ `+__TIME__+` is handled. If `+__TIMESTAMP__+` is present in the source code,
ccache hashes the string representation of the source file's modification
time in order to be able to produce the correct object file if the
- `__TIMESTAMP__` macro affects the output. If you know that `__TIMESTAMP__`
- isn't used in practise, or don't care if ccache produces objects where
- `__TIMESTAMP__` is expanded to something in the past, you can set
- <<config_sloppiness,*sloppiness*>> to *time_macros*.
+ `+__TIMESTAMP__+` macro affects the output. If you know that
+ `+__TIMESTAMP__+` isn't used in practise, or don't care if ccache produces
+ objects where `+__TIMESTAMP__+` is expanded to something in the past, you can
+ set <<config_sloppiness,*sloppiness*>> to *time_macros*.
** The input file path has changed. Ccache includes the input file path in the
direct mode hash to be able to take relative include files into account and
- to produce a correct object file if the source code includes a `__FILE__`
+ to produce a correct object file if the source code includes a `+__FILE__+`
macro.
-* If ``cache miss'' has been incremented even though the same code has been
+* If "`cache miss`" has been incremented even though the same code has been
compiled and cached before, ccache has either detected that something has
changed anyway or a cleanup has been performed (either explicitly or
- implicitly when a cache limit has been reached). Some perhaps unobvious
- things that may result in a cache miss are usage of `__TIME__`, `__DATE__` or
- `__TIMESTAMP__` macros, or use of automatically generated code that contains
+ implicitly when a cache limit has been reached). Some perhaps unobvious things
+ that may result in a cache miss are usage of `+__TIME__+`, `+__DATE__+` or
+ `+__TIMESTAMP__+` macros, or use of automatically generated code that contains
a timestamp, build counter or other volatile information.
-* If ``multiple source files'' has been incremented, it's an indication that
+* If "`multiple source files`" has been incremented, it's an indication that
the compiler has been invoked on several source code files at once. Ccache
doesn't support that. Compile the source code files separately if possible.
-* If ``unsupported compiler option'' has been incremented, enable debug logging
+* If "`unsupported compiler option`" has been incremented, enable debug logging
and check which compiler option was rejected.
-* If ``preprocessor error'' has been incremented, one possible reason is that
+* If "`preprocessor error`" has been incremented, one possible reason is that
precompiled headers are being used. See _<<_precompiled_headers,Precompiled
headers>>_ for how to remedy this.
-* If ``can't use precompiled header'' has been incremented, see
+* If "`can't use precompiled header`" has been incremented, see
_<<_precompiled_headers,Precompiled headers>>_.
-* If ``can't use modules'' has been incremented, see _<<_c_modules,C++
+* If "`can't use modules`" has been incremented, see _<<_c_modules,C++
modules>>_.
@@ -1689,9 +1680,9 @@ happens, the easiest way of fixing it is this:
1. Build so that the bad object file ends up in the build tree.
2. Remove the bad object file from the build tree.
-3. Rebuild with *CCACHE_RECACHE* set.
+3. Rebuild with `CCACHE_RECACHE` set.
-An alternative is to clear the whole cache with *ccache -C* if you don't mind
+An alternative is to clear the whole cache with `ccache -C` if you don't mind
losing other cached results.
There are no reported issues about ccache producing broken object files
diff --git a/doc/NEWS.adoc b/doc/NEWS.adoc
index eae1a8fb..ff5747d8 100644
--- a/doc/NEWS.adoc
+++ b/doc/NEWS.adoc
@@ -1,29 +1,27 @@
-Ccache news
-===========
+= Ccache news
+
+== Ccache 4.3
-Ccache 4.3
-----------
Release date: 2021-05-09
-New features
-~~~~~~~~~~~~
+
+=== New features
- Ccache now ignores the Clang compiler option `-ivfsoverlay` and its argument
- if you opt in to ``ivfsoverlay sloppiness''. This is useful if you use Xcode,
+ if you opt in to "`ivfsoverlay sloppiness`". This is useful if you use Xcode,
which uses a virtual file system (VFS) for things like combining Objective-C
and Swift code.
-- When using `-P` in combination with `-E`, ccache now reports this as ``called
- for preprocessing'' instead of ``unsupported compiler option''.
+- When using `-P` in combination with `-E`, ccache now reports this as "`called
+ for preprocessing`" instead of "`unsupported compiler option`".
- Added support for `-specs file.specs` and `--specs file.specs` without an
equal sign between the arguments.
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
-- "Split dwarf" code paths are now disabled when outputting to `/dev/null`. This
+- "`Split dwarf`" code paths are now disabled when outputting to `/dev/null`. This
avoids an attempt to delete `/dev/null.dwo`.
- Made the `stat`/`lstat` wrapper function for Windows treat pending deletes as
@@ -37,8 +35,7 @@ Bug fixes
object file path.
-Build improvements
-~~~~~~~~~~~~~~~~~~
+=== Build improvements
- Added an `ENABLE_DOCUMENTATION` build option (default: true) that can be used
to disable the build of documentation.
@@ -50,12 +47,12 @@ Build improvements
expands to the empty string.
-Ccache 4.2.1
-------------
+== Ccache 4.2.1
+
Release date: 2021-03-27
-Bug fixes
-~~~~~~~~~
+
+=== Bug fixes
- Ccache now only duplicates the stderr file descriptor into `$UNCACHED_ERR_FD`
for calls to the preprocessor/compiler. This works around a complex bug in
@@ -87,8 +84,7 @@ Bug fixes
- Fixed handling of long command lines on Windows.
-Portability and build improvements
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Portability and build improvements
- Build configuration scripts now probe for atomic increment as well. This fixes
a linking error on Sparc.
@@ -98,29 +94,28 @@ Portability and build improvements
- Added support for building ccache with xlclang++ on AIX 7.2.
-- Fixed assertion in the "Debug option" test.
+- Fixed assertion in the "`Debug option`" test.
- Made build configuration skip using ccache when building with MSVC.
- Upgraded to doctest 2.4.6. This fixes a build error with glibc >= 2.34.
-Documentation
-~~~~~~~~~~~~~
+=== Documentation
-- Fixed markup of `compiler_type` value "other".
+- Fixed markup of `compiler_type` value `other`.
- Fixed markup of `debug_dir` documentation.
- Fixed references to the `extra_files_to_hash` configuration option.
-Ccache 4.2
-----------
+== Ccache 4.2
+
Release date: 2021-02-02
-New features
-~~~~~~~~~~~~
+
+=== New features
- Improved calculation of relative paths when using `base_dir` to also consider
canonical paths (i.e. paths with dereferenced symlinks) as candidates.
@@ -137,8 +132,7 @@ New features
`SOURCE_DATE_EPOCH`.
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
- Fixed a bug where a non-Clang compiler would silently accept the
Clang-specific `-f(no-)color-diagnostics` option when run via ccache. This
@@ -165,8 +159,7 @@ Bug fixes
- Fixed retrieval of the object file the destination is `/dev/null`.
-Portability and build improvements
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Portability and build improvements
- Additional compiler flags like `-Wextra -Werror` are now only added when
building ccache in developer mode.
@@ -207,8 +200,7 @@ Portability and build improvements
- Took steps towards being able to run the test suite on Windows.
-Documentation
-~~~~~~~~~~~~~
+=== Documentation
- Improved wording of `compiler_check` string values.
@@ -225,16 +217,16 @@ Documentation
- Mention that ccache requires the `-c` compiler option.
-Ccache 4.1
-----------
+== Ccache 4.1
+
Release date: 2020-11-22
-New features
-~~~~~~~~~~~~
+
+=== New features
- Symlinks are now followed when guessing the compiler. This makes ccache able
- to guess compiler type “GCC” for a common symlink chain like this:
- `/usr/bin/cc` → `/etc/alternatives/cc` → `/usr/bin/gcc` → `gcc-9` →
+ to guess compiler type "`GCC`" for a common symlink chain like this:
+ `/usr/bin/cc` -> `/etc/alternatives/cc` -> `/usr/bin/gcc` -> `gcc-9` ->
`x86_64-linux-gnu-gcc-9`.
- Added a new `compiler_type` (`CCACHE_COMPILERTYPE`) configuration option that
@@ -247,20 +239,19 @@ New features
`CCACHE_CONFIGPATH` temporarily.
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
- The original color diagnostics options are now retained when forcing colored
output. This fixes a bug where feature detection of the `-fcolor-diagnostics`
option would succeed when run via ccache even though the actual compiler
- doesn’t support it (e.g. GCC <4.9).
+ doesn't support it (e.g. GCC <4.9).
- Fixed a bug related to umask when using the `umask` (`CCACHE_UMASK`)
configuration option.
- Allow `ccache ccache compiler ...` (repeated `ccache`) again.
-- Fixed parsing of dependency file in the “depend mode” so that filenames with
+- Fixed parsing of dependency file in the "`depend mode`" so that filenames with
space or other special characters are handled correctly.
- Fixed rewriting of the dependency file content when the object filename
@@ -273,16 +264,15 @@ Bug fixes
found out at runtime that file cloning is unsupported by the OS.
-Portability and build fixes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Portability and build fixes
- The ccache binary is now linked with `libatomic` if needed. This fixes build
problems with GCC on ARM and PowerPC.
- Fixed build of BLAKE3 code with Clang 3.4 and 3.5.
-- Fixed “use of undeclared identifier 'CLONE_NOOWNERCOPY'” build error on macOS
- 10.12.
+- Fixed "`use of undeclared identifier 'CLONE_NOOWNERCOPY'`" build error on
+ macOS 10.12.
- Fixed build problems related to missing AVX2 and AVX512 support on older
macOS versions.
@@ -290,7 +280,7 @@ Portability and build fixes
- Fixed static linkage with libgcc and libstdc++ for MinGW and made it
optional.
-- Fixed conditional compilation of “robust mutex” code for the inode cache
+- Fixed conditional compilation of "`robust mutex`" code for the inode cache
routines.
- Fixed badly named man page filename (`Ccache.1` instead of `ccache.1`).
@@ -298,8 +288,7 @@ Portability and build fixes
- Disabled some tests on ancient Clang versions.
-Other improvements and fixes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Other improvements and fixes
- The man page is now built by default if the required tools are available.
@@ -307,20 +296,19 @@ Other improvements and fixes
- Improved build errors when building ccache with very old compiler versions.
-- Fall back to version “unknown” when Git is not installed.
+- Fall back to version "`unknown`" when Git is not installed.
- Documented the relationship between `CCACHE_DIR` and `-d/--directory`.
- Fixed incorrect reference and bad markup in the manual.
-Ccache 4.0
-----------
+== Ccache 4.0
+
Release date: 2020-10-18
-Summary of major changes
-~~~~~~~~~~~~~~~~~~~~~~~~
+=== Summary of major changes
- Changed the default cache directory location to follow the XDG base directory
specification.
@@ -337,13 +325,12 @@ Summary of major changes
- Improved cache directory structure.
-- Added support for using file cloning (AKA “reflinks”).
+- Added support for using file cloning (AKA "`reflinks`").
-- Added an experimental “inode cache” for file hashes.
+- Added an experimental "`inode cache`" for file hashes.
-Compatibility notes
-~~~~~~~~~~~~~~~~~~~
+=== Compatibility notes
- The default location of the cache directory has changed to follow the XDG
base directory specification (<<_detailed_functional_changes,more details
@@ -356,12 +343,11 @@ Compatibility notes
4.0 will not share cache results with earlier versions. It is however safe to
run ccache 4.0 and earlier versions against the same cache directory: cache
bookkeeping, statistics and cleanup are backward compatible, with the minor
- exception that some statistics counters incremented by ccache 4.0 won’t be
+ exception that some statistics counters incremented by ccache 4.0 won't be
visible when running `ccache -s` with an older version.
-Changed tooling
-~~~~~~~~~~~~~~~
+=== Changed tooling
- CMake is now used instead of Autoconf for configuration and building.
@@ -371,10 +357,9 @@ Changed tooling
- Ccache can now be built using Microsoft Visual C++.
-Detailed functional changes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== Detailed functional changes
-- All data of a cached result is now stored in a single file called “result”
+- All data of a cached result is now stored in a single file called "`result`"
instead of up to seven files. This reduces inode usage and improves data
locality.
@@ -410,12 +395,12 @@ Detailed functional changes
The `cache_dir_levels` (`CCACHE_NLEVELS`) configuration option has therefore
been removed.
-- Added an experimental “inode cache” for file hashes, allowing computed hash
+- Added an experimental "`inode cache`" for file hashes, allowing computed hash
values to be reused both within and between builds. The inode cache is off by
default but can be enabled by setting `inode_cache` (`CCACHE_INODECACHE`) to
`true`.
-- Added support for using file cloning (AKA “reflinks”) on Btrfs, XFS and APFS
+- Added support for using file cloning (AKA "`reflinks`") on Btrfs, XFS and APFS
to copy data to and from the cache very efficiently.
- Two measures have been implemented to make the hard link mode safer:
@@ -465,8 +450,8 @@ Detailed functional changes
- Added optional logging to syslog if `log_file` (`CCACHE_LOGFILE`) is set to
`syslog`.
-- The compiler option `-fmodules` is now handled in the “depend mode”. If
- “depend mode” is disabled the option is still considered too hard and ccache
+- The compiler option `-fmodules` is now handled in the "`depend mode`". If
+ "`depend mode`" is disabled the option is still considered too hard and ccache
will fall back to running the compiler.
- Ccache can now cache compilations with coverage notes (`.gcno` files)
@@ -491,12 +476,12 @@ Detailed functional changes
- Ccache is now able to share cache entries for different object file names
when using `-MD` or `-MMD`.
-- Clang’s `-Xclang` (used by CMake for precompiled headers),
+- Clang's `-Xclang` (used by CMake for precompiled headers),
`-fno-pch-timestamp`, `-emit-pch`, `-emit-pth` and `-include-pth` options are
now understood.
-- Added support for the HIP (“C++ Heterogeneous-Compute Interface for
- Portability”) language.
+- Added support for the HIP ("`C++ Heterogeneous-Compute Interface for
+ Portability`") language.
- The manifest format now allows for header files larger than 4 GiB.
@@ -513,8 +498,8 @@ Detailed functional changes
- Made handling of `.dwo` files and interaction between `-gsplit-dwarf` and
other `-g*` options more robust.
-- The “couldn't find compiler” statistics counter is no longer incremented when
- ccache exits with a fatal error.
+- The "`couldn't find compiler`" statistics counter is no longer incremented
+ when ccache exits with a fatal error.
- Failure to run a `compiler_check` command is no longer a fatal error.
@@ -537,8 +522,7 @@ Detailed functional changes
older than 3.1 (released 2010).
-Other improvements
-~~~~~~~~~~~~~~~~~~
+=== Other improvements
- Improved help text and documentation of command line options.
@@ -549,7 +533,7 @@ Other improvements
- Added HTML anchors to configuration options in the manual so that it is
possible link to a specific option.
-- Tweaked placement of “(readonly)” in output of `ccache -s`.
+- Tweaked placement of "`(readonly)`" in output of `ccache -s`.
- Improved visibility of color output from the test suite.
@@ -563,13 +547,12 @@ Other improvements
- Disabled read-only tests on file systems that lack such support.
-ccache 3.7.12
--------------
+== ccache 3.7.12
Release date: 2020-10-01
-Bug fixes
-~~~~~~~~~
+
+=== Bug fixes
- Coverage files (`.gcno`) produced by GCC 9+ when using `-fprofile-dir=dir`
are now handled gracefully by falling back to running the compiler.
@@ -578,8 +561,7 @@ Bug fixes
32-bit mode.
-Other
-~~~~~
+=== Other
- Improved documentation about sharing a cache on NFS.
@@ -588,35 +570,33 @@ Other
- Fixed test case failures with GCC 4.4.
-ccache 3.7.11
--------------
+== ccache 3.7.11
Release date: 2020-07-21
-Bug fixes
-~~~~~~~~~
+
+=== Bug fixes
- Added knowledge about `-fprofile-{correction,reorder-functions,values}`.
- ccache now handles the Intel compiler option `-xCODE` (where `CODE` is a
processor feature code) correctly.
-- Added support for NVCC’s `-Werror` and `--Werror` options.
+- Added support for NVCC's `-Werror` and `--Werror` options.
-Other
-~~~~~
+=== Other
-- ccache’s “Directory is not hashed if using -gz[=zlib]” tests are now skipped
+- ccache's "`Directory is not hashed if using -gz[=zlib]`" tests are now skipped
for GCC 6.
-ccache 3.7.10
-------------
+== ccache 3.7.10
+
Release date: 2020-06-22
-Bug fixes
-~~~~~~~~~
+
+=== Bug fixes
- Improved handling of profiling options. ccache should now work correctly for
profiling options like `-fprofile-{generate,use}[=path]` for GCC ≥ 9 and
@@ -626,11 +606,11 @@ Bug fixes
- ccache now copies files directly from the cache to the destination file
instead of via a temporary file. This avoids problems when using filenames
- long enough to be near the file system’s filename max limit.
+ long enough to be near the file system's filename max limit.
- When the hard-link mode is enabled, ccache now only uses hard links for
object files, not other files like dependency files. This is because
- compilers unlink object files before writing to them but they don’t do that
+ compilers unlink object files before writing to them but they don't do that
for dependency files, so the latter can become overwritten and therefore
corrupted in the cache.
@@ -641,38 +621,37 @@ Bug fixes
- Temporary files are now deleted immediately on signals like SIGTERM and
SIGINT instead of some time later in a cleanup phase.
-- Fixed a bug that affected ccache’s `-o/--set-config` option for the
+- Fixed a bug that affected ccache's `-o/--set-config` option for the
`base_dir` and `cache_dir_levels` keys.
-ccache 3.7.9
-------------
+== ccache 3.7.9
+
Release date: 2020-03-29
-Bug fixes
-~~~~~~~~~
+
+=== Bug fixes
- Fixed replacing of /dev/null when building as root with hard link mode
enabled and using `-o /dev/null`.
-- Removed incorrect assertion resulting in “ccache: error: Internal error in
- format” when using `-fdebug-prefix-map=X=` with X equal to `$PWD`.
+- Removed incorrect assertion resulting in "`ccache: error: Internal error in
+ format`" when using `-fdebug-prefix-map=X=` with X equal to `$PWD`.
-Other
-~~~~~
+=== Other
- Improved CUDA/NVCC support: Recognize `-dc` and `-x cu` options.
- Improved name of temporary file used in NFS-safe unlink.
-ccache 3.7.8
-------------
+== ccache 3.7.8
+
Release date: 2020-03-16
-Bug fixes
-~~~~~~~~~
+
+=== Bug fixes
- Use `$PWD` instead of the real CWD (current working directory) when checking
for CWD in preprocessed output. This fixes a problem when `$PWD` includes a
@@ -684,8 +663,7 @@ Bug fixes
- If `localtime_r` fails the epoch time is now logged instead of garbage.
-Other
-~~~~~
+=== Other
- Improved error message when a boolean environment variable has an invalid
value.
@@ -693,28 +671,28 @@ Other
- Improved the regression fix in ccache 3.7.5 related to not passing
compilation-only options to the preprocessor.
-- ccache’s PCH test suite now skips running the tests if it detects broken PCH
+- ccache's PCH test suite now skips running the tests if it detects broken PCH
compiler support.
- Fixed unit test failure on Windows.
-- Fixed “stringop-truncation” build warning on Windows.
+- Fixed "`stringop-truncation`" build warning on Windows.
-- Improved “x_rename” implementation on Windows.
+- Improved "`x_rename`" implementation on Windows.
- Improved removal of temporary file when rewriting absolute paths to relative
in the dependency file.
-- Clarified “include_file_ctime sloppiness” in the Performance section in the
+- Clarified "`include_file_ctime sloppiness`" in the Performance section in the
manual.
-ccache 3.7.7
-------------
+== ccache 3.7.7
+
Release date: 2020-01-05
-Bug fixes
-~~~~~~~~~
+
+=== Bug fixes
- Fixed a bug related to object file location in the dependency file (if using
`-MD` or `-MMD` but not `-MF` and the build directory is not the same as the
@@ -724,32 +702,32 @@ Bug fixes
compilers again. (A better fix for this is planned for ccache 4.0.)
- Removed the unify mode since it has bugs and shortcomings that are non-trivial
- or impossible to fix: it doesn’t work with the direct mode, it doesn’t handle
+ or impossible to fix: it doesn't work with the direct mode, it doesn't handle
C++ raw strings correctly, it can give false cache hits for `.incbin`
- directives, it’s turned off when using `-g` and it can make line numbers in
+ directives, it's turned off when using `-g` and it can make line numbers in
warning messages and `__LINE__` macros incorrect.
- mtime and ctime values are now stored in the manifest files only when
sloppy_file_stat is set. This avoids adding superfluous manifest file entries
on direct mode cache misses.
-- A “Result:” line is now always printed to the log.
+- A "`Result:`" line is now always printed to the log.
-- The “cache miss” statistics counter will now be updated for read-only cache
+- The "`cache miss`" statistics counter will now be updated for read-only cache
misses, making it consistent with the cache hit case.
-ccache 3.7.6
-------------
+== ccache 3.7.6
+
Release date: 2019-11-17
-Bug fixes
-~~~~~~~~~
-- The opt-in “file_macro sloppiness” mode has been removed so that the input
+=== Bug fixes
+
+- The opt-in "`file_macro sloppiness`" mode has been removed so that the input
file path now is always included in the direct mode hash. This fixes a bug
- that could result in false cache hits in an edge case when “file_macro
- sloppiness” is enabled and several identical source files include a relative
+ that could result in false cache hits in an edge case when "`file_macro
+ sloppiness`" is enabled and several identical source files include a relative
header file with the same name but in different directories.
- Statistics files are no longer lost when the filesystem of the cache is full.
@@ -760,26 +738,25 @@ Bug fixes
- Properly handle color diagnostics in the depend mode as well.
-ccache 3.7.5
-------------
+== ccache 3.7.5
+
Release date: 2019-10-22
-New features
-~~~~~~~~~~~~
+
+=== New features
- Added support for `-MF=arg` (with an extra equal sign) as understood by
EDG-based compilers.
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
- Fixed a regression in 3.7.2 that could result in a warning message instead of
- an error in an edge case related to usage of “-Werror”.
+ an error in an edge case related to usage of "`-Werror`".
- An implicit `-MQ` is now passed to the preprocessor only if the object file
extension is non-standard. This will make it easier to use EDG-based
- compilers (e.g. GHS) which don’t understand `-MQ`. (This is a bug fix of the
+ compilers (e.g. GHS) which don't understand `-MQ`. (This is a bug fix of the
corresponding improvement implemented in ccache 3.4.)
- ccache now falls back to running the real compiler instead of failing fataly
@@ -792,45 +769,45 @@ Bug fixes
- Fixed warning during configure in out-of-tree build in developer mode.
-ccache 3.7.4
-------------
+== ccache 3.7.4
+
Release date: 2019-09-12
-Improvements
-~~~~~~~~~~~~
+
+=== Improvements
- Added support for the `-gz[=type]` compiler option (previously ccache would
- think that “-gz” alone would enable debug information, thus potentially
+ think that "`-gz`" alone would enable debug information, thus potentially
including the current directory in the hash).
-- Added support for converting paths like “/c/users/...” into relative paths on
- Windows.
+- Added support for converting paths like "`/c/users/...`" into relative paths
+ on Windows.
+
+== ccache 3.7.3
-ccache 3.7.3
-------------
Release date: 2019-08-17
-Bug fixes
-~~~~~~~~~
-- The cache size (which is counted in “used disk blocks”) is now correct on
+=== Bug fixes
+
+- The cache size (which is counted in "`used disk blocks`") is now correct on
filesystems that use more or less disk blocks than conventional filesystems,
e.g. ecryptfs or btrfs/zfs with transparent compression. This also fixes a
- related problem with ccache’s own test suite when run on such file systems.
+ related problem with ccache's own test suite when run on such file systems.
+
+- Fixed a regression in 3.7.2 when using the compiler option "`-Werror`" and
+ then "`-Wno-error`" later on the command line.
-- Fixed a regression in 3.7.2 when using the compiler option “-Werror” and then
- “-Wno-error” later on the command line.
+== ccache 3.7.2
-ccache 3.7.2
-------------
Release date: 2019-07-19
-Bug fixes
-~~~~~~~~~
-- The compiler option `-gdwarf*` no longer forces “run_second_cpp = true”.
+=== Bug fixes
+
+- The compiler option `-gdwarf*` no longer forces "`run_second_cpp = true`".
- Added verification that the value passed to the `-o/--set-config` option is
valid.
@@ -847,11 +824,10 @@ Bug fixes
- Unknown manifest versions are now handled gracefully in `--dump-manifest`.
-- Fixed `make check` with “funny” locales.
+- Fixed `make check` with "`funny`" locales.
-Documentation
-~~~~~~~~~~~~~
+=== Documentation
- Added a hint about not running `autogen.sh` when building from a release
archive.
@@ -859,28 +835,28 @@ Documentation
- Mention that `xsltproc` is needed when building from the source repository.
-ccache 3.7.1
-------------
+== ccache 3.7.1
+
Release date: 2019-05-01
-Changes
-~~~~~~~
+
+=== Changes
- Fixed a problem when using the compiler option `-MF /dev/null`.
- Long commandlines are now handled gracefully on Windows by using the `@file`
syntax to avoid hitting the commandline size limit.
-- Fixed complaint from GCC 9’s `-Werror=format-overflow` when compiling ccache
+- Fixed complaint from GCC 9's `-Werror=format-overflow` when compiling ccache
itself.
-ccache 3.7
-----------
+== ccache 3.7
+
Release date: 2019-04-23
-Changes
-~~~~~~~
+
+=== Changes
- Fixed crash when the debug mode is enabled and the output file is in a
non-writable directory, e.g. when the output file is `/dev/null`.
@@ -924,12 +900,12 @@ Changes
machine-parsable (tab-separated) format.
- ccache no longer creates a missing output directory, thus mimicking the
- compiler behavior for `-o out/obj.o` when “out” doesn’t exist.
+ compiler behavior for `-o out/obj.o` when `out` doesn't exist.
-- `-fdebug-prefix-map=ARG`, `-ffile-prefix-map=ARG` and
- `-fmacro-prefix-map=ARG` are now included in the hash, but only the part
- before “ARG”. This fixes a bug where compiler feature detection of said flags
- would not work correctly with ccache.
+- `-fdebug-prefix-map=ARG`, `-ffile-prefix-map=ARG` and `-fmacro-prefix-map=ARG`
+ are now included in the hash, but only the part before "`ARG`". This fixes a
+ bug where compiler feature detection of said flags would not work correctly
+ with ccache.
- Bail out on too hard compiler option `-gtoggle`.
@@ -952,19 +928,19 @@ Changes
involved.
-ccache 3.6
-----------
+== ccache 3.6
+
Release date: 2019-01-14
-Changes
-~~~~~~~
-- ccache now has an opt-in “depend mode”. When enabled, ccache never executes
+=== Changes
+
+- ccache now has an opt-in "`depend mode`". When enabled, ccache never executes
the preprocessor, which results in much lower cache miss overhead at the
expense of a lower potential cache hit rate. The depend mode is only possible
to use when the compiler option `-MD` or `-MMD` is used.
-- Added support for GCC’s `-ffile-prefix-map` option. The `-fmacro-prefix-map`
+- Added support for GCC's `-ffile-prefix-map` option. The `-fmacro-prefix-map`
option is now also skipped from the hash.
- Added support for multiple `-fsanitize-blacklist` arguments.
@@ -976,7 +952,7 @@ Changes
- Fixed a problem due to Clang overwriting the output file when compiling an
assembler file.
-- Clarified the manual to explain the reasoning behind the “file_macro”
+- Clarified the manual to explain the reasoning behind the "`file_macro`"
sloppiness setting in a better way.
- ccache now handles several levels of nonexistent directories when rewriting
@@ -985,27 +961,27 @@ Changes
- A new sloppiness setting `clang_index_store` makes ccache skip the Clang
compiler option `-index-store-path` and its argument when computing the
manifest hash. This is useful if you use Xcode, which uses an index store
- path derived from the local project path. Note that the index store won’t be
+ path derived from the local project path. Note that the index store won't be
updated correctly on cache hits if you enable this option.
- Rename sloppiness `no_system_headers` to `system_headers` for consistency
with other options. `no_system_headers` can still be used as an
(undocumented) alias.
-- The GCC variables “DEPENDENCIES_OUTPUT” and “SUNPRO_DEPENDENCIES” are now
+- The GCC variables "`DEPENDENCIES_OUTPUT`" and "`SUNPRO_DEPENDENCIES`" are now
supported correctly.
- The algorithm that scans for `__DATE_` and `__TIME__` tokens in the hashed
- source code now doesn’t produce false positives for tokens where `__DATE__`
+ source code now doesn't produce false positives for tokens where `__DATE__`
or `__TIME__` is a substring.
-ccache 3.5.1
-------------
+== ccache 3.5.1
+
Release date: 2019-01-02
-Changes
-~~~~~~~
+
+=== Changes
- Added missing getopt_long.c source file to release archive.
@@ -1016,17 +992,17 @@ Changes
- Improved development mode build flags.
-ccache 3.5
-----------
+== ccache 3.5
+
Release date: 2018-10-15
-Changes
-~~~~~~~
+
+=== Changes
- Added a boolean `debug` (`CCACHE_DEBUG`) configuration option. When enabled,
- ccache will create per-object debug files that are helpful e.g. when
- debugging unexpected cache misses. See also the new “Cache debugging” section
- in the manual.
+ ccache will create per-object debug files that are helpful e.g. when debugging
+ unexpected cache misses. See also the new "`Cache debugging`" section in the
+ manual.
- Renamed `CCACHE_CC` to `CCACHE_COMPILER` (keeping the former as a deprecated
alias).
@@ -1042,36 +1018,36 @@ Changes
- Improved performance substantially when using `hash_dir = false` on platforms
like macOS where `getcwd()` is slow.
-- Added “stats updated” timestamp in `ccache -s` output. This can be useful if
+- Added "`stats updated`" timestamp in `ccache -s` output. This can be useful if
you wonder whether ccache actually was used for your last build.
-- Renamed “stats zero time” to “stats zeroed” and documented it. The counter is
- also now only present in `ccache -s` output when `ccache -z` actually has
+- Renamed "`stats zero time`" to "`stats zeroed`" and documented it. The counter
+ is also now only present in `ccache -s` output when `ccache -z` actually has
been called.
- The content of the `-fsanitize-blacklist` file is now included in the hash,
so updates to the file will now correctly result in separate cache entries.
-- It’s now possible to opt out of building and installing man pages when
+- It's now possible to opt out of building and installing man pages when
running `make install` in the source repository.
-- If the compiler type can’t be detected (e.g. if it is named `cc`), use safer
- defaults that won’t trip up Clang.
+- If the compiler type can't be detected (e.g. if it is named `cc`), use safer
+ defaults that won't trip up Clang.
- Made the ccache test suite work on FreeBSD.
- Added `file_stat_matches_ctime` option to disable ctime check if
`file_stat_matches` is enabled.
-- Made “./configure --without-bundled-zlib” do what’s intended.
+- Made "`./configure --without-bundled-zlib`" do what's intended.
+
+== ccache 3.4.3
-ccache 3.4.3
------------
Release date: 2018-09-02
-Bug fixes
-~~~~~~~~~
+
+=== Bug fixes
- Fixed a race condition when creating the initial config file in the cache
directory.
@@ -1085,12 +1061,12 @@ Bug fixes
- Upgraded bundled zlib to version 1.2.11.
-ccache 3.4.2
-------------
+== ccache 3.4.2
+
Release date: 2018-03-25
-Bug fixes
-~~~~~~~~~
+
+=== Bug fixes
- The cleanup algorithm has been fixed to not misbehave when files are removed
by another process while the cleanup process is running. Previously, too many
@@ -1098,42 +1074,42 @@ Bug fixes
triggered at the same time, in extreme cases trimming the cache to a much
smaller size than the configured limits.
-- Correctly hash preprocessed headers located in a “.gch directory”.
+- Correctly hash preprocessed headers located in a "`.gch directory`".
Previously, ccache would not pick up changes to such precompiled headers,
risking false positive cache hits.
- Fixed build failure when using the bundled zlib sources.
- ccache 3.3.5 added a workaround for not triggering Clang errors when a
- precompiled header’s dependency has an updated timestamp (but identical
+ precompiled header's dependency has an updated timestamp (but identical
content). That workaround is now only applied when the compiler is Clang.
- Made it possible to perform out-of-source builds in dev mode again.
-ccache 3.4.1
-------------
+== ccache 3.4.1
+
Release date: 2018-02-11
-Bug fixes
-~~~~~~~~~
+
+=== Bug fixes
- Fixed printing of version number in `ccache --version`.
-ccache 3.4
-----------
+== ccache 3.4
+
Release date: 2018-02-11
-New features and enhancements
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+=== New features and enhancements
- The compiler option form `--sysroot arg` is now handled like the documented
`--sysroot=arg` form.
- Added support for caching `.su` files generated by GCC flag `-fstack-usage`.
-- ccache should now work with distcc’s “pump” wrapper.
+- ccache should now work with distcc's "`pump`" wrapper.
- The optional unifier is no longer disabled when the direct mode is enabled.
@@ -1142,7 +1118,7 @@ New features and enhancements
- Boolean environment variable settings no longer accept the following
(case-insensitive) values: `0`, `false`, `disable` and `no`. All other values
- are accepted and taken to mean “true”. This is to stop users from setting
+ are accepted and taken to mean "`true`". This is to stop users from setting
e.g. `CCACHE_DISABLE=0` and then expect the cache to be used.
- Improved support for `run_second_cpp = false`: If combined with passing
@@ -1151,7 +1127,7 @@ New features and enhancements
- An implicit `-MQ` is now passed to the preprocessor only if the object file
extension is non-standard. This should make it easier to use EDG-based
- compilers (e.g. GHS) which don’t understand `-MQ`.
+ compilers (e.g. GHS) which don't understand `-MQ`.
- ccache now treats an unreadable configuration file just like a missing
configuration file.
@@ -1161,8 +1137,7 @@ New features and enhancements
- Documented caveats related to colored warnings from compilers.
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
- File size and number counters are now updated correctly when files are
overwritten in the cache, e.g. when using `CCACHE_RECACHE`.
@@ -1172,39 +1147,35 @@ Bug fixes
- Fixed how the NVCC options `-optf` and `-odir` are handled.
-ccache 3.3.6
-------------
+== ccache 3.3.6
+
Release date: 2018-01-28
-New features and enhancements
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== New features and enhancements
- Improved instructions on how to get cache hits between different working
directories.
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
- Fixed regression in ccache 3.3.5 related to the `UNCACHED_ERR_FD` feature.
-ccache 3.3.5
-------------
+== ccache 3.3.5
+
Release date: 2018-01-13
-New features and enhancements
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== New features and enhancements
- Documented how automatic cache cleanup works.
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
- Fixed a regression where the original order of debug options could be lost.
- This reverts the “Improved parsing of `-g*` options” feature in ccache 3.3.
+ This reverts the "`Improved parsing of `-g*` options`" feature in ccache 3.3.
- Multiple `-fdebug-prefix-map` options should now be handled correctly.
@@ -1222,9 +1193,9 @@ Bug fixes
- `ccache -c/--cleanup` now works like documented: it just recalculates size
counters and trims the cache to not exceed the max size and file number
- limits. Previously, the forced cleanup took “limit_multiple” into account, so
- that `ccache -c/--cleanup` by default would trim the cache to 80% of the max
- limit.
+ limits. Previously, the forced cleanup took "`limit_multiple`" into account,
+ so that `ccache -c/--cleanup` by default would trim the cache to 80% of the
+ max limit.
- ccache no longer ignores linker arguments for Clang since Clang warns about
them.
@@ -1236,46 +1207,44 @@ Bug fixes
`-remap` or `-trigraphs` option in preprocessor mode.
-ccache 3.3.4
-------------
+== ccache 3.3.4
+
Release date: 2017-02-17
-New features and enhancements
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== New features and enhancements
- Documented the different cache statistics counters.
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
- Fixed a regression in ccache 3.3 related to potentially bad content of
dependency files when compiling identical source code but with different
source paths. This was only partially fixed in 3.3.2 and reverts the new
- “Names of included files are no longer included in the hash of the compiler’s
- preprocessed output” feature in 3.3.
+ "`Names of included files are no longer included in the hash of the compiler's
+ preprocessed output`" feature in 3.3.
- Corrected statistics counter for `-optf`/`--options-file` failure.
- Fixed undefined behavior warnings in ccache found by `-fsanitize=undefined`.
-ccache 3.3.3
-------------
+== ccache 3.3.3
+
Release date: 2016-10-26
-Bug fixes
-~~~~~~~~~
+
+=== Bug fixes
- ccache now detects usage of `.incbin` assembler directives in the source code
and avoids caching such compilations.
-ccache 3.3.2
-------------
+== ccache 3.3.2
+
Release date: 2016-09-28
-Bug fixes
-~~~~~~~~~
+
+=== Bug fixes
- Fixed a regression in ccache 3.3 related to potentially bad content of
dependency files when compiling identical source code but with different
@@ -1286,14 +1255,14 @@ Bug fixes
resulting in missing dependency files from direct mode cache hits.
-ccache 3.3.1
-------------
+== ccache 3.3.1
+
Release date: 2016-09-07
-Bug fixes
-~~~~~~~~~
-- Fixed a problem in the “multiple `-arch` options” support introduced in 3.3.
+=== Bug fixes
+
+- Fixed a problem in the "`multiple `-arch` options`" support introduced in 3.3.
When using the direct mode (the default), different combinations of `-arch`
options were not detected properly.
@@ -1302,22 +1271,20 @@ Bug fixes
(`CCACHE_CPP2`) is enabled.
-ccache 3.3
-----------
+== ccache 3.3
+
Release date: 2016-08-27
-Notes
-~~~~~
+=== Notes
- A C99-compatible compiler is now required to build ccache.
-New features and enhancements
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== New features and enhancements
- The configuration option `run_second_cpp` (`CCACHE_CPP2`) now defaults to
- true. This improves ccache’s out-of-the-box experience for compilers that
- can’t compile their own preprocessed output with the same outcome as if they
+ true. This improves ccache's out-of-the-box experience for compilers that
+ can't compile their own preprocessed output with the same outcome as if they
compiled the real source code directly, e.g. newer versions of GCC and Clang.
- The configuration option `hash_dir` (`CCACHE_HASHDIR`) now defaults to true.
@@ -1341,22 +1308,22 @@ New features and enhancements
- Added a new statistics counter that tracks the number of performed cleanups
due to the cache size being over the limit. The value is shown in the output
- of “ccache -s”.
+ of "`ccache -s`".
- Added support for relocating debug info directory using `-fdebug-prefix-map`.
This allows for cache hits even when `hash_dir` is used in combination with
`base_dir`.
-- Added a new “cache hit rate” field to the output of “ccache -s”.
+- Added a new "`cache hit rate`" field to the output of "`ccache -s`".
-- Added support for caching compilation of assembler code produced by e.g. “gcc
- -S file.c”.
+- Added support for caching compilation of assembler code produced by e.g. "`gcc
+ -S file.c`".
- Added support for cuda including the -optf/--options-file option.
- Added support for Fortran 77.
-- Added support for multiple `-arch` options to produce “fat binaries”.
+- Added support for multiple `-arch` options to produce "`fat binaries`".
- Multiple identical `-arch` arguments are now handled without bailing.
@@ -1378,7 +1345,7 @@ New features and enhancements
- ccache now understands the undocumented `-coverage` (only one dash) GCC
option.
-- Names of included files are no longer included in the hash of the compiler’s
+- Names of included files are no longer included in the hash of the compiler's
preprocessed output. This leads to more potential cache hits when not using
the direct mode.
@@ -1386,8 +1353,7 @@ New features and enhancements
slightly.
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
- Bail out on too hard compiler option `-P`.
@@ -1396,24 +1362,24 @@ Bug fixes
- Fixed build and test for MinGW32 and Windows.
-ccache 3.2.9
-------------
+== ccache 3.2.9
+
Release date: 2016-09-28
-Bug fixes
-~~~~~~~~~
+
+=== Bug fixes
- Fixed a regression in ccache 3.2.8: ccache could get confused when using the
compiler option `-Wp,` to pass multiple options to the preprocessor,
resulting in missing dependency files from direct mode cache hits.
-ccache 3.2.8
-------------
+== ccache 3.2.8
+
Release date: 2016-09-07
-Bug fixes
-~~~~~~~~~
+
+=== Bug fixes
- Fixed an issue when compiler option `-Wp,-MT,path` is used instead of `-MT
path` (and similar for `-MF`, `-MP` and `-MQ`) and `run_second_cpp`
@@ -1423,86 +1389,83 @@ Bug fixes
option.
-ccache 3.2.7
-------------
+== ccache 3.2.7
+
Release date: 2016-07-20
-Bug fixes
-~~~~~~~~~
+
+=== Bug fixes
- Fixed a bug which could lead to false cache hits for compiler command lines
with a missing argument to an option that takes an argument.
-- ccache now knows how to work around a glitch in the output of GCC 6’s
+- ccache now knows how to work around a glitch in the output of GCC 6's
preprocessor.
-ccache 3.2.6
-------------
+== ccache 3.2.6
+
Release date: 2016-07-12
-Bug fixes
-~~~~~~~~~
-- Fixed build problem on QNX, which lacks “SA_RESTART”.
+=== Bug fixes
+
+- Fixed build problem on QNX, which lacks "`SA_RESTART`".
- Bail out on compiler option `-fstack-usage` since it creates a `.su` file
- which ccache currently doesn’t handle.
+ which ccache currently doesn't handle.
- Fixed a bug where (due to ccache rewriting paths) the compiler could choose
incorrect include files if `CCACHE_BASEDIR` is used and the source file path
is absolute and is a symlink.
-ccache 3.2.5
-------------
+== ccache 3.2.5
+
Release date: 2016-04-17
-New features and enhancements
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== New features and enhancements
- Only pass Clang-specific `-stdlib=` to the preprocessor.
- Improved handling of stale NFS handles.
-- Made it harder to misinterpret documentation of boolean environment settings’
+- Made it harder to misinterpret documentation of boolean environment settings'
semantics.
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
- Include m4 files used by configure.ac in the source dist archives.
-- Corrected “Performance” section in the manual regarding `__DATE_`, `__TIME__`
- and `__FILE__` macros.
+- Corrected "`Performance`" section in the manual regarding `__DATE_`,
+ `__TIME__` and `__FILE__` macros.
- Fixed build on Solaris 10+ and AIX 7.
- Fixed failure to create directories on QNX.
-- Don’t (try to) update manifest file in “read-only” and “read-only direct”
+- Don't (try to) update manifest file in "`read-only`" and "`read-only direct`"
modes.
-- Fixed a bug in caching of `stat` system calls in “file_stat_matches
- sloppiness mode”.
+- Fixed a bug in caching of `stat` system calls in "`file_stat_matches
+ sloppiness mode`".
- Fixed bug in hashing of Clang plugins, leading to unnecessary cache misses.
-- Fixed --print-config to show “pch_defines sloppiness”.
+- Fixed --print-config to show "`pch_defines sloppiness`".
-- The man page is now built when running “make install” from Git repository
+- The man page is now built when running "`make install`" from Git repository
sources.
-ccache 3.2.4
-------------
+== ccache 3.2.4
+
Release date: 2015-10-08
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
- Fixed build error related to zlib on systems with older make versions
(regression in ccache 3.2.3).
@@ -1521,19 +1484,17 @@ Bug fixes
64 GiB on 32-bit systems.
-ccache 3.2.3
-------------
+== ccache 3.2.3
+
Release date: 2015-08-16
-New features and enhancements
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== New features and enhancements
- Added support for compiler option `-gsplit-dwarf`.
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
- Support external zlib in nonstandard directory.
@@ -1543,34 +1504,32 @@ Bug fixes
- Bail out on compiler option `--save-temps` in addition to `-save-temps`.
-- Only log “Disabling direct mode” once when failing to read potential include
+- Only log "`Disabling direct mode`" once when failing to read potential include
files.
-ccache 3.2.2
-------------
+== ccache 3.2.2
+
Release date: 2015-05-10
-New features and enhancements
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== New features and enhancements
- Added support for `CCACHE_COMPILERCHECK=string:<value>`. This is a faster
- alternative to `CCACHE_COMPILERCHECK=<command>` if the command’s output can
+ alternative to `CCACHE_COMPILERCHECK=<command>` if the command's output can
be precalculated by the build system.
- Add support for caching code coverage results (compiling for gcov).
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
- Made hash of cached result created with and without `CCACHE_CPP2` different.
This makes it possible to rebuild with `CCACHE_CPP2` set without having to
clear the cache to get new results.
-- Don’t try to reset a nonexistent stats file. This avoids “No such file or
- directory” messages in the ccache log when the cache directory doesn’t exist.
+- Don't try to reset a nonexistent stats file. This avoids "`No such file or
+ directory`" messages in the ccache log when the cache directory doesn't exist.
- Fixed a bug where ccache deleted Clang diagnostics after compiler failures.
@@ -1592,13 +1551,12 @@ Bug fixes
- Fixed build error when compiling ccache with recent Clang versions.
-ccache 3.2.1
-------------
+== ccache 3.2.1
+
Release date: 2014-12-10
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
- Fixed regression in temporary file handling, which lead to incorrect
permissions for stats, manifest and ccache.conf files in the cache.
@@ -1616,13 +1574,12 @@ Bug fixes
options.
-ccache 3.2
-----------
+== ccache 3.2
+
Release date: 2014-11-17
-New features and enhancements
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== New features and enhancements
- Added support for configuring ccache via one or several configuration files
instead of via environment variables. Environment variables still have
@@ -1640,7 +1597,7 @@ New features and enhancements
- Added support for several binaries (separated by space) in `CCACHE_PREFIX`.
- The `-c` option is no longer passed to the preprocessor. This fixes problems
- with Clang and Solaris’s C++ compiler.
+ with Clang and Solaris's C++ compiler.
- ccache no longer passes preprocessor options like `-D` and `-I` to the
compiler when compiling preprocessed output. This fixes warnings emitted by
@@ -1649,7 +1606,7 @@ New features and enhancements
- Compiler options `-fprofile-generate`, `-fprofile-arcs`, `-fprofile-use` and
`-fbranch-probabilities` are now handled without bailing.
-- Added support for Clang’s `--serialize-diagnostic` option, storing the
+- Added support for Clang's `--serialize-diagnostic` option, storing the
diagnostic file (`.dia`) in the cache.
- Added support for precompiled headers when using Clang.
@@ -1664,19 +1621,19 @@ New features and enhancements
the other way around. This is needed to support compiler options like
`-fprofile-arcs` and `--serialize-diagnostics`.
-- ccache now checks that included files’ ctimes aren’t too new. This check can
- be turned off by adding `include_file_ctime` to the “ccache sloppiness”
+- ccache now checks that included files' ctimes aren't too new. This check can
+ be turned off by adding `include_file_ctime` to the "`ccache sloppiness`"
setting.
- Added possibility to get cache hits based on filename, size, mtime and ctime
only. On other words, source code files are not even read, only stat-ed. This
- operation mode is opt-in by adding `file_stat_matches` to the “ccache
- sloppiness” setting.
+ operation mode is opt-in by adding `file_stat_matches` to the "`ccache
+ sloppiness`" setting.
- The filename part of options like `-Wp,-MDfilename` is no longer included in
- the hash since the filename doesn’t have any bearing on the result.
+ the hash since the filename doesn't have any bearing on the result.
-- Added a “read-only direct” configuration setting, which is like the ordinary
+- Added a "`read-only direct`" configuration setting, which is like the ordinary
read-only setting except that ccache will only try to retrieve results from
the cache using the direct mode, not the preprocessor mode.
@@ -1691,7 +1648,7 @@ New features and enhancements
- Added support for `@file` and `-@file` arguments (reading options from a
file).
-- `-Wl,` options are no longer included in the hash since they don’t affect
+- `-Wl,` options are no longer included in the hash since they don't affect
compilation.
- Bail out on too hard compiler option `-Wp,-P`.
@@ -1715,8 +1672,7 @@ New features and enhancements
- Various other improvements of the test suite.
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
- Any previous `.stderr` is now removed from the cache when recaching.
@@ -1727,26 +1683,24 @@ Bug fixes
- Fixed test suite failures when `CC` is a ccache-wrapped compiler.
-ccache 3.1.12
--------------
+== ccache 3.1.12
+
Release date: 2016-07-12
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
- Fixed a bug where (due to ccache rewriting paths) the compiler could choose
incorrect include files if `CCACHE_BASEDIR` is used and the source file path
is absolute and is a symlink.
-ccache 3.1.11
--------------
+== ccache 3.1.11
+
Release date: 2015-03-07
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
- Fixed bug which could result in false cache hits when source code contains
`'"'` followed by `" /*"` or `" //"` (with variations).
@@ -1755,17 +1709,16 @@ Bug fixes
This makes it possible to rebuild with `CCACHE_CPP2` set without having to
clear the cache to get new results.
-- Don’t try to reset a nonexistent stats file. This avoids “No such file or
- directory” messages in the ccache log when the cache directory doesn’t exist.
+- Don't try to reset a nonexistent stats file. This avoids "`No such file or
+ directory`" messages in the ccache log when the cache directory doesn't exist.
+
+== ccache 3.1.10
-ccache 3.1.10
--------------
Release date: 2014-10-19
-New features and enhancements
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== New features and enhancements
- Added support for the `-Xclang` compiler option.
@@ -1780,21 +1733,20 @@ New features and enhancements
`CCACHE_BASEDIR` to reuse results across different directories.)
- Added note in documentation that `--ccache-skip` currently does not mean
- “don’t hash the following option”.
+ "`don't hash the following option`".
- To enable support for precompiled headers (PCH), `CCACHE_SLOPPINESS` now also
needs to include the new `pch_defines` sloppiness. This is because ccache
- can’t detect changes in the source code when only defined macros have been
+ can't detect changes in the source code when only defined macros have been
changed.
- Stale files in the internal temporary directory (`<ccache_dir>/tmp`) are now
cleaned up if they are older than one hour.
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
-- Fixed path canonicalization in `make_relative_path()` when path doesn’t
+- Fixed path canonicalization in `make_relative_path()` when path doesn't
exist.
- Fixed bug in `common_dir_prefix_length()`. This corrects the `CCACHE_BASEDIR`
@@ -1809,13 +1761,12 @@ Bug fixes
- Fixed problem with logging of current working directory.
-ccache 3.1.9
-------------
+== ccache 3.1.9
+
Release date: 2013-01-06
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
- The EAGAIN signal is now handled correctly when emitting cached stderr
output. This fixes a problem triggered by large error outputs from the
@@ -1823,7 +1774,7 @@ Bug fixes
- Subdirectories in the cache are no longer created in read-only mode.
-- Fixed so that ccache’s log file descriptor is not made available to the
+- Fixed so that ccache's log file descriptor is not made available to the
compiler.
- Improved error reporting when failing to create temporary stdout/stderr files
@@ -1832,19 +1783,17 @@ Bug fixes
- Disappearing temporary stdout/stderr files are now handled gracefully.
-Other
-~~~~~
+=== Other
- Fixed test suite to work on ecryptfs.
-ccache 3.1.8
-------------
+== ccache 3.1.8
+
Release date: 2012-08-11
-New features and enhancements
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== New features and enhancements
- Made paths to dependency files relative in order to increase cache hits.
@@ -1854,8 +1803,7 @@ New features and enhancements
- Clang plugins are now hashed to catch plugin upgrades.
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
- Fixed crash when the current working directory has been removed.
@@ -1868,28 +1816,26 @@ Bug fixes
base directory.
-Other
-~~~~~
+=== Other
- Made git version macro work when compiling outside of the source directory.
- Fixed `static_assert` macro definition clash with GCC 4.7.
-ccache 3.1.7
-------------
+== ccache 3.1.7
+
Release date: 2012-01-08
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
- Non-writable `CCACHE_DIR` is now handled gracefully when `CCACHE_READONLY` is
set.
- Made failure to create files (typically due to bad directory permissions) in
the cache directory fatal. Previously, such failures were silently and
- erroneously flagged as “compiler produced stdout”.
+ erroneously flagged as "`compiler produced stdout`".
- Both the `-specs=file` and `--specs=file` forms are now recognized.
@@ -1908,8 +1854,7 @@ Bug fixes
versions.)
-Other
-~~~~~
+=== Other
- Corrected license header for `mdfour.c`.
@@ -1917,34 +1862,31 @@ Other
-ccache 3.1.6
-------------
+== ccache 3.1.6
+
Release date: 2011-08-21
-New features and enhancements
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== New features and enhancements
- Rewrite argument to `--sysroot` if `CCACHE_BASEDIR` is used.
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
-- Don’t crash if `getcwd()` fails.
+- Don't crash if `getcwd()` fails.
-- Fixed alignment of “called for preprocessing” counter.
+- Fixed alignment of "`called for preprocessing`" counter.
-ccache 3.1.5
-------------
+== ccache 3.1.5
+
Release date: 2011-05-29
-New features and enhancements
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== New features and enhancements
-- Added a new statistics counter named “called for preprocessing”.
+- Added a new statistics counter named "`called for preprocessing`".
- The original command line is now logged to the file specified with
`CCACHE_LOGFILE`.
@@ -1957,8 +1899,7 @@ New features and enhancements
- Improved order of statistics counters in `ccache -s` output.
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
- The `-MF`/`-MT`/`-MQ` options with concatenated argument are now handled
correctly when they are last on the command line.
@@ -1968,53 +1909,49 @@ Bug fixes
- Fixed a minor memory leak.
-- Systems that lack (and don’t need to be linked with) libm are now supported.
+- Systems that lack (and don't need to be linked with) libm are now supported.
+
+== ccache 3.1.4
-ccache 3.1.4
-------------
Release date: 2011-01-09
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
- Made a work-around for a bug in `gzputc()` in zlib 1.2.5.
-- Corrupt manifest files are now removed so that they won’t block direct mode
+- Corrupt manifest files are now removed so that they won't block direct mode
hits.
-- ccache now copes with file systems that don’t know about symbolic links.
+- ccache now copes with file systems that don't know about symbolic links.
- The file handle is now correctly closed on write error when trying to create
a cache dir tag.
-ccache 3.1.3
-------------
+== ccache 3.1.3
+
Release date: 2010-11-28
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
- The -MFarg, -MTarg and -MQarg compiler options (i.e, without space between
option and argument) are now handled correctly.
-Other
-~~~~~
+=== Other
- Portability fixes for HP-UX 11.00 and other esoteric systems.
-ccache 3.1.2
-------------
+== ccache 3.1.2
+
Release date: 2010-11-21
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
- Bail out on too hard compiler options `-fdump-*`.
@@ -2024,24 +1961,22 @@ Bug fixes
- Fixed issue when parsing precompiler output on AIX.
-Other
-~~~~~
+=== Other
- Improved documentation on which information is included in the hash sum.
-- Made the “too new header file” test case work on file systems with
+- Made the "`too new header file`" test case work on file systems with
unsynchronized clocks.
- The test suite now also works on systems that lack a /dev/zero.
-ccache 3.1.1
-------------
+== ccache 3.1.1
+
Release date: 2010-11-07
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
- ccache now falls back to preprocessor mode when a non-regular include file
(device, socket, etc) has been detected so that potential hanging due to
@@ -2056,27 +1991,25 @@ Bug fixes
- Fixed configure detection of ar.
- ccache development version (set by dev.mk) now works with gits whose
- `describe` command doesn’t understand `--dirty`.
+ `describe` command doesn't understand `--dirty`.
-Other
-~~~~~
+=== Other
- Minor debug log message improvements.
-ccache 3.1
-----------
+== ccache 3.1
+
Release date: 2010-09-16
-New features and enhancements
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== New features and enhancements
- Added support for hashing the output of a custom command (e.g. `%compiler%
--version`) to identify the compiler instead of stat-ing or hashing the
compiler binary. This can improve robustness when the compiler (as seen by
- ccache) actually isn’t the real compiler but another compiler wrapper.
+ ccache) actually isn't the real compiler but another compiler wrapper.
- Added support for caching compilations that use precompiled headers. (See the
manual for important instructions regarding this.)
@@ -2095,9 +2028,9 @@ New features and enhancements
- Reading and writing of statistics counters has been made forward-compatible
(unknown counters are retained).
-- Files are now read without using `mmap()`. This has two benefits: it’s more
+- Files are now read without using `mmap()`. This has two benefits: it's more
robust against file changes during reading and it improves performance on
- poor systems where `mmap()` doesn’t use the disk cache.
+ poor systems where `mmap()` doesn't use the disk cache.
- Added `.cp` and `.CP` as known C++ suffixes.
@@ -2107,8 +2040,7 @@ New features and enhancements
statistics when using the Darwin linker.)
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
- Non-fatal error messages are now never printed to stderr but logged instead.
@@ -2119,8 +2051,7 @@ Bug fixes
- EINTR is now handled correctly.
-Other
-~~~~~
+=== Other
- Work on porting ccache to win32 (native), mostly done by Ramiro Polla. The
port is not yet finished, but will hopefully be complete in some subsequent
@@ -2146,22 +2077,21 @@ Other
- New `HACKING.txt` file with some notes about ccache code conventions.
-ccache 3.0.1
-------------
+== ccache 3.0.1
+
Release date: 2010-07-15
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
-- The statistics counter “called for link” is now correctly updated when
+- The statistics counter "`called for link`" is now correctly updated when
linking with a single object file.
- Fixed a problem with out-of-source builds.
-ccache 3.0
-----------
+== ccache 3.0
+
Release date: 2010-06-20
@@ -2172,19 +2102,17 @@ General
or later.
-Upgrade notes
-~~~~~~~~~~~~~
+=== Upgrade notes
-- The way the hashes are calculated has changed, so you won’t get cache hits
+- The way the hashes are calculated has changed, so you won't get cache hits
for compilation results stored by older ccache versions. Because of this, you
might as well clear the old cache directory with `ccache --clear` if you
want, unless you plan to keep using an older ccache version.
-New features and enhancements
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=== New features and enhancements
-- ccache now has a “direct mode” where it computes a hash of the source code
+- ccache now has a "`direct mode`" where it computes a hash of the source code
(including all included files) and compiler options without running the
preprocessor. By not running the preprocessor, CPU usage is reduced; the
speed is somewhere between 1 and 5 times that of ccache running in
@@ -2202,19 +2130,19 @@ New features and enhancements
- Object files are now optionally stored compressed in the cache. The runtime
cost is negligible, and more files will fit in the ccache directory and in
the disk cache. Set `CCACHE_COMPRESS` to enable object file compression. Note
- that you can’t use compression in combination with the hard link feature.
+ that you can't use compression in combination with the hard link feature.
- A `CCACHE_COMPILERCHECK` option has been added. This option tells ccache what
compiler-identifying information to hash to ensure that results retrieved
- from the cache are accurate. Possible values are: none (don’t hash anything),
- mtime (hash the compiler’s mtime and size) and content (hash the content of
+ from the cache are accurate. Possible values are: none (don't hash anything),
+ mtime (hash the compiler's mtime and size) and content (hash the content of
the compiler binary). The default is mtime.
- It is now possible to specify extra files whose contents should be included
in the hash sum by setting the `CCACHE_EXTRAFILES` option.
- Added support for Objective-C and Objective-C\+\+. The statistics counter
- “not a C/C++ file” has been renamed to “unsupported source language”.
+ "`not a C/C++ file`" has been renamed to "`unsupported source language`".
- Added support for the `-x` compiler option.
@@ -2237,13 +2165,13 @@ New features and enhancements
- Temporary files that later will be moved into the cache are now created in
the cache directory they will end up in. This makes ccache more friendly to
- Linux’s directory layout.
+ Linux's directory layout.
- Improved the test suite and added tests for most of the new functionality.
- It’s now also possible to specify a subset of tests to run.
+ It's now also possible to specify a subset of tests to run.
- Standard error output from the compiler is now only stored in the cache if
- it’s non-empty.
+ it's non-empty.
- If the compiler produces no object file or an empty object file, but gives a
zero exit status (could be due to a file system problem, a buggy program
@@ -2251,7 +2179,7 @@ New features and enhancements
- Added `installcheck` and `distcheck` make targets.
-- Clarified cache size limit options’ and cleanup semantics.
+- Clarified cache size limit options' and cleanup semantics.
- Improved display of cache max size values.
@@ -2260,8 +2188,7 @@ New features and enhancements
`-iwithprefixbefore`, `-nostdinc`, `-nostdinc++` and `-U`.
-Bug fixes
-~~~~~~~~~
+=== Bug fixes
- Various portability improvements.
@@ -2280,7 +2207,7 @@ Bug fixes
`-save-temps`. Also bail out on `@file` style options.
- Errors when using multiple `-arch` compiler options are now noted as
- “unsupported compiler option”.
+ "`unsupported compiler option`".
- `-MD`/`-MMD` options without `-MT`/`-MF` are now handled correctly.
diff --git a/dockerfiles/centos-7/Dockerfile b/dockerfiles/centos-7/Dockerfile
index 9ff79880..d5c4e489 100644
--- a/dockerfiles/centos-7/Dockerfile
+++ b/dockerfiles/centos-7/Dockerfile
@@ -3,7 +3,7 @@ FROM centos:7
RUN yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm \
&& yum install -y centos-release-scl \
&& yum install -y \
- asciidoc \
+ asciidoctor \
autoconf \
bash \
ccache \
@@ -16,8 +16,6 @@ RUN yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.n
libzstd-devel \
make \
python3 \
-# Remove superfluous dependencies brought in by asciidoc:
- && rpm -e --nodeps graphviz \
&& yum autoremove -y \
&& yum clean all \
&& cp /usr/bin/cmake3 /usr/bin/cmake \
diff --git a/dockerfiles/centos-8/Dockerfile b/dockerfiles/centos-8/Dockerfile
index 9ee7c68a..e61c576c 100644
--- a/dockerfiles/centos-8/Dockerfile
+++ b/dockerfiles/centos-8/Dockerfile
@@ -4,7 +4,7 @@ FROM centos:8
RUN dnf install -y epel-release \
&& dnf update -y \
&& dnf install -y \
- asciidoc \
+ asciidoctor \
autoconf \
bash \
ccache \
diff --git a/dockerfiles/debian-10/Dockerfile b/dockerfiles/debian-10/Dockerfile
index 8f92ea9a..54bd4439 100644
--- a/dockerfiles/debian-10/Dockerfile
+++ b/dockerfiles/debian-10/Dockerfile
@@ -14,7 +14,6 @@ RUN apt-get update \
python3 \
redis-server \
redis-tools \
- xsltproc \
&& rm -rf /var/lib/apt/lists/*
# Redirect all compilers to ccache.
diff --git a/dockerfiles/debian-11/Dockerfile b/dockerfiles/debian-11/Dockerfile
index 322ab92c..7c73dd2d 100644
--- a/dockerfiles/debian-11/Dockerfile
+++ b/dockerfiles/debian-11/Dockerfile
@@ -14,7 +14,6 @@ RUN apt-get update \
python3 \
redis-server \
redis-tools \
- xsltproc \
&& rm -rf /var/lib/apt/lists/*
# Redirect all compilers to ccache.
diff --git a/dockerfiles/ubuntu-18.04/Dockerfile b/dockerfiles/ubuntu-18.04/Dockerfile
index 9d2a8187..409f6dc3 100644
--- a/dockerfiles/ubuntu-18.04/Dockerfile
+++ b/dockerfiles/ubuntu-18.04/Dockerfile
@@ -2,7 +2,7 @@ FROM ubuntu:18.04
RUN apt-get update \
&& apt-get install -y --no-install-recommends \
- asciidoc \
+ asciidoctor \
bash \
build-essential \
ccache \
@@ -17,7 +17,6 @@ RUN apt-get update \
python3 \
redis-server \
redis-tools \
- xsltproc \
&& rm -rf /var/lib/apt/lists/*
# Redirect all compilers to ccache.
diff --git a/dockerfiles/ubuntu-20.04/Dockerfile b/dockerfiles/ubuntu-20.04/Dockerfile
index 78ef79c2..46f4135e 100644
--- a/dockerfiles/ubuntu-20.04/Dockerfile
+++ b/dockerfiles/ubuntu-20.04/Dockerfile
@@ -3,7 +3,7 @@ FROM ubuntu:20.04
# Non-interactive: do not set up timezone settings.
RUN apt-get update \
&& DEBIAN_FRONTEND="noninteractive" apt-get install -y --no-install-recommends \
- asciidoc \
+ asciidoctor \
bash \
build-essential \
ccache \
@@ -18,7 +18,6 @@ RUN apt-get update \
python3 \
redis-server \
redis-tools \
- xsltproc \
&& rm -rf /var/lib/apt/lists/*
# Redirect all compilers to ccache.