Updated Makefile to account for vendor/ in dist

The previous PR #890 introduced a `Defaults.mk` target for defining
default variables for future calls to `make`. This functionality was
already present in a different form, but this new "real" target had an
unintended side-effect of causing the target to be called automatically
at reference, even the optional reference `-include Defaults.mk`. This
is undesirable as it causes the generation of defaults even during a
`make clean`.

This commit resolves these issues and further refactors the Makefile,
building on the work in #890, but with additional understanding:

* Convert the `Defaults.mk` target to the "phony" `defaults` target,
  preventing automatic generation
* Refactor and split `clean` targets
* Update `cleanvendor` to reflect `OFFLINE_BUILD`, similar to the
  `vendor` target
* Move "tools" targets into `Tools.mk`
* Add `ARCH` to `Variables.mk` for architecture-specific actions

Signed-off-by: Jonathon Anderson <janderson@ciq.com>

Dockerfile

@@ -7,7 +7,9 @@ RUN zypper  -n install --no-recommends git go1.18 libgpgme-devel &&\
 COPY . /warewulf-src
 
 RUN cd /warewulf-src &&\
-  make contclean Defaults.mk \
+  make clean \
+    OFFLINE_BUILD=1 &&\
+  make defaults \
     PREFIX=/usr \
     BINDIR=/usr/bin \
     SYSCONFDIR=/etc \

Makefile

@@ -1,35 +1,8 @@
 include Variables.mk
+include Tools.mk
 
 .PHONY: all
-all: config vendor wwctl wwclient man_pages wwapid wwapic wwapird etc/defaults.conf etc/bash_completion.d/wwctl
+all: wwctl wwclient man_pages wwapid wwapic wwapird etc/defaults.conf etc/bash_completion.d/wwctl
-
-.PHONY: build
-build: lint test vet all
-
-.PHONY: setup_tools
-setup_tools: $(GO_TOOLS_BIN) $(GOLANGCI_LINT) $(PROTOC_GEN_GO) $(PROTOC_GEN_GO_GRPC)
-
-$(GO_TOOLS_BIN):	
-	GOBIN="$(PWD)/$(TOOLS_BIN)" go install -mod=vendor $(GO_TOOLS)
-
-$(GOLANGCI_LINT):
-	curl -qq -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(TOOLS_BIN) $(GOLANGCI_LINT_VERSION)
-
-$(PROTOC):
-	cd $(PWD)/$(TOOLS_DIR) && curl -LO $(PROTOC_URL) && unzip protoc-24.0-linux-$(ARCHITECTURE_CPU).zip
-
-$(PROTOC_GEN_GRPC_GATEWAY):
-	curl -L $(PROTOC_GEN_GRPC_GATEWAY_URL) -o $(PROTOC_GEN_GRPC_GATEWAY)
-	chmod +x $(PROTOC_GEN_GRPC_GATEWAY)
-
-$(PROTOC_GEN_GO):
-	GOBIN="$(PWD)/$(TOOLS_BIN)" go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28
-
-$(PROTOC_GEN_GO_GRPC):
-	GOBIN="$(PWD)/$(TOOLS_BIN)" go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2
-
-.PHONY: setup
-setup: vendor $(TOOLS_DIR) setup_tools
 
 vendor:
 ifndef OFFLINE_BUILD
@@ -37,9 +10,6 @@ ifndef OFFLINE_BUILD
 	go mod vendor
 endif
 
-$(TOOLS_DIR):
-	mkdir -p $@
-
 .PHONY: config
 config: etc/wwapic.conf \
 	etc/wwapid.conf \
@@ -48,14 +18,44 @@ config: etc/wwapic.conf \
 	internal/pkg/config/buildconfig.go \
 	warewulf.spec
 
-etc/defaults.conf: wwctl
-	./wwctl --emptyconf genconfig defaults >etc/defaults.conf
-
 %: %.in
 	sed -ne "$(foreach V,$(VARLIST),s,@$V@,$(strip $($V)),g;)p" $@.in >$@
 
