]> git.ipfire.org Git - thirdparty/ccache.git/commitdiff
docs: Mention that system_headers sloppiness is not supported for MSVC
authorJoel Rosdahl <joel@rosdahl.net>
Wed, 23 Aug 2023 17:06:35 +0000 (19:06 +0200)
committerJoel Rosdahl <joel@rosdahl.net>
Thu, 24 Aug 2023 18:50:00 +0000 (20:50 +0200)
Closes #1224.

doc/MANUAL.adoc

index 4243fff181fd81d5da1b3e12df6b64282614e260..64b429030f893f889593e514d0038c89e673c100 100644 (file)
@@ -1056,9 +1056,16 @@ preprocessing first.
     hash. This is useful if your build system generates different seeds between
     builds and you are OK with reusing cached results.
 *system_headers*::
-    By default, ccache will also include all system headers in the manifest.
-    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.
+    Only check non-system headers in direct mode.
+    This can be useful if e.g. your system headers tend to change but you know that
+    the changes don't matter. Notes:
++
+* This sloppiness is only supported for GCC-like compilers, not MSVC.
+* System headers are still taken into account for preprocessed lookup.
+* You can get stale cache hits if the system headers do change in incompatible
+  ways.
+* See also the
+  <<config_ignore_headers_in_manifest,*ignore_headers_in_manifest*>> setting.
 *time_macros*::
     Ignore `+__DATE__+`, `+__TIME__+` and `+__TIMESTAMP__+` being present in the
     source code.