From owner-dev-commits-ports-all@freebsd.org Wed Jul 14 18:09:40 2021 Return-Path: Delivered-To: dev-commits-ports-all@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id 4986E653A3B; Wed, 14 Jul 2021 18:09:40 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4GQ5BD1YpRz3K7H; Wed, 14 Jul 2021 18:09:40 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 1EA441AB8F; Wed, 14 Jul 2021 18:09:40 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 16EI9ebD061436; Wed, 14 Jul 2021 18:09:40 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 16EI9eUr061435; Wed, 14 Jul 2021 18:09:40 GMT (envelope-from git) Date: Wed, 14 Jul 2021 18:09:40 GMT Message-Id: <202107141809.16EI9eUr061435@gitrepo.freebsd.org> To: ports-committers@FreeBSD.org, dev-commits-ports-all@FreeBSD.org, dev-commits-ports-main@FreeBSD.org From: Bryan Drewery Subject: git: 9984bd302c51 - main - Mk/bsd.ccache.mk: Add more documentation. MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: bdrewery X-Git-Repository: ports X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 9984bd302c51f48dccba1346ec717b0d7745d5b8 Auto-Submitted: auto-generated X-BeenThere: dev-commits-ports-all@freebsd.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Commit messages for all branches of the ports repository List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 14 Jul 2021 18:09:40 -0000 The branch main has been updated by bdrewery: URL: https://cgit.FreeBSD.org/ports/commit/?id=9984bd302c51f48dccba1346ec717b0d7745d5b8 commit 9984bd302c51f48dccba1346ec717b0d7745d5b8 Author: Bryan Drewery AuthorDate: 2021-07-14 17:57:45 +0000 Commit: Bryan Drewery CommitDate: 2021-07-14 18:09:37 +0000 Mk/bsd.ccache.mk: Add more documentation. PR: 242944 --- Mk/bsd.ccache.mk | 34 ++++++++++++++++++++++++++++++---- 1 file changed, 30 insertions(+), 4 deletions(-) diff --git a/Mk/bsd.ccache.mk b/Mk/bsd.ccache.mk index cd8124c020d0..0a240bcffe03 100644 --- a/Mk/bsd.ccache.mk +++ b/Mk/bsd.ccache.mk @@ -1,10 +1,36 @@ #-*- tab-width: 4; -*- # ex:ts=4 # -# WITH_CCACHE_BUILD=yes enables depending on ccache and using it in the build. -# NO_CCACHE_DEPEND will additionally not add the dependency on ccache. -# NO_CCACHE will disable using ccache entirely. -# CCACHE_PKG_PREFIX is where ccache is already installed. Default: LOCALBASE +# User settable: +# - WITH_CCACHE_BUILD - enables depending on ccache and using it in the build. +# - CCACHE_PKG_PREFIX - where ccache is already installed. Default: LOCALBASE +# This should not be set unless it differs from the +# default. +# - CCACHE_DIR (optional) - where ccache stores its cache. See ccache(1). +# This should not be set unless it differs from the +# default. +# +# Port use (users should not modify these): +# - CCACHE_BIN - path to the ccache binary. Intended to be prefixed before CC. +# - CCACHE_WRAPPER_PATH - path to directory containing compiler symlinks back +# to ccache. For example, gcc5 -> ccache. Intended +# to be added to $PATH +# This is expected to end in /libexec/ccache. +# +# In general CCACHE_WRAPPER_PATH should be placed into the env PATH for a +# port build rather than directly invoking CCACHE_BIN. Then when the port +# runs 'cc' or 'gcc5' it will find the symlinks. If a port is directly +# using a full path to a specific compiler then CCACHE_BIN can possibly be +# prefixed in front of it, if the CC path cannot be fixed to be relative. +# +# Port use (special case): +# - NO_CCACHE - disable using ccache entirely. This is for when a port build +# fails with ccache being used. Typically this should be +# temporary only. +# - NO_CCACHE_DEPEND - avoid automatically depending on ccache but still +# attempt to use it in PATH. This is typically only +# needed in devel/ccache itself. +# COMMANDS_Include_MAINTAINER= portmgr@FreeBSD.org