+wwctl: config vendor $(call godeps,cmd/wwctl/main.go)
+	GOOS=linux go build -mod vendor -tags "$(WW_GO_BUILD_TAGS)" -o wwctl cmd/wwctl/main.go
+
+wwclient: config vendor $(call godeps,cmd/wwclient/main.go)
+	CGO_ENABLED=0 GOOS=linux go build -mod vendor -a -ldflags "-extldflags -static" -o wwclient cmd/wwclient/main.go
+
+update_configuration: config vendor $(call godeps,cmd/update_configuration/update_configuration.go)
+	go build -X 'github.com/hpcng/warewulf/internal/pkg/node.ConfigFile=./etc/nodes.conf'" \
+	    -mod vendor -tags "$(WW_GO_BUILD_TAGS)" -o update_configuration cmd/update_configuration/update_configuration.go
+
+wwapid: config vendor $(call godeps,internal/app/api/wwapid/wwapid.go)
+	go build -o ./wwapid internal/app/api/wwapid/wwapid.go
+
+wwapic: config vendor $(call godeps,internal/app/api/wwapic/wwapic.go)
+	go build -o ./wwapic  internal/app/api/wwapic/wwapic.go
+
+wwapird: config vendor $(call godeps,internal/app/api/wwapird/wwapird.go)
+	go build -o ./wwapird internal/app/api/wwapird/wwapird.go
+
+.PHONY: man_pages
+man_pages: wwctl $(wildcard docs/man/man5/*.5)
+	mkdir -p docs/man/man1
+	./wwctl --emptyconf genconfig man docs/man/man1
+	gzip --force docs/man/man1/*.1
+	gzip --force --keep docs/man/man5/*.5
+
+etc/defaults.conf: wwctl
+	./wwctl --emptyconf genconfig defaults >etc/defaults.conf
+
+etc/bash_completion.d/wwctl: wwctl
+	mkdir -p etc/bash_completion.d/
+	./wwctl --emptyconf genconfig completions >etc/bash_completion.d/wwctl
+
 .PHONY: lint
-lint: setup_tools
+lint: config $(GOLANGCI_LINT)
 	$(GOLANGCI_LINT) run --build-tags "$(WW_GO_BUILD_TAGS)" --skip-dirs internal/pkg/staticfiles ./...
 
 .PHONY: vet
@@ -123,44 +123,14 @@ install: all
 	install -m 0644 staticfiles/x86_64.efi $(DESTDIR)$(WWDATADIR)/ipxe
 	install -m 0644 staticfiles/x86_64.kpxe $(DESTDIR)$(WWDATADIR)/ipxe
 
-etc/bash_completion.d/wwctl: wwctl
-	mkdir -p etc/bash_completion.d/
-	./wwctl --emptyconf genconfig completions >etc/bash_completion.d/wwctl
-
 .PHONY: init
 init:
 	systemctl daemon-reload
 	cp -r tftpboot/* $(WWTFTPDIR)/ipxe/
 	restorecon -r $(WWTFTPDIR)
 
-wwctl: config vendor $(call godeps,cmd/wwctl/main.go)
-	GOOS=linux go build -mod vendor -tags "$(WW_GO_BUILD_TAGS)" -o wwctl cmd/wwctl/main.go
-
-wwclient: config vendor $(call godeps,cmd/wwclient/main.go)
-	CGO_ENABLED=0 GOOS=linux go build -mod vendor -a -ldflags "-extldflags -static" -o wwclient cmd/wwclient/main.go
-
-.PHONY: man_pages
-man_pages: wwctl $(wildcard docs/man/man5/*.5)
-	mkdir -p docs/man/man1
-	./wwctl --emptyconf genconfig man docs/man/man1
-	gzip --force docs/man/man1/*.1
-	gzip --force --keep docs/man/man5/*.5
-
-update_configuration: vendor $(call godeps,cmd/update_configuration/update_configuration.go)
-	go build -X 'github.com/hpcng/warewulf/internal/pkg/node.ConfigFile=./etc/nodes.conf'" \
-	    -mod vendor -tags "$(WW_GO_BUILD_TAGS)" -o update_configuration cmd/update_configuration/update_configuration.go
-
-wwapid: $(call godeps,internal/app/api/wwapid/wwapid.go)
-	go build -o ./wwapid internal/app/api/wwapid/wwapid.go
-
-wwapic: $(call godeps,internal/app/api/wwapic/wwapic.go)
-	go build -o ./wwapic  internal/app/api/wwapic/wwapic.go
-
-wwapird: $(call godeps,internal/app/api/wwapird/wwapird.go)
-	go build -o ./wwapird internal/app/api/wwapird/wwapird.go
-
 .PHONY: dist
-dist: vendor config
+dist: vendor
 	rm -rf .dist/ $(WAREWULF)-$(VERSION).tar.gz
 	mkdir -p .dist/$(WAREWULF)-$(VERSION)
 	rsync -a --exclude=".*" --exclude "*~" * .dist/$(WAREWULF)-$(VERSION)/
@@ -184,25 +154,47 @@ proto: $(PROTOC) $(PROTOC_GEN_GRPC_GATEWAY) $(PROTOC_GEN_GO) $(PROTOC_GEN_GO_GRP
 		--go-grpc_out=. \
 		routes.proto
 
-.PHONY: contclean
+.PHONY: cleanconfig
-contclean:
+cleanconfig:
-	rm -f Defaults.mk
+	rm -f etc/wwapi{c,d,rd}.conf
-	rm -f $(WAREWULF)-$(VERSION).tar.gz
-	rm -f wwapi{c,d,rd} etc/wwapi{c,d,rd}.conf
 	rm -f include/systemd/warewulfd.service
 	rm -f internal/pkg/config/buildconfig.go
-	rm -f update_configuration
 	rm -f warewulf.spec
-	rm -f wwclient
-	rm -f wwctl
-	rm -rf $(TOOLS_DIR)
-	rm -rf .dist/
 	rm -rf etc/bash_completion.d/
-	rm -rf userdocs/_*
-	rm -rf userdocs/reference/*
 	rm -rf etc/defaults.conf
+
+.PHONY: cleantest
+cleantest:
 	rm -rf *.coverprofile
 
-.PHONY: clean
+.PHONY: cleandist
-clean: contclean
+cleandist:
+	rm -f $(WAREWULF)-$(VERSION).tar.gz
+	rm -rf .dist/
+
+.PHONY: cleanmake
+cleanmake:
+	rm -f Defaults.mk
+
+.PHONY: cleanbin
+cleanbin:
+	rm -f wwapi{c,d,rd}
+	rm -f wwclient
+	rm -f wwctl
+	rm -f update_configuration
+
+.PHONY: cleandocs
+cleandocs:
+	rm -rf userdocs/_*
+	rm -rf userdocs/reference/*
+	rm -rf docs/man/man1
+	rm -rf docs/man/man5/*.gz
+
+.PHONY: cleanvendor
+cleanvendor:
+ifndef OFFLINE_BUILD
 	rm -rf vendor
+endif
+
+.PHONY: clean
+clean: cleanconfig cleantest cleandist cleantools cleanmake cleanbin cleandocs cleanvendor

Tools.mk

@@ -0,0 +1,47 @@
+TOOLS_DIR := .tools
+TOOLS_BIN := $(TOOLS_DIR)/bin
+
+GO_TOOLS_BIN := $(addprefix $(TOOLS_BIN)/, $(notdir $(GO_TOOLS)))
+GO_TOOLS_VENDOR := $(addprefix vendor/, $(GO_TOOLS))
+GOLANGCI_LINT := $(TOOLS_BIN)/golangci-lint
+GOLANGCI_LINT_VERSION := v1.53.2
+PROTOC_GEN_GO := $(TOOLS_BIN)/protoc-gen-go
+PROTOC_GEN_GO_GRPC := $(TOOLS_BIN)/protoc-gen-go-grpc
+PROTOC := $(TOOLS_BIN)/protoc
+PROTOC_GEN_GRPC_GATEWAY := $(TOOLS_BIN)/protoc-gen-grpc-gateway
+
+ifeq ($(ARCH),aarch64)
+PROTOC_URL := https://github.com/protocolbuffers/protobuf/releases/download/v24.0/protoc-24.0-linux-aarch_64.zip
+PROTOC_GEN_GRPC_GATEWAY_URL := https://github.com/grpc-ecosystem/grpc-gateway/releases/download/v2.16.2/protoc-gen-grpc-gateway-v2.16.2-linux-arm64
+else
+PROTOC_URL := https://github.com/protocolbuffers/protobuf/releases/download/v24.0/protoc-24.0-linux-x86_64.zip
+PROTOC_GEN_GRPC_GATEWAY_URL := https://github.com/grpc-ecosystem/grpc-gateway/releases/download/v2.16.2/protoc-gen-grpc-gateway-v2.16.2-linux-x86_64
+endif
+
+$(TOOLS_DIR):
+	mkdir -p $@
+
+.PHONY: tools
+tools: $(GO_TOOLS_BIN) $(GOLANGCI_LINT) $(PROTOC_GEN_GO) $(PROTOC_GEN_GO_GRPC)
+
+$(GO_TOOLS_BIN):
+	GOBIN="$(PWD)/$(TOOLS_BIN)" go install -mod=vendor $(GO_TOOLS)
+
+$(GOLANGCI_LINT):
+	curl -qq -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(TOOLS_BIN) $(GOLANGCI_LINT_VERSION)
+
+$(PROTOC):
+	cd $(PWD)/$(TOOLS_DIR) && curl -LO $(PROTOC_URL) && unzip protoc-24.0-linux-$(ARCHITECTURE_CPU).zip
+
+$(PROTOC_GEN_GRPC_GATEWAY):
+	curl -L $(PROTOC_GEN_GRPC_GATEWAY_URL) -o $(PROTOC_GEN_GRPC_GATEWAY)
+	chmod +x $(PROTOC_GEN_GRPC_GATEWAY)
+
+$(PROTOC_GEN_GO):
+	GOBIN="$(PWD)/$(TOOLS_BIN)" go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28
+
+$(PROTOC_GEN_GO_GRPC):
+	GOBIN="$(PWD)/$(TOOLS_BIN)" go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2
+
+.PHONY: cleantools
+	rm -rf $(TOOLS_DIR)

Variables.mk

@@ -4,6 +4,9 @@
 OS_REL := $(shell sed -n "s/^ID\s*=\s*['"\""]\(.*\)['"\""]/\1/p" /etc/os-release)
 OS ?= $(OS_REL)
 
+ARCH_REL := $(shell uname -p)
+ARCH ?= $(ARCH_REL)
+
 # List of variables to save and replace in files
 VARLIST := OS
 
@@ -75,25 +78,8 @@ WWDOCDIR := $(DOCDIR)/$(WAREWULF)
 WWDATADIR := $(DATADIR)/$(WAREWULF)
 WWCLIENTDIR ?= /warewulf
 
-# auto installed tooling
-TOOLS_DIR := .tools
-TOOLS_BIN := $(TOOLS_DIR)/bin
 CONFIG := $(shell pwd)
 
-# tools
-GO_TOOLS_BIN := $(addprefix $(TOOLS_BIN)/, $(notdir $(GO_TOOLS)))
-GO_TOOLS_VENDOR := $(addprefix vendor/, $(GO_TOOLS))
-GOLANGCI_LINT := $(TOOLS_BIN)/golangci-lint
-GOLANGCI_LINT_VERSION := v1.53.2
-PROTOC_GEN_GO := $(TOOLS_BIN)/protoc-gen-go
-PROTOC_GEN_GO_GRPC := $(TOOLS_BIN)/protoc-gen-go-grpc
-PROTOC := $(TOOLS_BIN)/protoc
-PROTOC_URL := https://github.com/protocolbuffers/protobuf/releases/download/v24.0/protoc-24.0-linux-x86_64.zip
-#PROTOC_URL := https://github.com/protocolbuffers/protobuf/releases/download/v24.0/protoc-24.0-linux-aarch_64.zip
-PROTOC_GEN_GRPC_GATEWAY := $(TOOLS_BIN)/protoc-gen-grpc-gateway
-PROTOC_GEN_GRPC_GATEWAY_URL := https://github.com/grpc-ecosystem/grpc-gateway/releases/download/v2.16.2/protoc-gen-grpc-gateway-v2.16.2-linux-x86_64
-#PROTOC_GEN_GRPC_GATEWAY_URL := https://github.com/grpc-ecosystem/grpc-gateway/releases/download/v2.16.2/protoc-gen-grpc-gateway-v2.16.2-linux-arm64
-
 # helper functions
 godeps=$(shell go list -deps -f '{{if not .Standard}}{{ $$dep := . }}{{range .GoFiles}}{{$$dep.Dir}}/{{.}} {{end}}{{end}}' $(1) | sed "s%${PWD}/%%g")
 
@@ -106,5 +92,6 @@ export GOPROXY
 # built tags needed for wwbuild binary
 WW_GO_BUILD_TAGS := containers_image_openpgp containers_image_ostree
 
-Defaults.mk:
+.PHONY: defaults
+defaults:
 	printf " $(foreach V,$(VARLIST),$V := $(strip $($V))\n)" >Defaults.mk

userdocs/contributing/development-environment-vagrant.rst

@@ -158,7 +158,7 @@ Vagrantfile
                 git clone https://github.com/hpcng/warewulf.git
                 cd warewulf
                 git checkout v4.4.0
-                make clean Defaults.mk \
+                make clean defaults \
                     PREFIX=/usr \
                     BINDIR=/usr/bin \
                     SYSCONFDIR=/etc \

userdocs/quickstart/el8.rst

@@ -14,7 +14,7 @@ Install Warewulf and dependencies
 
    git clone https://github.com/hpcng/warewulf.git
    cd warewulf
-   make clean Defaults.mk \
+   make clean defaults \
     PREFIX=/usr \
     BINDIR=/usr/bin \
     SYSCONFDIR=/etc \

userdocs/quickstart/el9.rst

@@ -14,7 +14,7 @@ Install Warewulf and dependencies
 
    git clone https://github.com/hpcng/warewulf.git
    cd warewulf
-   make clean Defaults.mk \
+   make clean defaults \
     PREFIX=/usr \
     BINDIR=/usr/bin \
     SYSCONFDIR=/etc \

userdocs/quickstart/suse15.rst

@@ -16,7 +16,7 @@ Install Warewulf and dependencies
 
    git clone https://github.com/hpcng/warewulf.git
    cd warewulf
-   PREFIX=/usr SYSCONFDIR=/etc TFTPDIR=/srv/tftproot LOCALSTATEDIR=/var/lib make clean Defaults.mk
+   PREFIX=/usr SYSCONFDIR=/etc TFTPDIR=/srv/tftproot LOCALSTATEDIR=/var/lib make clean defaults
    make all
    sudo make install
 

warewulf.spec.in

@@ -71,7 +71,7 @@ system for large clusters of bare metal and/or virtual systems.
 %build
 %{?with_offline:OFFLINE_BUILD=1}
 # Install to sharedstatedir by redirecting LOCALSTATEDIR
-make Defaults.mk \
+make defaults \
     PREFIX=%{_prefix} \
     BINDIR=%{_bindir} \
     SYSCONFDIR=%{_sysconfdir} \