summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoel Rosdahl <joel@rosdahl.net>2022-09-24 21:08:43 +0200
committerJoel Rosdahl <joel@rosdahl.net>2022-09-27 22:24:37 +0200
commita2e7f91070a46a31914dae6c2ba9815af5fab823 (patch)
treeddc24ef7e39a1282c76c5a1c0ea0d25ef2a46979 /doc
parentb97e77ce460f905f1141935d03d3727543edad12 (diff)
downloadccache-a2e7f91070a46a31914dae6c2ba9815af5fab823.tar.gz
chore: Rename primary/secondary config to config/system config
Diffstat (limited to 'doc')
-rw-r--r--doc/INSTALL.md4
-rw-r--r--doc/MANUAL.adoc29
2 files changed, 16 insertions, 17 deletions
diff --git a/doc/INSTALL.md b/doc/INSTALL.md
index b86b4059..e0763874 100644
--- a/doc/INSTALL.md
+++ b/doc/INSTALL.md
@@ -59,8 +59,8 @@ make install
You can set the installation directory to e.g. `/usr` by adding
`-DCMAKE_INSTALL_PREFIX=/usr` to the `cmake` command. You can set the directory
-where the secondary configuration file should be located to e.g. `/etc` by
-adding `-DCMAKE_INSTALL_SYSCONFDIR=/etc`.
+where the system configuration file should be located to e.g. `/etc` by adding
+`-DCMAKE_INSTALL_SYSCONFDIR=/etc`.
There are two different ways to use ccache to cache a compilation:
diff --git a/doc/MANUAL.adoc b/doc/MANUAL.adoc
index 8011e0d9..10aa9fea 100644
--- a/doc/MANUAL.adoc
+++ b/doc/MANUAL.adoc
@@ -289,27 +289,26 @@ file. The priorities of configuration options are as follows (where 1 is
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`).
+2. The cache-specific configuration file (see below).
+3. The system (read-only) configuration file `<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
-it specifies the primary configuration file and the secondary (system-wide)
-configuration file won't be read.
+As a special case, if the environment variable `CCACHE_CONFIGPATH` is set it
+specifies the configuration file, and the system configuration file won't be
+read.
-=== Location of the primary configuration file
+=== Location of the configuration file
-The location of the primary (cache-specific) configuration is determined like
-this on non-Windows systems:
+The location of the cache-specific configuration file is determined like this on
+non-Windows systems:
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`.
+3. Otherwise, if <<config_cache_dir,*cache_dir*>> is set in the system
+ 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
@@ -323,8 +322,8 @@ On Windows, this is the method used to find the configuration file:
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`. The
+3. Otherwise, if <<config_cache_dir,*cache_dir*>> is set in the system
+ configuration file then use `<cache_dir>\ccache.conf`. The
system-wide configuration on Windows is
`%ALLUSERSPROFILE%\ccache\ccache.conf` by default. The `ALLUSERSPROFILE`
environment variable is usually `C:\ProgramData`.
@@ -461,7 +460,7 @@ of the cache in domain environments and similar problems. Please check this
directory for cache directories and either delete them or the whole directory,
or move them to the `%LOCALAPPDATA%\ccache` directory.
+
-See also _<<Location of the primary configuration file>>_.
+See also _<<Location of the configuration file>>_.
[#config_compiler]
*compiler* (*CCACHE_COMPILER* or (deprecated) *CCACHE_CC*)::