Skip to content

Latest commit

 

History

History
144 lines (93 loc) · 3.4 KB

dict.md

File metadata and controls

144 lines (93 loc) · 3.4 KB

bmakelib.dict

Provides a dictionary (aka map) in your makefiles.

Among other usecases, a dictionary can be used to group related variables/values together.

Example 1

$(call bmakelib.dict.define,DEPLOY)
$(call bmakelib.dict.put,DEPLOY,env,prod)
$(call bmakelib.dict.put,DEPLOY,service,the-accounts-service)
$(call bmakelib.dict.put,DEPLOY,host,accounts.my-cool-product.com)
$(call bmakelib.dict.put,DEPLOY,gpg-key,992443840122)

$(call bmakelib.dict.define,BUILD)
$(call bmakelib.dict.put,BUILD,arch,x86_64)
$(call bmakelib.dict.put,BUILD,dir,/tmp/my-app/build)

some-target :
	@echo DEPLOY.env = $(call bmakelib.dict.get,DEPLOY,env)
	@echo BUILD.arch = $(call bmakelib.dict.get,BUILD,arch)

Example 2

define-config : bmakelib.dict.define( DEPLOY,env,prod )
define-config : bmakelib.dict.put( DEPLOY,env,prod )
define-config : bmakelib.dict.put( DEPLOY,service,accounts )
define-config : bmakelib.dict.put( DEPLOY,host,accounts.my-cool-product.com )
define-config : bmakelib.dict.put( DEPLOY,gpg-key,992443840122 )

deploy : define-config
deploy :
	/usr/bin/deploy \
		--env $(call bmakelib.dict.get,DEPLOY,env) \
		--server $(call bmakelib.dict.get,DEPLOY,service) \
		$(call bmakelib.dict.get,DEPLOY,host)

bmakelib.conf.dict.error-if-blank-key

Controls whether blank dict keys are accepted. Default value is yes.

If set to

  • yes, causes an $(error) to be raised and make to be aborted.
  • anything else, causes the operation to proceed. However a $(warning) message will be printed.

bmakelib.conf.dict.error-if-blank-value

Controls whether blank dict values are accepted. Default value is no.

If set to

  • yes, causes an $(error) to be raised and make to be aborted.
  • anything else, causes the operation to proceed. However a $(warning) message will be printed.

bmakelib.dict.define

Defines a dictionary.

Example 1

$(call bmakelib.dict.define,MY-DICT)

The above snippet defines a dictionary named MY-DICT which can later be used to store/retrieve items into/from.

Example 2

Makefile:

my-config-target : bmakelib.dict.define( MY-DICT )

The above snippet creates a target which has a dependency on bmakelib.dict.define, causing it to define dictionary MY-DICT when it is invoked.

bmakelib.dict.put

Stores a given value in the dictionary under a given key.

Example 1

$(call bmakelib.dict.define,MY-DICT)
$(call bmakelib.dict.put,MY-DICT,a-key,a-value)

The above, stores the value a-value with the key a-key in MY-DICT dictionary.

Example 2

my-config-target : bmakelib.dict.define( MY-DICT )
my-config-target : bmakelib.dict.put( MY-DICT,a-key,a-value )

The above snippet creates a target which has a dependency on bmakelib.dict.put(%), causing it to store the value a-value with key a-key in the MY-DICT when invoked.

bmakelib.dict.get

Retrieves the value of a given key from the dictionary.

Example 1

VAR1 = $(call bmakelib.dict.get,MY-DICT,a-key)

The above, stores the value a-value with the key a-key in MY-DICT dictionary.

Example 2

some-target :
	echo $(call bmakelib.dict.get,MY-DICT,a-key)

The above snippet creates a target which has a dependency on bmakelib.dict.put(%), causing it to store the value a-value with key a-key in the MY-DICT when invoked.