Skip to content

Commit a249482

Browse files
cassavacassava
committed
tooling: Fix interspersed $() and ${} in Makefiles
1 parent 1a9436d commit a249482

File tree

6 files changed

+298
-291
lines changed

6 files changed

+298
-291
lines changed

‎Makefile

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ GNUMAKEFLAGS := --no-print-directory
99
SUBMAKEFLAGS :=
1010

1111
CLOE_ROOT := $(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
12-
CLOE_LAUNCH := PYTHONPATH="${CLOE_ROOT}/cli" python3 -m cloe_launch
12+
CLOE_LAUNCH := PYTHONPATH="$(CLOE_ROOT)/cli" python3 -m cloe_launch
1313

14-
include ${CLOE_ROOT}/Makefile.help
14+
include $(CLOE_ROOT)/Makefile.help
1515

1616
# Set the clang-format command line to use:
1717
CLANG_FORMAT := $(shell command -v clang-format 2>/dev/null)
@@ -31,8 +31,8 @@ CONAN_OPTIONS :=
3131

3232
# Lockfile for cloe-deployment:
3333
DEPLOY_LOCKFILE_SOURCE := tests/conanfile_deployment.py
34-
DEPLOY_BUILD_LOCKFILE := ${DEPLOY_DIR}/conan.lock
35-
DEPLOY_LOCKFILE_OPTION := --lockfile="${CLOE_ROOT}/${DEPLOY_BUILD_LOCKFILE}"
34+
DEPLOY_BUILD_LOCKFILE := $(DEPLOY_DIR)/conan.lock
35+
DEPLOY_LOCKFILE_OPTION := --lockfile="$(CLOE_ROOT)/$(DEPLOY_BUILD_LOCKFILE)"
3636

3737
.DEFAULT_GOAL := help
3838
.PHONY: help
@@ -47,12 +47,12 @@ help::
4747
# Setup targets ---------------------------------------------------------------
4848
include Makefile.setup
4949

50-
${DEPLOY_BUILD_LOCKFILE}:
51-
mkdir -p "${DEPLOY_DIR}"
52-
conan lock create --lockfile-out "${DEPLOY_BUILD_LOCKFILE}" --build -- "${DEPLOY_LOCKFILE_SOURCE}"
50+
$(DEPLOY_BUILD_LOCKFILE):
51+
mkdir -p "$(DEPLOY_DIR)"
52+
conan lock create --lockfile-out "$(DEPLOY_BUILD_LOCKFILE)" --build -- "$(DEPLOY_LOCKFILE_SOURCE)"
5353

5454
.PHONY: lockfile
55-
lockfile: ${DEPLOY_BUILD_LOCKFILE}
55+
lockfile: $(DEPLOY_BUILD_LOCKFILE)
5656

5757
# Workspace targets -----------------------------------------------------------
5858
help::
@@ -63,60 +63,60 @@ help::
6363
.PHONY: docs
6464
docs:
6565
$(call print_header, "Generating Doxygen documentation...")
66-
${MAKE} -C docs doxygen
66+
$(MAKE) -C docs doxygen
6767
$(call print_header, "Generating Sphinx documentation...")
68-
${MAKE} -C docs html
68+
$(MAKE) -C docs html
6969

7070
help::
71-
$(call print_help_target, export-cli, "export ${_yel}cloe-launch-profile${_rst} Conan recipe")
72-
$(call print_help_target, deploy-cli, "install ${_yel}cloe-launch${_rst} with ${_dim}${PIPX}${_rst}")
71+
$(call print_help_target, export-cli, "export $(_yel)cloe-launch-profile$(_rst) Conan recipe")
72+
$(call print_help_target, deploy-cli, "install $(_yel)cloe-launch$(_rst) with $(_dim)$(PIPX)$(_rst)")
7373
echo
7474

7575
.PHONY: export-cli
7676
export-cli:
77-
${MAKE} -C cli export
77+
$(MAKE) -C cli export
7878

7979
.PHONY: deploy-cli
8080
deploy-cli:
8181
$(call print_header, "Deploying cloe-launch binary with pip...")
82-
${MAKE} -C cli install
82+
$(MAKE) -C cli install
8383

8484
help::
8585
$(call print_help_target, lockfile, "create a lockfile for cloe deployment packages")
8686
$(call print_help_target, package-all, "package all cloe deployment packages")
8787
$(call print_help_target, status-all, "show status of each of the Conan packages")
8888
$(call print_help_target, export-all, "export all package sources to Conan cache")
8989
$(call print_help_target, build-all, "build individual packages locally in-source")
90-
$(call print_help_target, deploy-all, "deploy Cloe to INSTALL_DIR [=${INSTALL_DIR}]")
90+
$(call print_help_target, deploy-all, "deploy $(_yel)cloe$(_rst) to $(_grn)INSTALL_DIR$(_rst)=$(_dim)$(INSTALL_DIR)$(_rst)")
9191
$(call print_help_target, clean-all, "clean entire repository of temporary files")
9292
$(call print_help_target, purge-all, "remove all cloe packages (in any version) from Conan cache")
9393
echo
9494

9595
.PHONY: build-all
9696
build-all: lockfile
97-
${MAKE} all-select CONAN_OPTIONS="${CONAN_OPTIONS} ${DEPLOY_LOCKFILE_OPTION}"
97+
$(MAKE) all-select CONAN_OPTIONS="$(CONAN_OPTIONS) $(DEPLOY_LOCKFILE_OPTION)"
9898

9999
.PHONY: status-all
100-
status-all: ${DEPLOY_BUILD_LOCKFILE}
101-
@for pkg in ${ALL_PKGS}; do \
102-
${MAKE} LOCKFILE_SOURCE="" LOCKFILE_OPTION=${DEPLOY_LOCKFILE_OPTION} -C $${pkg} status || true; \
100+
status-all: $(DEPLOY_BUILD_LOCKFILE)
101+
@for pkg in $(ALL_PKGS); do \
102+
$(MAKE) LOCKFILE_SOURCE="" LOCKFILE_OPTION=$(DEPLOY_LOCKFILE_OPTION) -C $${pkg} status || true; \
103103
done
104104

105105
.PHONY: export-all
106106
export-all:
107107
$(call print_header, "Exporting all cloe Conan packages...")
108-
${MAKE} export-select export-cli export
108+
$(MAKE) export-select export-cli export
109109

110110
.PHONY: deploy-all
111111
deploy-all:
112-
$(call print_header, "Deploying binaries to ${INSTALL_DIR}...")
113-
conan install ${CONAN_OPTIONS} --install-folder ${DEPLOY_DIR} -g deploy .
114-
mkdir -p ${INSTALL_DIR}
115-
cp -r ${DEPLOY_DIR}/cloe-*/* ${INSTALL_DIR}/
112+
$(call print_header, "Deploying binaries to $(INSTALL_DIR)...")
113+
conan install $(CONAN_OPTIONS) --install-folder $(DEPLOY_DIR) -g deploy .
114+
mkdir -p $(INSTALL_DIR)
115+
cp -r $(DEPLOY_DIR)/cloe-*/* $(INSTALL_DIR)/
116116

117117
.PHONY: clean-all
118118
clean-all:
119-
${MAKE} clean clean-select
119+
$(MAKE) clean clean-select
120120

121121
.PHONY: purge-all
122122
purge-all:
@@ -127,7 +127,7 @@ purge-all:
127127

128128
.PHONY: package-all
129129
package-all:
130-
conan install ${CONAN_OPTIONS} --install-folder ${DEPLOY_DIR} --build=missing --build=outdated ${DEPLOY_LOCKFILE_SOURCE}
130+
conan install $(CONAN_OPTIONS) --install-folder $(DEPLOY_DIR) --build=missing --build=outdated $(DEPLOY_LOCKFILE_SOURCE)
131131

132132
# Development targets ---------------------------------------------------------
133133
help::
@@ -143,19 +143,19 @@ format:
143143
# continues to work as expected.
144144
#
145145
# See: https://www.moxio.com/blog/43/ignoring-bulk-change-commits-with-git-blame
146-
find . -type f -not -path '*/\.git/*' -and \( -name '*.cpp' -o -name '*.hpp' \) -exec ${CLANG_FORMAT} ${CLANG_FORMAT_ARGS} -i {} \;
146+
find . -type f -not -path '*/\.git/*' -and \( -name '*.cpp' -o -name '*.hpp' \) -exec $(CLANG_FORMAT) $(CLANG_FORMAT_ARGS) -i {} \;
147147

148148
.PHONY: todos
149149
todos:
150-
${AG} TODO
151-
${AG} FIXME
152-
${AG} XXX
150+
$(AG) TODO
151+
$(AG) FIXME
152+
$(AG) XXX
153153

154154
# Hidden development targets --------------------------------------------------
155155

156156
.PHONY: grep-uuids
157157
grep-uuids:
158-
${AG} "\b[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\b"
158+
$(AG) "\b[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\b"
159159

160160
grep-conan-requires:
161161
@rg -t py '^.*requires\(f?["](.+/[0-9]+\.[^)]+)["].*\).*$$' -r '$$1' -I --no-heading --no-line-number | sort | uniq

‎Makefile.all

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -53,23 +53,23 @@ ALL_PKGS := \
5353
osi \
5454
oak \
5555
engine \
56-
${PLUGIN_PKGS}
56+
$(PLUGIN_PKGS)
5757
WITHOUT_PKGS :=
58-
UNSELECT_PKGS := ${WITHOUT_PKGS}
58+
UNSELECT_PKGS := $(WITHOUT_PKGS)
5959
WITH_PKGS :=
60-
SELECT_PKGS := $(call uniq, $(filter-out ${UNSELECT_PKGS}, ${ALL_PKGS}) ${WITH_PKGS})
61-
.PHONY: ${ALL_PKGS}
60+
SELECT_PKGS := $(call uniq, $(filter-out $(UNSELECT_PKGS), $(ALL_PKGS)) $(WITH_PKGS))
61+
.PHONY: $(ALL_PKGS)
6262

6363
## VENDOR PACKAGE SELECTION
6464
##
6565
## Functions analogously to normal package selection.
6666
##
6767
ALL_VENDOR := $(wildcard vendor/*)
6868
WITHOUT_VENDOR :=
69-
UNSELECT_VENDOR := ${WITHOUT_VENDOR}
69+
UNSELECT_VENDOR := $(WITHOUT_VENDOR)
7070
WITH_VENDOR :=
71-
SELECT_VENDOR := $(call uniq, $(filter-out ${UNSELECT_VENDOR}, ${ALL_VENDOR}) ${WITH_VENDOR})
72-
.PHONY: ${ALL_VENDOR}
71+
SELECT_VENDOR := $(call uniq, $(filter-out $(UNSELECT_VENDOR), $(ALL_VENDOR)) $(WITH_VENDOR))
72+
.PHONY: $(ALL_VENDOR)
7373

7474
# Specify dependencies:
7575
fable:
@@ -78,7 +78,7 @@ models: runtime
7878
osi: runtime models
7979
oak: runtime
8080
engine: models oak
81-
${PLUGIN_PKGS}: runtime models
81+
$(PLUGIN_PKGS): runtime models
8282
plugins/esmini: osi
8383

8484
vendor/esmini: vendor/open-simulation-interface
@@ -114,36 +114,36 @@ CONAN_OPTIONS :=
114114

115115
# Usage: $(call _make_target_rule, TARGET-NAME, MAKE-TARGET, HELP-DESCRIPTION, MAKE-ARGUMENTS)
116116
define _make_target_rule
117-
${1}:
118-
$(call print_header, "Proceeding to $(call unquote, ${3})")
119-
${MAKE} ${SUBMAKEFLAGS} ${4} ${2}
117+
$(1):
118+
$(call print_header, "Proceeding to $(call unquote, $(3))")
119+
$(MAKE) $(SUBMAKEFLAGS) $(4) $(2)
120120
endef
121121

122122
# Usage: $(call _make_target_rules, TARGET-NAME, HELP-DESCRIPTION, HELP-CATEGORY, PACKAGE-DIRS)
123123
define _make_target_rules
124124
help::
125-
$(call print_help_target, ${1}, ${2}, ${3})
126-
$(call _make_target_rule,${1},${1}-each,${2},-f Makefile.all)
127-
${1}-each: ${4}
125+
$(call print_help_target, $(1), $(2), $(3))
126+
$(call _make_target_rule,$(1),$(1)-each,$(2),-f Makefile.all)
127+
$(1)-each: $(4)
128128
endef
129129

130130
REGEX_TARGET := 's/(-vendor|-select)?-each//'
131-
${ALL_PKGS} ${ALL_VENDOR}:
132-
${MAKE} -C $@ $(shell echo ${MAKECMDGOALS} | sed -re ${REGEX_TARGET})
131+
$(ALL_PKGS) $(ALL_VENDOR):
132+
$(MAKE) -C $@ $(shell echo $(MAKECMDGOALS) | sed -re $(REGEX_TARGET))
133133

134134
# Usage: $(call make_vendor_target, TARGET-NAME, HELP-DESCRIPTION, HELP-CATEGORY)
135135
define make_vendor_target
136-
$(eval $(call _make_target_rules,${1},${2},${3},${SELECT_VENDOR}))
136+
$(eval $(call _make_target_rules,$(1),$(2),$(3),$(SELECT_VENDOR)))
137137
endef
138138

139139
# Usage: $(call make_every_target, TARGET-NAME, HELP-DESCRIPTION, HELP-CATEGORY)
140140
define make_every_target
141-
$(eval $(call _make_target_rules,${1},${2},${3},${ALL_PKGS}))
141+
$(eval $(call _make_target_rules,$(1),$(2),$(3),$(ALL_PKGS)))
142142
endef
143143

144144
# Usage: $(call make_select_target, TARGET-NAME, HELP-DESCRIPTION, HELP-CATEGORY)
145145
define make_select_target
146-
$(eval $(call _make_target_rules,${1},${2},${3},${SELECT_PKGS}))
146+
$(eval $(call _make_target_rules,$(1),$(2),$(3),$(SELECT_PKGS)))
147147
endef
148148

149149
# --------------------------------------------------------------------------- #
@@ -154,7 +154,7 @@ endef
154154
help::
155155
$(call print_help_section, "Available multi-package targets")
156156

157-
ifneq "${ALL_VENDOR}" ""
157+
ifneq "$(ALL_VENDOR)" ""
158158
help::
159159
$(call make_vendor_target, export-vendor, "export all vendor packages", "[conan-cache]")
160160
$(call make_vendor_target, package-vendor, "create all vendor packages", "[conan-cache]")
@@ -189,19 +189,19 @@ $(call make_select_target, clean-select, "remove build artifacts", "[in-source]"
189189
help::
190190
echo
191191
$(call print_help_subsection, "Options")
192-
ifneq "${ALL_VENDOR}" ""
193-
$(call print_help_option, WITH_VENDOR, "", "include optional vendor packages from ${_grn}UNSELECT_VENDOR${_rst}")
192+
ifneq "$(ALL_VENDOR)" ""
193+
$(call print_help_option, WITH_VENDOR, "", "include optional vendor packages from $(_grn)UNSELECT_VENDOR$(_rst)")
194194
endif
195-
$(call print_help_option, WITH_PKGS, "", "include optional packages from ${_grn}UNSELECT_PKGS${_rst}")
195+
$(call print_help_option, WITH_PKGS, "", "include optional packages from $(_grn)UNSELECT_PKGS$(_rst)")
196196
$(call print_help_option, LOCKFILE_SOURCE, "", "use specified conanfile as lockfile source for build")
197197
echo
198198
$(call print_help_subsection, "Defines")
199-
$(call print_help_option, BUILD_POLICY, ${BUILD_POLICY})
200-
$(call print_help_define, CONAN_OPTIONS, ${CONAN_OPTIONS})
201-
ifneq "${ALL_VENDOR}" ""
202-
$(call print_help_define_lines, UNSELECT_VENDOR, ${UNSELECT_VENDOR})
203-
$(call print_help_define_lines, SELECT_VENDOR, ${SELECT_VENDOR})
199+
$(call print_help_option, BUILD_POLICY, $(BUILD_POLICY))
200+
$(call print_help_define, CONAN_OPTIONS, $(CONAN_OPTIONS))
201+
ifneq "$(ALL_VENDOR)" ""
202+
$(call print_help_define_lines, UNSELECT_VENDOR, $(UNSELECT_VENDOR))
203+
$(call print_help_define_lines, SELECT_VENDOR, $(SELECT_VENDOR))
204204
endif
205-
$(call print_help_define_lines, UNSELECT_PKGS, ${UNSELECT_PKGS})
206-
$(call print_help_define_lines, SELECT_PKGS, ${SELECT_PKGS})
205+
$(call print_help_define_lines, UNSELECT_PKGS, $(UNSELECT_PKGS))
206+
$(call print_help_define_lines, SELECT_PKGS, $(SELECT_PKGS))
207207
echo

0 commit comments

Comments
 (0)