• 0 Posts
  • 4 Comments
Joined 1 year ago
cake
Cake day: June 9th, 2023

help-circle
  • To solve your DRY problem, you may not realize that you can generate target rules from built-in functions eval and foreach and a user-defined new-line macro. Think of it like a preprocessor step.

    For example:

    # This defines a new-line macro.  It must have two blank lines.
    define nl
    
    
    endef
    
    # Generate two rules for ansible playbooks:
    $(eval $(foreach v,1 2,\
    .PHONY : ansible.run-playbook$v $(nl)\
    \
    ansible.run-playbook$v : ensure-variables cleanup-residue | $$(ansible.venv)$(nl)\
    ansible.run-playbook$v :;\
    	... $(nl)\
    ))
    

    I winged it a bit for you, but hopefully I got it right, or at least right enough you get what I’m doing with this technique.


  • You may like an approach I came up with some time ago.

    In my included file that’s common among my Makefiles:

    # Ensure the macro named is set to a non-empty value.
    varchk_call = $(if $($(1)),,$(error $(1) is not set from calling environment))
    
    # Ensure all the macros named in the list are set to a non-empty value.
    varchklist_call = $(foreach v,$(1),$(call varchk_call,$v))
    

    At the top of a Makefile that I want to ensure certain variables are set before it runs:

    $(call varchklist_call,\
            INSTDIR \
            PACKAGE \
            RELEASE \
            VERSION)
    

    I usually do these checks in sub-Makefiles to ensure someone didn’t break the top level Makefile by not passing down a required macro.


  • I’ve written hundreds (thousands?) of GNU Makefiles over the past 30 years and never had a need to unconditionally run particular targets before all others. GNU Make utility is a rule-based language. I’d suggest what you’re attempting to do is enforce an imperative programming language model onto a rule-based programming language model, which you’re going to run into trouble trying to code in a different language model than the tool’s native model.

    Can you provide what you mean by check the environment, and why you’d need to do that before anything else?

    For example, in the past I’ve want to determine if and which particular command was installed, so I have near the top of my Makefile:

    container_command_defaults = podman docker
    container_command_default_paths := $(shell command -v $(container_command_defaults))
    
    ifndef container_command
      container_command = $(firstword $(container_command_default_paths))
      ifeq ($(container_command),)
        $(error You must have docker or podman installed)
      endif
    endif
    

    Using the := operator with $(shell ...) is a way to run a command while GNU Make is initially parsing your Makefile. Normally, using := assignment operator is antithetical to a rule-based language, so you want to limit its use as much as possible, but unusual exceptions can exist.

    I’m also unclear what you mean by “ensure variables are set”. What kind of variables?

    The above snippet shows how you can check if a makefile variable is set when the Makefile is first parsed, if not, declare an error and exit. (The same approach works for environment variables too.)

    Preparing a particular layout ahead of time is not the best approach. I’d suggest a given layout is nothing more than dependencies that should be declared as such.

    Also, running specific targets or rules unconditionally can lead to trouble later as your Makefile grows up. You may eventually have additional targets that say provide information about the build’s state or run checks or tests. You wouldn’t want those targets necessarily to go off and build an entire tree of directories for you or take other unnecessary actions.

    If you want to ensure certain directories are present, add those as dependencies for those targets with the | character. For example:

    build_directory ?= build
    build_make = $(MAKE) ...
    targets = ...
    
    all: FORCE | $(build_directory)
    	$(build_make) $(targets)
    
    $(build_directory):
    	mkdir -p -- '$@'
    

    Even though I’ve been writing GNU Makefiles for decades, I still am learning new stuff constantly, so if someone has better, different ways, I’m certainly up for studying them.