Merge pull request #14382 from aneeshusa/update-ccache-stdenv-documentation

ccacheStdenv: provide working example config in docs
This commit is contained in:
joachifm 2016-04-09 19:38:12 +02:00
commit 1d36e6ec07

View File

@ -5765,16 +5765,22 @@ in
# It can be used by setting in nixpkgs config like this, for example:
# replaceStdenv = { pkgs }: pkgs.ccacheStdenv;
# But if you build in chroot, you should have that path in chroot
# If instantiated directly, it will use the HOME/.ccache as cache directory.
# You can use an override in packageOverrides to set extraConfig:
# If instantiated directly, it will use $HOME/.ccache as the cache directory,
# i.e. /homeless-shelter/.ccache using the Nix daemon.
# You should specify a different directory using an override in
# packageOverrides to set extraConfig.
#
# Example using Nix daemon (i.e. multiuser Nix install or on NixOS):
# packageOverrides = pkgs: {
# ccacheWrapper = pkgs.ccacheWrapper.override {
# extraConfig = ''
# CCACHE_COMPRESS=1
# CCACHE_DIR=/bin/.ccache
# export CCACHE_COMPRESS=1
# export CCACHE_DIR=/var/cache/ccache
# export CCACHE_UMASK=007
# '';
# };
#
# You can use a different directory, but whichever directory you choose
# should be owned by user root, group nixbld with permissions 0770.
ccacheWrapper = makeOverridable ({ extraConfig ? "" }:
wrapCC (ccache.links extraConfig)) {};
ccacheStdenv = lowPrio (overrideCC stdenv ccacheWrapper);