[PATCH] D149818: [Docs] Update CMake documentation on using ccache

[Aiden Grossman via Phabricator via llvm-commits]

aidengrossman created this revision.
Herald added a project: All.
aidengrossman requested review of this revision.
Herald added a project: LLVM.
Herald added a subscriber: llvm-commits.

Since LLVM's minimum CMake version has been bumped to an appropriate
version and CMake noe nwatively supports the
CMAKE_{C,CXX}_COMPILER_LAUNCHER flags, the LLVM_CCACHE_BUILD flag is now
deprecated. This patch adjusts the documentation to reflect this change.

https://discourse.llvm.org/t/llvm-ccache-build-is-deprecated/68431


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D149818

Files:
  llvm/docs/CMake.rst


Index: llvm/docs/CMake.rst
===================================================================
--- llvm/docs/CMake.rst
+++ llvm/docs/CMake.rst
@@ -227,6 +227,12 @@
   compilers installed, CMake might not default to the one you wish to
   use.
 
+**CMAKE_{C,CXX}_COMPILER_LAUNCHER**:STRING
+  Specifies the compiler launcher to use. This can be used to do a build with
+  `ccache` by setting `CMAKE_C_COMPILER_LAUNCHER` and
+  `CMAKE_CXX_COMPILER_LAUNCHER` both to `ccache` in addition to having ccache
+  installed.
+
 .. _Frequently Used LLVM-related variables:
 
 Frequently Used LLVM-related variables
@@ -399,14 +405,6 @@
   example, you can build *llvm-as* with a Makefile-based system by executing *make
   llvm-as* at the root of your build directory.
 
-**LLVM_CCACHE_BUILD**:BOOL
-  If enabled and the ``ccache`` program is available, then LLVM will be
-  built using ``ccache`` to speed up rebuilds of LLVM and its components.
-  Defaults to OFF.  The size and location of the cache maintained
-  by ``ccache`` can be adjusted via the LLVM_CCACHE_MAXSIZE and LLVM_CCACHE_DIR
-  options, which are passed to the CCACHE_MAXSIZE and CCACHE_DIR environment
-  variables, respectively.
-
 **LLVM_CREATE_XCODE_TOOLCHAIN**:BOOL
   macOS Only: If enabled CMake will generate a target named
   'install-xcode-toolchain'. This target will create a directory at


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D149818.519361.patch
Type: text/x-patch
Size: 1361 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20230504/7ffd74e5/attachment.bin>