Page MenuHomePhabricator

Add a config note and fix a config variable regarding CCACHE support.
ClosedPublic

Authored by mattd on Jan 4 2018, 7:47 PM.

Details

Summary
  • Mention in the CMake configuration documentation that LLVM builds, support the use of ccache.
  • Use CCACHE_MAXSIZE instead of CCACHE_SIZE. The former is recognized by ccache, not the latter.
  • Rename the LLVM CMake configuration variable to reflect that change: LLVM_CCACHE_SIZE -> LLVM_CCACHE_MAXSIZE

Diff Detail

Repository
rL LLVM

Event Timeline

mattd created this revision.Jan 4 2018, 7:47 PM

I know off-list I had suggested not bothering with detailed descriptions of LLVM_CCACHE_SIZE and LLVM_CCACHE_DIR, but now I am not so sure. If those variables map directly to ccache command-line arguments, we should say that here, and people can figure out how to set them by looking at the appropriate help. If the variables are more complicated, we should add separate entries for them in this doc.

mattd updated this revision to Diff 128807.Jan 5 2018, 2:39 PM
mattd retitled this revision from [Docs] Add a configuration note about building with CCACHE support. to Add a config note and fix a config variable regarding CCACHE support..
mattd edited the summary of this revision. (Show Details)

See inline comment. I think that makes it clear enough where to look for details about what values to use for the MAXSIZE/DIR parameters.

docs/CMake.rst
559 ↗(On Diff #128807)

... options, which are passed to the CCACHE_MAXSIZE and CCACHE_DIR environment variables, respectively.

mattd updated this revision to Diff 128821.Jan 5 2018, 3:36 PM

Thanks Paul, I like that suggestion.

This revision is now accepted and ready to land.Jan 8 2018, 1:07 PM
mattd marked an inline comment as done.Jan 23 2018, 9:06 AM

Ping. Since I don't have commit access I'll need someone else to commit this on my behalf.

This revision was automatically updated to reflect the committed changes.

Thanks for taking care of this

mattd added a comment.Jan 29 2018, 1:29 PM

No problem!