arm-trusted-firmware/make_helpers/unix.mk
Chris Kay 7c4e1eea61 build: unify verbosity handling
This change introduces a few helper variables for dealing with verbose
and silent build modes: `silent`, `verbose`, `q` and `s`.

The `silent` and `verbose` variables are boolean values determining
whether the build system has been configured to run silently or
verbosely respectively (i.e. with `--silent` or `V=1`).

These two modes cannot be used together - if `silent` is truthy then
`verbose` is always falsy. As such:

    make --silent V=1

... results in a silent build.

In addition to these boolean variables, we also introduce two new
variables - `s` and `q` - for use in rule recipes to conditionally
suppress the output of commands.

When building silently, `s` expands to a value which disables the
command that follows, and `q` expands to a value which supppresses
echoing of the command:

    $(s)echo 'This command is neither echoed nor executed'
    $(q)echo 'This command is executed but not echoed'

When building verbosely, `s` expands to a value which disables the
command that follows, and `q` expands to nothing:

    $(s)echo 'This command is neither echoed nor executed'
    $(q)echo 'This command is executed and echoed'

In all other cases, both `s` and `q` expand to a value which suppresses
echoing of the command that follows:

    $(s)echo 'This command is executed but not echoed'
    $(q)echo 'This command is executed but not echoed'

The `s` variable is predominantly useful for `echo` commands, where you
always want to suppress echoing of the command itself, whilst `q` is
more useful for all other commands.

Change-Id: I8d8ff6ed714d3cb401946c52955887ed7dca602b
Signed-off-by: Chris Kay <chris.kay@arm.com>
2024-06-14 15:54:48 +00:00

60 lines
1.4 KiB
Makefile

#
# Copyright (c) 2016-2024, Arm Limited and Contributors. All rights reserved.
#
# SPDX-License-Identifier: BSD-3-Clause
#
# Trusted Firmware shell command definitions for a Unix style environment.
ifndef UNIX_MK
UNIX_MK := $(lastword $(MAKEFILE_LIST))
DIR_DELIM := /
PATH_SEP := :
# These defines provide Unix style equivalents of the shell commands
# required by the Trusted Firmware build environment.
# ${1} is the file to be copied.
# ${2} is the destination file name.
define SHELL_COPY
$(q)cp -f "${1}" "${2}"
endef
# ${1} is the directory to be copied.
# ${2} is the destination directory path.
define SHELL_COPY_TREE
$(q)cp -rf "${1}" "${2}"
endef
# ${1} is the file to be deleted.
define SHELL_DELETE
-$(q)rm -f "${1}"
endef
# ${1} is a space delimited list of files to be deleted.
# Note that we do not quote ${1}, as multiple parameters may be passed.
define SHELL_DELETE_ALL
-$(q)rm -rf ${1}
endef
# ${1} is the directory to be generated.
# ${2} is optional, and allows a prerequisite to be specified.
# Do nothing if $1 == $2, to ignore self dependencies.
define MAKE_PREREQ_DIR
ifneq (${1},${2})
${1} : ${2}
$(q)mkdir -p "${1}"
endif
endef
define SHELL_REMOVE_DIR
-$(q)rm -rf "${1}"
endef
nul := /dev/null
which = $(shell command -v $(call escape-shell,$(1)) 2>$(nul))
endif